Obsidian Stats logoObsidian Stats

Auto Index

by rakushkatop
5
4
3
2
1
Score: 35/100
Install Code

Description

This plugin has not been manually reviewed by Obsidian staff. Automatically generates index notes for specified folders, listing files and subfolders recursively.

Reviews

No reviews yet.

Stats

stars
downloads
0
forks
1
days
NaN
days
NaN
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
0
commits

Latest Version

Invalid date

Changelog

See all version on GitHub

README file from

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

Sponsors