Add settings documentation and update index page

Added new documentation pages for File Explorer, General, and Path settings under Features/Settings, including a related screenshot. Updated the index.md to improve feature descriptions and clarify plugin capabilities.
This commit is contained in:
Lost Paul 2025-06-21 12:48:07 +02:00
parent caa3688c8c
commit d1ee82fe1d
5 changed files with 79 additions and 18 deletions

View file

@ -0,0 +1,32 @@
# File explorer settings
### Hide folder note
Hide files in the file explorer which are linked to folders
### Disable click-to-open folder note on mobile
Disable the option to open folder notes by tapping on the folder name of a folder with a folder note in the file explorer. With that option enabled it's only possible to open folder notes with the command palette oder the context menu.
### Open folder notes by only clicking directly on the folder name
With this option enabled you can only open a folder note by clicking when doing so exactly on the folder name and not on the whitespace around it. When you also have "Disable folder collapsing" enabled folders also won't collapse when you click on a folder name.
### Disable folder collapsing
Stop folders with folder notes from collapsing when click directly on the folder name or on the whitespace around it. Except when you click on the collapse icon you can still collapse folders.
### Use submenus
When this option is enabled and you use the context menu for folder/files at first you can only see "Folder Note Commands" in the menu and you have to hover over it to see all options.
## Style settings
### Highlight folder in the file explorer
Normally only the file gets highlighted in the explorer but when you enable this option the folder of a folder note gets also highlighted.
### Hide collapse icon
Hide the collapse icon next to a folder name for a folder with a folder note or also for every folder with no files.
### Underline the name of folder note
Underline the names of folders with folder notes in the file explorer.
### Bold the name of folder notes
Bold folders in the file explorer that have a folder note.
### Cursive the name of folder notes
Make folder with folder notes in the file explorer cursive.

View file

@ -0,0 +1,5 @@
# General settings
### Folder note name template
The entered text is going to be the name of all folder notes and when file name matches this text it becomes a folder note. {{folder_name}} is a placeholder for the name of the folder linked to the file. If you change the text every existing folder note which matched the old text won't be a folder note anymore and you have to use the button "Rename existing folder notes" to rename all folder notes.
This page will be finished soon.

View file

@ -0,0 +1,22 @@
# Path settings
The "path" is the file path above a note in the editor.
![Screenshot](../../assets/screenshots/Obsidian_LaoyRX8jr2.png)
### Open folder note through path
Open a folder note by click on a folder name in the path when it has a folder note linked to it.
### Open sidebar when opening a folder note through path
Disable/enable if the left sidebar should also open when you open a folder note through the path.
### Auto update folder name in the path ([front matter title plugin only](https://github.com/snezhig/obsidian-front-matter-title))
Automatically update the folder name in the path when the front matter title plugin is enabled and the title for a folder note is changed in the front matter. This will not change the file name, only the displayed name in the path.
## Style settings
### Underline folder in the path
Underline every folder with a folder note in the path.
### Bold folders in the path
Bold every folder with a folder note in the path.
### Cursive folders in the path
Make every folder with a folder note in the path cursive.

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

View file

@ -1,30 +1,32 @@
# Overview
Folder notes is a plugin for the note taking app [Obsidian](https://obsidian.md/) that lets you attach notes to folders so that you can click on the name of a folder to open the note like in the app [Notion](https://www.notion.so/).
This plugin has some unique features that separate it from similar "Folder note" plugins like opening folder notes through the path, creating folder notes for every existing folder, templater/template support and more.
## Features
- Open folder notes through the file explorer/path by clicking on folder names
- Only open folder notes through alt or ctrl + mouse click
- Excalidraw, Canvas, ... folder notes unlimited file type folder notes
- Sync folder note name with the folder name
- Automatically create folder notes when creating folders
- Turn every folder into a folder note
- Folder overview code block with default settings in settings from the plugin
- Hide folder notes in the file explorer
- Underline, bold and cursive folder names in the file explorer/path option
- 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
- Exclude folders with regex, path and a pattern with \*
Folder Notes is a plugin for the note-taking app [Obsidian](https://obsidian.md/) that allows you to attach notes directly to folders. This lets you open a note by clicking on a folder name—similar to the functionality found in [Notion](https://www.notion.so/).
Unlike other “folder note” plugins, Folder Notes offers several unique features, including support for custom file types, templating, and advanced folder handling options.
## Get started
Read the [Getting started page](Getting%20started.md) for further details.
Read the [Getting started page](Getting%20started.md) for further details and the pages under the "Features" category explain every feature in detail.
## Features
- Open folder notes by clicking folder names in the file explorer or path
- Optional modifier key (Alt or Ctrl + click) to open folder notes
- Full support for any file type as folder notes (e.g., Excalidraw, Canvas, etc.)
- Automatically sync folder note names with their folder names
- Auto-create a folder note when a new folder is created
- Convert all existing folders into folder notes
- Use a folder-overview code block with configurable default settings
- Option to hide folder notes from the file explorer
- Style folder names (underline, bold, italic) in the file explorer or path
- Prevent automatic collapsing of folders that have folder notes
- Choose to only open the folder note when clicking the folder name; other clicks collapse the folder
- Front matter title plugin support
- Exclude specific folders using regex, path, or wildcard patterns (`*`)
## 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/](https://github.com/mgmeyers/obsidian-kanban/) from [Mgmeyers](https://github.com/mgmeyers)
- Folder underline, inspired from [https://github.com/aidenlx/alx-folder-note](https://github.com/aidenlx/alx-folder-note)
- Stop folders from collapsing, the basic idea from [https://github.com/alangrainger/obsidian-folder-notes](https://github.com/alangrainger/obsidian-folder-notes) and some code lines
- Stop folders from collapsing, the basic idea from [https://github.com/alangrainger/obsidian-folder-notes](https://github.com/alangrainger/obsidian-folder-notes)
- The basic idea is from [https://github.com/xpgo/obsidian-folder-note-plugin](https://github.com/xpgo/obsidian-folder-note-plugin)
## Support the development of the plugin