lostpaul_obsidian-folder-notes/docs/docs/Folder overview.md

Folder overview

The folder overview feature can be installed as a standalone plugin and works without the folder notes plugin by clicking on this.

This feature/plugin creates a code block that provides an overview of your entire vault or specific folders. Instructions for creating or editing a folder overview, along with additional guidance, can be found further down the page. Currently there are two styles available: file explorer & list style, with more coming soon. The overview updates itself automatically when you create, delete or modify a file. You can also integrate it into templates, as explained further down below this page.

Additionally, you can customize the overview by selecting specific file types, adjusting file depth, and changing the file order (e.g., alphabetical: A-Z).

Create overview

There are two options to create a folder overview in a note

• Use the command "Insert folder overview" from the command palette
• On desktop right click and click on the option "Create folder overview"

Edit overview

If the overview shows no files or folders yet you can just click on the button that says "Edit overview". But if there are already files/folders you can use the command "Edit folder overview" from the command palette or click on the button as showed in the video below.

Default settings

To edit the default values for new folder overviews you can either use the command "Edit folder overview" or open the plugins settings tab and then the folder overview tab to the edit the default settings.

(On the left is the plugin settings tab and the right the view you see when you use the "Edit folder overview" command)