README file from
GithubAuto Navigator Pages
Auto Navigator Pages automatically creates and maintains folder navigator pages and Home.md for folder-based Obsidian vault organization. It is useful when you organize notes by folders and want each folder to have a managed overview page linking to child folders and direct notes.
Features
- Create and maintain same-name navigator pages for folders.
- Create and maintain
Home.mdfor top-level folders and notes. - Automatically use Chinese or English UI text based on the current Obsidian language.
- Require explicit initialization before modifying navigator pages.
- Back up existing same-name notes during first initialization.
- Preserve user-editable content outside the generated navigator section.
- Support custom navigator page templates with the required
{{navigator}}placeholder. - Hide empty child-folder or note sections.
- Use real-path links with aliases for child folder navigator pages.
- Sort underscore-prefixed files and folders last in the file explorer.
- Optionally pin navigator pages to the top of their folder in the file explorer.
- Optionally route new empty notes created from ordinary wiki links into a
_nodesubfolder. - Support exclude rules for folders, folder names, file names, and extensions.
- Save and restore the previous workspace layout.
- Clean orphan managed navigator pages.
Installation
From the Obsidian community plugin browser
- Open Obsidian settings.
- Go to
Community plugins. - Search for
Auto Navigator Pages. - Install and enable the plugin.
Manual installation
- Download
main.jsandmanifest.jsonfrom the latest GitHub release. - Create this folder inside your vault:
VaultFolder/.obsidian/plugins/auto-navigator-pages/
- Copy
main.jsandmanifest.jsoninto that folder. - Restart Obsidian or reload plugins.
- Enable
Auto Navigator PagesinCommunity plugins.
Usage
- Enable the plugin.
- Open the plugin settings.
- Click
Initialize current vaultto initialize the current vault. - The plugin scans your vault and creates managed navigator pages for folders.
- After initialization, creating, deleting, or renaming notes and folders updates the affected navigator pages automatically.
You can also run the initialization command from the command palette.
Navigator Page Template
The default template contains a user-editable description area and a generated navigator area:
## Description
Write folder notes, project background, or useful links here. The plugin will not edit this section.
{{navigator}}
The {{navigator}} placeholder is required. The plugin replaces it with the generated navigator section.
About _node
The _node folder collects lower-level notes created from ordinary notes through wiki links. This keeps frequently used first-level project notes visible in the working folder, while detailed sub-notes can live in _node.
The plugin does not move notes into _node when they are created from:
- The file explorer.
- A managed navigator page.
- A note that already has content.
- Any workflow before the plugin is initialized.
Support
If this plugin helps you, you can support its maintenance:
Repository
GitHub: https://github.com/ccccarlos0504/auto_navigator_pages
Notes
- File explorer pinning and sorting use internal Obsidian file explorer interfaces. Some Obsidian versions may require compatibility updates.
- Workspace snapshots only restore the tabs and layout from the previous session.
- Before submitting a new community plugin release, make sure
README.md,manifest.json, the GitHub release assets, and the version number are consistent.