delete advanced topics from posts
This commit is contained in:
parent
8c270717ce
commit
cdc5d925dc
@ -1,9 +0,0 @@
|
||||
Obsidian recognizes the following file formats right now:
|
||||
|
||||
1. Markdown files: `md`;
|
||||
2. Image files: `png`, `jpg`, `jpeg`, `gif`, `bmp`, `svg`;
|
||||
3. Audio files: `mp3`, `webm`, `wav`, `m4a`, `ogg`, `3gp`, `flac`;
|
||||
4. Video files: `mp4`, `webm`, `ogv`;
|
||||
5. PDF files: `pdf`.
|
||||
|
||||
All these types of files can be [[Embed files|embedded]] in a note.
|
||||
@ -1,41 +0,0 @@
|
||||
Obsidian allows developers to write community plugins to extend Obsidian's functionality.
|
||||
|
||||
Right now, the plugin API is in alpha status. This means any part of the API could introduce breaking changes in a future release.
|
||||
|
||||
### For developers
|
||||
|
||||
For instructions on creating new plugins, see [our sample plugin](https://github.com/obsidianmd/obsidian-sample-plugin).
|
||||
|
||||
For documentation on the API, check out [our plugin API repo](https://github.com/obsidianmd/obsidian-api).
|
||||
|
||||
After you created your plugin, you can add it to our community plugin marketplace by creating a pull request in [our releases repo](https://github.com/obsidianmd/obsidian-releases). Refer to the sample plugin on how to release updates for your plugin.
|
||||
|
||||
### For users
|
||||
|
||||
#### Safe Mode
|
||||
|
||||
By default, Obsidian has Safe Mode turned on to protect you from potential harm. Under Safe Mode, no community plugin will run.
|
||||
|
||||
Please be aware that community plugins can access files on your computer, connect to the internet, and even install additional programs. To read more about plugin security, [[#Plugin security|see here]].
|
||||
|
||||
In order to install community plugins, you need to turn off Safe Mode in Settings -> Community plugin -> Safe Mode.
|
||||
|
||||
#### Discover and install community plugins
|
||||
|
||||
After disabling Safe Mode, you can find community plugins created by the community in Settings -> Community plugin -> Community plugins -> Browse.
|
||||
|
||||
On this page, you can browse plugins by popularity, or search for specific plugins. Click on a plugin to see details and instruction from the plugin author. In the details page, you can click "Install" to install a plugin.
|
||||
|
||||
After installing, you can then find the installed plugins under Settings -> Community plugin. They need to be enabled in order to take effect. You can also uninstall them there.
|
||||
|
||||
### Plugin security
|
||||
|
||||
Thanks for trusting Obsidian with your data! It means a lot to us, and we take security very seriously. That includes community plugins too.
|
||||
|
||||
Due to technical reasons with our platform, we're unable to restrict plugins to a specific permission or access level. Since we offer Obsidian for free, currently we're unable to manually review each plugin.
|
||||
|
||||
The good news is that Obsidian has an amazing and passionate community, so we rely on community trust to ensure security of community plugins.
|
||||
|
||||
In general, you should be able to trust most of the popular plugins from the community. We require all community community plugins to be open sourced on GitHub. **If you're working with sensitive data, we recommend you to inspect the plugin code before installing it, so that your security needs are met.** You can find a link to the plugin repository on the plugin detail page.
|
||||
|
||||
If you find any security flaws with community plugins, contact the plugin author by adding an issue on GitHub. If you believe the plugin is malicious, contact us to get the plugin investigated and removed.
|
||||
@ -1,49 +0,0 @@
|
||||
Thanks for the interest in contributing to Obsidian!
|
||||
|
||||
There are three major ways you can contribute:
|
||||
|
||||
### 1. Financial contribution
|
||||
|
||||
#### Commercial license
|
||||
|
||||
If you'd like to use Obsidian for work activities, try to let your work get you a [[Commercial license|commercial license]].
|
||||
|
||||
#### Add-on services
|
||||
|
||||
If you'd like to make a website from your notes, consider getting [[Obsidian Publish]] if the price works for you.
|
||||
|
||||
If you're interested in an end-to-end encryption syncing solution, we also offer [[Obsidian Sync]]. In addition to end-to-end encryption, Obsidian Sync also comes with version history.
|
||||
|
||||
#### Catalyst
|
||||
|
||||
If you don't need any of the above, you can get a [[Catalyst license]] to support our developer, which also gives you access to [[Insider builds]].
|
||||
|
||||
#### Obsidian Unlimited
|
||||
|
||||
For those very passionate about the project, there's also the Obsidian Unlimited option, which lets you pay as much as you want to support development and help us stay independent. We recommend going for this option after you've purchased the VIP tier of [[Catalyst license]] so that you can enjoy the benefits.
|
||||
|
||||
### 2. Extending Obsidian
|
||||
|
||||
#### CSS themes
|
||||
|
||||
If you're proficient in CSS, another way is to contribute a theme, so that people who don't know CSS can enjoy your work. If you decide to do so, feel free to share it on the #css-themes channel on Discord, or in the Share & Showcase category on our forum.
|
||||
|
||||
If you'd like to add your theme to the community theme list, let us know! (Or we might reach out to you first!)
|
||||
|
||||
#### Plugins
|
||||
|
||||
If you're a JavaScript/TypeScript programmer, you can write [[Community plugins]] for Obsidian, now that our plugin API is in alpha.
|
||||
|
||||
### 3. Translation and proofreading
|
||||
|
||||
#### Translating the interface
|
||||
|
||||
If you know another language (preferably natively), you can help with translating the Obsidian interface into your language. You can do that by submitting a pull request in [our translation GitHub repository](https://github.com/obsidianmd/obsidian-translations) to get it into the next version of the app.
|
||||
|
||||
#### Translating the docs
|
||||
|
||||
We're in the middle of reorganizing and stabilizing the documentation you're reading right now. Once it's in a good shape, you can also help translate it, so that people who don't know English can also easily learn to use Obsidian.
|
||||
|
||||
#### Found a typo?
|
||||
|
||||
If you found a typo or a grammar mistake in these documentation, feel free to submit a pull request in [our documentation repository](https://github.com/obsidianmd/obsidian-docs).
|
||||
@ -1,13 +0,0 @@
|
||||
If you are building or modifying your own css, you can open the developer tools by using `Ctrl+Shift+I` on Windows/Linux or `Cmd+Opt+I` on macOS to get information on the elements you want to customize.
|
||||
|
||||
Changes to themes and snippets will be detected automatically and reapplied. You do not need to restart the app.
|
||||
|
||||
### New to CSS
|
||||
|
||||
If you're new to CSS, our community has put together a quick guide to get comfortable with CSS:
|
||||
|
||||
> [Getting Comfortable with CSS](https://forum.obsidian.md/t/getting-comfortable-with-obsidian-css/133)
|
||||
|
||||
Klaas also put together a helpful index of common CSS snippets that you can feel free to mix and match:
|
||||
|
||||
> [Obsidian CSS Snippets (on GitHub)](https://github.com/Dmitriy-Shulha/obsidian-css-snippets/tree/master/Snippets)
|
||||
@ -1,8 +0,0 @@
|
||||
Obsidian has several options for dealing with deleted files, depending on your needs.
|
||||
|
||||
- By default, deleted files are sent to your system trash. Here you can use whatever means your system has for recovering files you've accidentally deleted.
|
||||
- Deleted files can be sent to a special `.trash` directory in your Vault. This can be useful if you want the ability to recover your Vault files separate from your system trash.
|
||||
- You can also set obsidian to just delete files without possibility of recovery.
|
||||
|
||||
These options can be found in Settings → Files & Links.
|
||||
|
||||
@ -1,29 +0,0 @@
|
||||
There are many ways to drag and drop things around Obsidian to make the experience smoother:
|
||||
|
||||
### Drag panes
|
||||
|
||||
See [[Working with multiple notes#5 Panes can be rearranged by dragging|dragging panes]]
|
||||
|
||||
### Drag sources
|
||||
|
||||
- You can drag a file, or multiple files from the [[file explorer]].
|
||||
- You can drag a file from a [[search]] result.
|
||||
- You can drag a file from [[backlinks]] or unlinked references.
|
||||
- You can drag a file from the [[starred notes]].
|
||||
- You can drag a file from a link inside the note, in preview mode.
|
||||
|
||||
### Drop destinations
|
||||
|
||||
- You can drop a file on a pane header to open the file there. Hold `Alt` (or `Shift` on MacOS) to drop anywhere on the pane.
|
||||
- You can drop a file on a folder in the [[file explorer]] to move the file there.
|
||||
- You can drop a file into an editor to insert it as a link. The generated link also follows your preferences, such as relative paths, or using markdown links.
|
||||
- You can drop a file on the [[starred notes]] to star it.
|
||||
|
||||
### Dragging from outside Obsidian
|
||||
|
||||
- You can drag any HTML content from the browser into Obsidian to automatically convert them into Markdown
|
||||
- You can drag and drop any files from your native file explorer to have Obsidian import (make a copy of) those files in your vault's attachment folder and insert them as internal links. Hold `Ctrl` to create `file:///` absolute links to those files instead of importing a copy.
|
||||
|
||||
### Dropping files outside Obsidian
|
||||
|
||||
- This will create an `obsidian://` URL in the external application for the Obsidian note that you dragged.
|
||||
@ -1 +0,0 @@
|
||||
Obsidian sanitizes html for security reasons. Because it runs locally, scripting vulnerabilities are a more serious problem than they would be in a web applications. Accordingly, we are probably a bit more strict than you may be used to, and you may run into issues if you try to do things like embedding `<script>` tags in a note. However, the vast majority of people will never encounter issues with this.
|
||||
@ -1,26 +0,0 @@
|
||||
We believe [[Obsidian#How we're different|your data is always yours to own and control]]. Your notes are stored in markdown, which is an open format based on plain text files, and so should be readable in the future by any computer that can deal with text files. You can freely edit notes in other software, even while having them open in Obsidian.
|
||||
|
||||
### Per vault data
|
||||
|
||||
There is, however, some data that is needed by the software that is not stored in markdown. Obsidian creates a directory called `.obsidian` in the root of any vault you create. This contains your configuration, including custom hotkeys and which plugins are enabled. Any directory starting with a `.` is invisible on most systems, so you will probably never see it unless you try. If you delete this directory, none of your data will be gone, but you will lose your custom settings. It will be recreated when you open that vault in Obsidian again. If you are using `git`, it's probably best to `ignore` the `.obsidian/workspace` file, because the this file stores your panes and opened files, but we haven't observed any other issues with including it.
|
||||
|
||||
### System directory
|
||||
|
||||
Obsidian also stores some information in the system directory. This is different per Operating System; on Mac it's `/Users/yourusername/Library/Application Support/obsidian`, on Windows `%APPDATA%\Obsidian\`, and `$XDG_CONFIG_HOME/Obsidian/` or `~/.config/Obsidian/` on Linux. As a result, we recommend against creating a vault in this directory.
|
||||
|
||||
Aside from that, though, you can create a Vault anywhere your operating system will allow. Obsidian files sync fine with Dropbox, iCloud, OneDrive, git, and every other syncing service we've tried thus far.
|
||||
|
||||
### Symbolic Links
|
||||
|
||||
Starting in v0.11.1, Obsidian will recognize symbolic links and junctions. We do not officially recommend using these, but we recognize there are valid use-cases for them. Use them at your own risk.
|
||||
|
||||
Beware that there are many pitfalls to using symbolic links, and some of them could have serious consequences such as data-loss, file corruption, or could crash Obsidian.
|
||||
|
||||
Below are some limitations or issues we are aware of that you may want to keep in mind:
|
||||
|
||||
- Symlink loops are disallowed, to prevent crashing Obsidian due to an infinite loop.
|
||||
- Symlink targets must be fully disjoint from the vault root or any other symlink targets. Disjoint means one folder does not contain another, or vice versa. Obsidian will ignore any symlink to a parent folder of the vault, or from one folder in the vault to another folder in the same vault. It is a safeguard to ensure you don't end up with duplicated files in your vault, which could cause links to become ambiguous.
|
||||
- Symlinks may not play well with Obsidian sync, or _any other kind of sync_. If the target of a symlink is itself a directory that's synced by a different Obsidian vault, you could (potentially) end up with sync conflicts or data loss. Some sync tools (e.g. git) do not follow symlinks, but rather synchronize the _path_ the symlink points to, which may produce undesirable results if you share your vault with other people that way.
|
||||
- Obsidian's file manager cannot move files across device boundaries, so if you symlink to a folder on a different drive from your vault, you will not be able to drag files between that folder and other folders using Obsidian's file explorer. (You'll need to use your OS's explorer for such moves, and Obsidian will see the move as a deletion and the creation of a new file. It will also _not_ update any links that depended on the path of that file.)
|
||||
- File symlinks (as opposed to folder symlinks) _may_ work, but are not officially supported at this time. Changes performed outside of Obsidian are not watched for, so if you change the file directly, Obsidian will not detect the change, update search indexes, etc.
|
||||
- Symlinking things under the `.obsidian/` directory in order to share them between vaults **has a high chance of corrupting your settings**, unless you _really really_ know what you're doing. If you decide to go this way, at least have backups.
|
||||
@ -1,13 +0,0 @@
|
||||
Insider builds are experimental versions of Obsidian that are released to Catalyst license owners, on an opt-in basis.
|
||||
|
||||
Please note that insider builds are less stable than public versions, so if you prefer a smoother version, you don't have to enable it.
|
||||
|
||||
### How to enable insider build
|
||||
|
||||
If you are a [[Catalyst license|Catalyst supporter]], you have access to Insider Builds before the general public. To access these, go to Settings => Account, and log in with the password you used on the Obsidian site. Then go to Settings => About, and turn on Insider Builds there.
|
||||
|
||||
![[Insider.png]]
|
||||
|
||||
### Report issues
|
||||
|
||||
If you're on our Discord server, you can go to the #insider-build channel to report issues. If you're filing a bug report on the forum, be sure to note the version you're using, so that we can improve it before rolling it out to everyone.
|
||||
@ -1,126 +0,0 @@
|
||||
Obsidian supports a custom URI protocol `obsidian://` which can be used to trigger various actions within the app. This is commonly used on MacOS and mobile apps for automation and cross-app workflows.
|
||||
|
||||
If you have Obsidian installed, this link will open the app on your device: [Click here](obsidian://open)
|
||||
|
||||
## Installing Obsidian URI
|
||||
|
||||
To make sure your operating system redirect `obsidian://` URIs to the Obsidian app, there may be additional steps you need to perform.
|
||||
|
||||
- On Windows, running the app once should be sufficient. This will register for the `obsidian://` custom protocol handler in the Windows registry.
|
||||
- On MacOS, running the app once should be sufficient, however, your app **must** be installer version 0.8.12 or later.
|
||||
- On Linux, there's a much more involved process:
|
||||
- First, ensure you create a `obsidian.desktop` file. [See here for details](https://developer.gnome.org/integration-guide/stable/desktop-files.html.en)
|
||||
- Ensure that your desktop file specifies the `Exec` field as `Exec=executable %u`. The `%u` is used to pass the `obsidian://` URIs to the app.
|
||||
- If you're using the AppImage installer, you may have to unpack it using `Obsidian-x.y.z.AppImage --appimage-extract`. Then make sure the `Exec` directive points to the unpacked executable.
|
||||
|
||||
## Using Obsidian URIs
|
||||
|
||||
Obsidian URIs are typically in this format:
|
||||
|
||||
```
|
||||
obsidian://action?param1=value¶m2=value
|
||||
```
|
||||
|
||||
- The `action` is usually the action that you would like to perform.
|
||||
|
||||
### Encoding
|
||||
|
||||
==Important==
|
||||
|
||||
Ensure that your values are properly URI encoded. For example, forward slash characters `/` must be encoded as `%2F` and space characters must be encoded as `%20`.
|
||||
|
||||
This is especially important because an improperly encoded "reserved" character may break the interpretation of the URI. [See here for details](https://en.wikipedia.org/wiki/Percent-encoding)
|
||||
|
||||
### Available actions
|
||||
|
||||
#### Action `open`
|
||||
|
||||
Description: Opens an Obsidian vault, and possibly open a file within that vault.
|
||||
|
||||
Possible parameters:
|
||||
|
||||
- `vault` can be either the vault name, or the vault ID.
|
||||
- The vault name is simply the name of the vault folder.
|
||||
- The vault ID is the random 16-character code assigned to the vault. This ID is unique per folder on your computer. Example: `ef6ca3e3b524d22f`. There isn't an easy way to find this ID yet, one will be offered at a later date in the vault switcher. Currently it can be found in `%appdata%/obsidian/obsidian.json` for Windows. For MacOS, replace `%appdata%` with `~/Library/Application Support/`. For Linux, replace `%appdata%` with `~/.config/`.
|
||||
- `file` can be either a file name, or a path from the vault root to the specified file.
|
||||
- To resolve the target file, Obsidian uses the same link resolution system as a regular `[[wikilink]]` within the vault.
|
||||
- If the file extension is `md`, the extension can be omitted.
|
||||
- `path` an absolute file system path to a file.
|
||||
- Using this parameter will override both `vault` and `file`.
|
||||
- This will cause the app to search for the most specific vault which contains the specified file path.
|
||||
- Then the rest of the path replaces the `file` parameter.
|
||||
|
||||
Examples:
|
||||
|
||||
- `obsidian://open?vault=my%20vault`
|
||||
This opens the vault `my vault`. If the vault is already open, focus on the window.
|
||||
|
||||
- `obsidian://open?vault=ef6ca3e3b524d22f`
|
||||
This opens the vault identified by the ID `ef6ca3e3b524d22f`.
|
||||
|
||||
- `obsidian://open?vault=my%20vault&file=my%20note`
|
||||
This opens the note `my note` in the vault `my vault`, assuming `my note` exists and the file is `my note.md`.
|
||||
|
||||
- `obsidian://open?vault=my%20vault&file=my%20note.md`
|
||||
This also opens the note `my note` in the vault `my vault`.
|
||||
|
||||
- `obsidian://open?vault=my%20vault&file=path%2Fto%2Fmy%20note`
|
||||
This opens the note located at `path/to/my note` in the vault `my vault`.
|
||||
|
||||
- `obsidian://open?path=%2Fhome%2Fuser%2Fmy%20vault%2Fpath%2Fto%2Fmy%20note`
|
||||
This will look for any vault that contains the path `/home/user/my vault/path/to/my note`. Then, the rest of the path is passed to the `file` parameter. For example, if a vault exists at `/home/user/my vault`, then this would be equivalent to `file` parameter set to `path/to/my note`.
|
||||
|
||||
- `obsidian://open?path=D%3A%5CDocuments%5CMy%20vault%5CMy%20note`
|
||||
This will look for any vault that contains the path `D:\Documents\My vault\My note`. Then, the rest of the path is passed to the `file` parameter. For example, if a vault exists at `D:\Documents\My vault`, then this would be equivalent to `file` parameter set to `My note`.
|
||||
|
||||
#### Action `search`
|
||||
|
||||
Description: Opens the search pane for a vault, and optionally perform a search query.
|
||||
|
||||
Possible parameters:
|
||||
|
||||
- `vault` can be either the vault name, or the vault ID. Same as action `open`.
|
||||
- `query` (optional) The search query to perform.
|
||||
|
||||
Examples:
|
||||
|
||||
- `obsidian://search?vault=my%20vault`
|
||||
This opens the vault `my vault`, and opens the search pane.
|
||||
|
||||
- `obsidian://search?vault=my%20vault&query=MOC`
|
||||
This opens the vault `my vault`, opens the search pane, and performs a search for `MOC`.
|
||||
|
||||
#### Action `new`
|
||||
|
||||
Description: Creates a new note in the vault, optionally with some content.
|
||||
|
||||
Possible parameters:
|
||||
|
||||
- `vault` can be either the vault name, or the vault ID. Same as action `open`.
|
||||
- `name` the file name to be created. If this is specified, the file location will be chosen based on your "Default location for new notes" preferences.
|
||||
- `file` a vault absolute path, including the name. Will override `name` if specified.
|
||||
- `path` a globally absolute path. Works similar to the `path` option in the `open` action, which will override both `vault` and `file`.
|
||||
- `content` (optional) the contents of the note.
|
||||
- `silent` (optional) set this if you don't want to open the new note.
|
||||
|
||||
Examples:
|
||||
|
||||
- `obsidian://new?vault=my%20vault&name=my%20note`
|
||||
This opens the vault `my vault`, and creates a new note called `my note`.
|
||||
- `obsidian://new?vault=my%20vault&path=path%2Fto%2Fmy%20note`
|
||||
This opens the vault `my vault`, and creates a new note at `path/to/my note`.
|
||||
|
||||
#### Action `hook-get-address`
|
||||
|
||||
Description: Endpoint for use with [Hook](https://hookproductivity.com/). Copies a markdown link of the current focused note to the clipboard, as an `obsidian://open` URL. Use: `obsidian://hook-get-address`
|
||||
|
||||
Possible parameters:
|
||||
|
||||
- `vault` (optional) can be either the vault name, or the vault ID. If not provided, the current or last focused vault will be used.
|
||||
|
||||
## Shorthand formats
|
||||
|
||||
In addition to the formats above, there are two more "shorthand" formats available to open vaults and files:
|
||||
|
||||
- `obsidian://vault/my vault/my note` is equivalent to `obsidian://open?vault=my%20vault&file=my%20note`
|
||||
- `obsidian:///absolute/path/to/my note` is equivalent to `obsidian://open?path=%2Fabsolute%2Fpath%2Fto%2Fmy%20note`
|
||||
@ -1,31 +0,0 @@
|
||||
---
|
||||
aliases: front matter
|
||||
---
|
||||
|
||||
YAML, also known as front matter, is designed to be file-level metadata that is readable by humans *and* Obsidian.
|
||||
|
||||
Front matter is a section of plain text attributes that starts at the first line of the file. It is one of the most popular ways to add metadata in a Markdown file, and has been popularized by static generators such as Jekyll, Hugo, and Gatsby.
|
||||
|
||||
A YAML block needs **triple dashes** at the start and end to be read by Obsidian (and other apps). ==It also needs to be placed at the very top of the file.==
|
||||
|
||||
For example:
|
||||
|
||||
```
|
||||
---
|
||||
key: value
|
||||
key2: value2
|
||||
key3: [one, two, three]
|
||||
key4:
|
||||
- four
|
||||
- five
|
||||
- six
|
||||
---
|
||||
```
|
||||
|
||||
As of 0.12.12, there are four keys natively supported:
|
||||
- `tags` ([[Working with tags|more information]])
|
||||
- `aliases` ([[Add aliases to note|more information]])
|
||||
- `cssclass`
|
||||
- `publish`([[Publish#YAML support for Publish|more information]])
|
||||
|
||||
As Obsidian continues to develop, we will gradually make it more accessible by plugin developers, and make it more user friendly.
|
||||
Loading…
Reference in New Issue
Block a user