npm

@aidenlx/folder-note
TypeScript icon, indicating that this package has built-in type declarations

0.10.0 • Public • Published

AidenLx's Folder Note

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

(Special thanks to xpgo for the obsidian-folder-note-plugin)

demo

More to come:

How to use

Check wiki for more details

API

run npm i -D @aidenlx/folder-note and add type.d.ts with following content to the src folder of your plugin:

import FolderNoteAPI from "@aidenlx/folder-note";
declare module "obsidian" {
  interface App {
    plugins: {
      plugins: {
        [id: string]: any;
        ["alx-folder-note"]?: {
          api: FolderNoteAPI;
        };
      };
    };
  }
}

Compatibility

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

Installation

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.

From Obsidian

Not yet available

  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.

Readme

Keywords

none

Package Sidebar

Install

npm i @aidenlx/folder-note

Weekly Downloads

2

Version

0.10.0

License

MIT

Unpacked Size

8.99 kB

Total Files

4

Last publish

Collaborators

  • aidenlx