diff --git a/README.md b/README.md index 2c18bc8..034e6de 100644 --- a/README.md +++ b/README.md @@ -5,6 +5,7 @@ Create notes within folders that can be accessed without collapsing the folder, - [Features](#features) - [Credits](#credits) +- [How to install the plugin](#how-to-install-the-plugin) ## Features @@ -13,12 +14,25 @@ Create notes within folders that can be accessed without collapsing the folder, - Folders don't collapse (can be changed in the settings) - Templater and templates support - The name of folders that contain folder notes are underlined (can get toggled in the settings) -- Automatically create folder notes in folder on creation (can be turned on in the settings) +- Automatically create folder notes in folder on folder creation (can be turned on in the settings) - Exclude folders -- Hide folder note from file explorer +- Hide folder notes from file explorer +#### Soon +- Create folder note for every existing folder + +## How to install the plugin + +1. Download main.js, manifest.json, styles.css from the latest release (see [releases](https://github.com/LostPaul/obsidian-folder-notes/releases/)) +2. Create a new folder in `Vault-name/.obsidian/plugins` and put the downloaded files in there +3. Reload your plugins and enable the plugin +Obsidian_QaY1e3nCzL +Obsidian_w4hTprcOjW + ## 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: https://github.com/SilentVoid13/Templater/, https://github.com/liamcain/obsidian-periodic-notes) -- Apply template to note -- Folder underline +- 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