diff --git a/posts/Advanced topics/Accepted file formats.md b/posts/Advanced topics/Accepted file formats.md new file mode 100644 index 0000000..8508196 --- /dev/null +++ b/posts/Advanced topics/Accepted file formats.md @@ -0,0 +1,9 @@ +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. diff --git a/posts/Advanced topics/Community plugins.md b/posts/Advanced topics/Community plugins.md new file mode 100644 index 0000000..64f5bab --- /dev/null +++ b/posts/Advanced topics/Community plugins.md @@ -0,0 +1,41 @@ +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. diff --git a/posts/Advanced topics/Contributing to Obsidian.md b/posts/Advanced topics/Contributing to Obsidian.md new file mode 100644 index 0000000..978fb62 --- /dev/null +++ b/posts/Advanced topics/Contributing to Obsidian.md @@ -0,0 +1,49 @@ +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). diff --git a/posts/Advanced topics/Customizing CSS.md b/posts/Advanced topics/Customizing CSS.md new file mode 100644 index 0000000..0c16adb --- /dev/null +++ b/posts/Advanced topics/Customizing CSS.md @@ -0,0 +1,13 @@ +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) \ No newline at end of file diff --git a/posts/Advanced topics/Deleting files.md b/posts/Advanced topics/Deleting files.md new file mode 100644 index 0000000..d2accee --- /dev/null +++ b/posts/Advanced topics/Deleting files.md @@ -0,0 +1,8 @@ +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. + diff --git a/posts/Advanced topics/Drag and Drop.md b/posts/Advanced topics/Drag and Drop.md new file mode 100644 index 0000000..870036d --- /dev/null +++ b/posts/Advanced topics/Drag and Drop.md @@ -0,0 +1,29 @@ +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. diff --git a/posts/Advanced topics/HTML sanitization.md b/posts/Advanced topics/HTML sanitization.md new file mode 100644 index 0000000..ca084fc --- /dev/null +++ b/posts/Advanced topics/HTML sanitization.md @@ -0,0 +1 @@ +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 `