mirror of
https://github.com/lostpaul/obsidian-folder-notes.git
synced 2026-07-22 07:40:24 +00:00
Get started docs site
This commit is contained in:
parent
ef4906427b
commit
562e1fde5b
7 changed files with 52 additions and 0 deletions
|
|
@ -1,2 +1,38 @@
|
|||
# Getting started
|
||||
|
||||
## How to install the plugin
|
||||
|
||||
The plugin can be downloaded by clicking on https://obsidian.md/plugins?id=folder-notes and then on install.
|
||||
|
||||
|
||||
## Basic features
|
||||
|
||||
### Create folder overview
|
||||
|
||||
Find more out about the folder overview feature on the [folder overview page](./Features/Folder%20overview.md)
|
||||
|
||||
To create a folder overview in a note either use the command "Insert folder overview" or right click on pc and select "create folder overview"
|
||||
|
||||

|
||||
|
||||
The folder overview with the default settings looks like this with one note
|
||||
|
||||

|
||||
|
||||
To edit the folder overview click on the little icon on the right that is shown when hovering over the codeblock
|
||||
|
||||

|
||||
|
||||
### Create & open folder note
|
||||
|
||||
There are three options: the context menu, ctrl/strg + click and commands
|
||||
|
||||
Right click or on mobile hold longer on a folder name to get to the context menu and then click on create folder note.
|
||||
|
||||

|
||||
|
||||
On PC either use ctrl or strg (depending on your settings) and then click on a folder name to create a folder note.
|
||||
|
||||
Open the [command palette](https://help.obsidian.md/Plugins/Command+palette) and then type "folder notes" and select the command you need.
|
||||
|
||||

|
||||
BIN
docs/docs/assets/2wzCXFTpD2.gif
Normal file
BIN
docs/docs/assets/2wzCXFTpD2.gif
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 69 KiB |
BIN
docs/docs/assets/FKhiQZLm4Juu4VdFTxPC.png
Normal file
BIN
docs/docs/assets/FKhiQZLm4Juu4VdFTxPC.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 170 KiB |
BIN
docs/docs/assets/TOtiFIYzUI8rwxjCLhyN.png
Normal file
BIN
docs/docs/assets/TOtiFIYzUI8rwxjCLhyN.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 105 KiB |
BIN
docs/docs/assets/VyBTGhA5eJAVVFusZXIz.png
Normal file
BIN
docs/docs/assets/VyBTGhA5eJAVVFusZXIz.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 178 KiB |
BIN
docs/docs/assets/u6ccTTzVbwzBivySFacZ.png
Normal file
BIN
docs/docs/assets/u6ccTTzVbwzBivySFacZ.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 7.1 KiB |
|
|
@ -13,3 +13,19 @@ This plugin has some unique features that separate it from similar "Folder note"
|
|||
- Stop collapsing of folders (with folder notes) in the file explorer
|
||||
- Only open folder note through the folder name and the rest collapses the folder
|
||||
- Front matter title plugin support
|
||||
|
||||
## Get started
|
||||
|
||||
Read the [Getting started page](Getting%20started.md) for further details.
|
||||
|
||||
## Credits
|
||||
Thank you to everyone who has created a plugin that inspired me and I took code from.
|
||||
- Template suggester, created by [SilentVoid13](https://github.com/SilentVoid13) and [Liamcain](https://github.com/liamcain) (their plugins: [Templater](https://github.com/SilentVoid13/Templater/), [Periodic notes](https://github.com/liamcain/obsidian-periodic-notes))
|
||||
- Apply template to note, first seen in https://github.com/mgmeyers/obsidian-kanban/ from [Mgmeyers](https://github.com/mgmeyers)
|
||||
- Folder underline, inspired from https://github.com/aidenlx/alx-folder-note
|
||||
- Stop folders from collapsing, the basic idea from https://github.com/alangrainger/obsidian-folder-notes and some code lines
|
||||
- The basic idea is from https://github.com/xpgo/obsidian-folder-note-plugin
|
||||
|
||||
## Support the development of the plugin
|
||||
|
||||
<a href='https://ko-fi.com/D1D1GHGSI' target='_blank'><img height='36' style='border:0px;height:36px;' src='https://storage.ko-fi.com/cdn/kofi2.png?v=3' border='0' alt='Buy Me a Coffee at ko-fi.com' /></a>
|
||||
Loading…
Reference in a new issue