Important

This is a patched version of the Obsidian plugin aidenlx/alx-folder-note It is compatible with Obsidian 1.5.4 (and newer). The fix addresses the problem reported under: aidenlx#134

The source of the problem are breaking changes introduced in Obsidian 1.5.4 in File Explorer. They basically renamed the internal field FileExplorerView.fileExplorer to .view thus impacting the (backward) compatibility with this plugin.

My plugin SebastianMC/obsidian-custom-sort was also affected. I invested my time to track back via reverse engineering that breaking change. In result I was able to apply relevant fix to my plugin. This forked repo of aidenlx/alx-folder-note applies exactly the same fix.

If you want to install the patched version there are two basic options:

• install from this (forked) repository via Obsidian BRAT plugin, or
• download this repository and build it by yourself:
  • command: npm install
  • command: npm run build
  • then copy the build/main.js to your vault folder, overriding the main.js of the original plugin

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!

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

• create folder note easily, with mulitple preferences and template support

• folder and folder note working as one

  • click on folder in file explorer to open folder note
  • folder and linked note synced as one: change folder name from folder note; folder note moves with your folder
  • folder note hidden from file explorer
  • reveal linked folder in file explorer
    
  • delete folder within folder note

• create folder overview with codeblock folderv (Optional)

  • view all files within folder with brief cards
  • specify title and description in frontmatter (with customizable field name)
  • fetch title from h1 if title not specified
  • filter files with regex/glob
  • sort files by name/create time/last modified time

• folder focus mode: right-click on folder in file explorer and select Toggle Focus can dim other folders and files outside of selected folder, select option again to revert

  • you can also long press with mouse on the folder name in file explorer to toggle folder focus (disabled by default, desktop only)

• folder icon in file explorer More to come:

• folderv: show children specified in dataview/frontmatter fields (works with relation-resolver plugin)

• folderv: list view

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.