Skip to content

Add description, summary, and more info to folders with folder notes.

License

Notifications You must be signed in to change notification settings

aidenlx/alx-folder-note

Repository files navigation

AidenLx's Folder Note

Add description, summary and more info to folders with folder notes.

alx-folder-note is a maintained, completely rewritten, and improved folder note plugin that covers all core features of the original folder note plugin) (except folder overview), with enhanced file explorer patches and lots of QoL improvements, aiming to make the folder with note work as seamless as native files.)

Special thanks to xpgo, the author of original folder note plugin!

demo

Note:

  1. Starting from v0.13.0, Folder Overview (folderv) has become an optional component, you can go to the Folder Overview section of the setting tab to install it
  2. Starting from v0.11.0, this plugin require folder-note-core to work properly. For old user, check here for migration guide.

Intro

How to use

Check wiki for more details

Compatibility

The required API feature is only available for Obsidian v0.14.8+.

Installation

Note: Starting from v0.11.0, this plugin require folder-note-core to work properly, which is also available on community plugins list.

From Obsidian

  1. Open Settings > Third-party plugin
  2. Make sure Safe mode is off
  3. Click Browse community plugins
  4. Search for this plugin
  5. Click Install
  6. Once installed, close the community plugins window and the plugin is ready to use.

From GitHub

  1. Download the Latest Release from the Releases section of the GitHub Repository
  2. Put files to your vault's plugins folder: <vault>/.obsidian/plugins/alx-folder-note
  3. Reload Obsidian
  4. If prompted about Safe Mode, you can disable safe mode and enable the plugin. Otherwise, head to Settings, third-party plugins, make sure safe mode is off and enable the plugin from there.

Note: The .obsidian folder may be hidden. On macOS, you should be able to press Command+Shift+Dot to show the folder in Finder.