lostpaul_obsidian-folder-notes/README.md

Obsidian folder notes

Create notes within folders that can be accessed without collapsing the folder, similar to the functionality offered in Notion.

Table of contents

• Features
• Credits
• Showcase
• How to install the plugin

Features

• Notes in folders
• Click on folder name to open folder note
• 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 folder creation (can be turned on in the settings)
• Exclude folders
• Hide folder notes from file explorer

Soon

• Create folder note for every existing folder

Showcase

Open folder notes

How to install the plugin

1. Download main.js, manifest.json, styles.css from the latest release (see 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

Credits

Thank you to everyone who has created a plugin that inspired me and I took code from.

• Template suggester, created by SilentVoid13 and Liamcain (their plugins: Templater, Periodic notes)
• Apply template to note, first seen in https://github.com/mgmeyers/obsidian-kanban/ from 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