diff --git a/docs/docs/Getting started.md b/docs/docs/Getting started.md index 1ea992a..a8bd695 100644 --- a/docs/docs/Getting started.md +++ b/docs/docs/Getting started.md @@ -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" + +![Context menu](./assets/VyBTGhA5eJAVVFusZXIz.png) + +The folder overview with the default settings looks like this with one note + +![Folder overview](./assets/u6ccTTzVbwzBivySFacZ.png) + +To edit the folder overview click on the little icon on the right that is shown when hovering over the codeblock + +![Folder overview settings](./assets/2wzCXFTpD2.gif) + +### 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. + +![Context menu](./assets/TOtiFIYzUI8rwxjCLhyN.png) + +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. + +![Command palette](./assets/FKhiQZLm4Juu4VdFTxPC.png) \ No newline at end of file diff --git a/docs/docs/assets/2wzCXFTpD2.gif b/docs/docs/assets/2wzCXFTpD2.gif new file mode 100644 index 0000000..ec9fc5b Binary files /dev/null and b/docs/docs/assets/2wzCXFTpD2.gif differ diff --git a/docs/docs/assets/FKhiQZLm4Juu4VdFTxPC.png b/docs/docs/assets/FKhiQZLm4Juu4VdFTxPC.png new file mode 100644 index 0000000..ba08683 Binary files /dev/null and b/docs/docs/assets/FKhiQZLm4Juu4VdFTxPC.png differ diff --git a/docs/docs/assets/TOtiFIYzUI8rwxjCLhyN.png b/docs/docs/assets/TOtiFIYzUI8rwxjCLhyN.png new file mode 100644 index 0000000..5621c6c Binary files /dev/null and b/docs/docs/assets/TOtiFIYzUI8rwxjCLhyN.png differ diff --git a/docs/docs/assets/VyBTGhA5eJAVVFusZXIz.png b/docs/docs/assets/VyBTGhA5eJAVVFusZXIz.png new file mode 100644 index 0000000..1d78528 Binary files /dev/null and b/docs/docs/assets/VyBTGhA5eJAVVFusZXIz.png differ diff --git a/docs/docs/assets/u6ccTTzVbwzBivySFacZ.png b/docs/docs/assets/u6ccTTzVbwzBivySFacZ.png new file mode 100644 index 0000000..819bdb5 Binary files /dev/null and b/docs/docs/assets/u6ccTTzVbwzBivySFacZ.png differ diff --git a/docs/docs/index.md b/docs/docs/index.md index fd3c4dd..2a4ff5c 100644 --- a/docs/docs/index.md +++ b/docs/docs/index.md @@ -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 + +Buy Me a Coffee at ko-fi.com \ No newline at end of file