Auto Index

pending

by RakushkaTOP

Automatically generates index notes for specified folders, listing files and subfolders recursively.

โ˜… 3 starsUpdated 3mo agoMITDiscovered via Obsidian Unofficial Plugins
View on GitHub

Auto Index Plugin for Obsidian

Buy Me A Coffee

This plugin automatically generates and maintains index notes for specified folders, listing files and subfolders recursively. It essentially brings the functionality of an "auto-index" script directly into Obsidian as a native plugin.

๐ŸŽฏ Features

  • Recursive Indexing: Automatically scans watched folders and builds a tree structure of content.
  • Auto-Updates: Updates index files automatically at a configured interval (default: 3 seconds).
  • Smart Formatting:
    • Lists subfolders with customizable emojis and bold text.

โš™๏ธ Settings

You can configure the following in Settings > Auto Index:

  • Watched Folders: A list of folder paths to monitor (one per line).
    • Example: 
      Inbox
Archive
Projects
Resources/Books
  • Update Interval: How often (in seconds) the plugin checks for changes.
  • Folder Emoji: Emoji or text to display before folder names (e.g., ๐Ÿ“‚).
  • Bold Folder Names: Toggle to display folder names in bold.

๐Ÿ“ฆ Installation

Manual Installation

  1. Download the latest release from the GitHub Releases page (main.js, manifest.json, styles.css).
  2. Create a folder named obsidian-auto-index inside your vault's plugin directory: .obsidian/plugins/obsidian-auto-index/.
  3. Move the downloaded files into that folder.
  4. Reload Obsidian (or click "Reload plugins" in Settings).
  5. Enable "Auto Index" in Settings > Community plugins.

๏ฟฝ License

MIT License

For plugin developers

Search results and similarity scores are powered by semantic analysis of your plugin's README. If your plugin isn't appearing for searches you'd expect, try updating your README to clearly describe your plugin's purpose, features, and use cases.