obsidian-plugin/lostpaul_obsidian-folder-notes
1
0
Fork 0
mirror of https://github.com/lostpaul/obsidian-folder-notes.git synced 2026-07-22 07:40:24 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge branch 'main' of https://github.com/LostPaul/obsidian-folder-notes

Browse source
This commit is contained in:
Lost Paul 2023-03-23 10:31:11 +01:00
commit 745462849d
1 changed files with 19 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

24
README.md
View file

@ -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
<img width="585" alt="Obsidian_QaY1e3nCzL" src="https://user-images.githubusercontent.com/70213368/227159411-5a2b0a99-f612-42f2-bc57-4f0a7f97d65e.png">
<img width="582" alt="Obsidian_w4hTprcOjW" src="https://user-images.githubusercontent.com/70213368/227159064-e116ea0c-c249-4750-9b0f-b010e4a6afc5.png">
## 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