Obsidian Stats logoObsidian Stats

EzIndex

by Juehming Shi
5
4
3
2
1
Score: 50/100
Install Code

Description

The EzIndex plugin turns a folder and its nested contents into a single index note, with Markdown headings reflecting subfolder depth and links to every included file. You can exclude files or folders by name and filter out file extensions. The index filename supports a folder name placeholder, while the output can go inside the target folder, at the vault root or in a custom folder. A settings preview shows the exact output path and whether generation will create, overwrite or skip the note. Generation is available through settings, a modal or a folder's context menu. Existing indexes can be left untouched to preserve manual edits, and generated links can show or hide Markdown extensions. Processing stays local with no network requests or telemetry.

Reviews

No reviews yet.

Stats

0
stars
448
downloads
0
forks
7
days
2
days
2
days
0
total PRs
0
open PRs
0
closed PRs
0
merged PRs
0
total issues
0
open issues
0
closed issues
20
commits

Latest Version

0.9.7
3 days ago

Changelog

EzIndex 0.9.7

Corrects the author name shown by Obsidian.

Changed

  • The plugin now reports jmedzen as its author. The manifest still carried the previous author name, which is what the Installed plugins list and the plugin detail pane display. Only this line changed.

Unchanged

  • No code changes. The production build reproduces the 0.9.6 main.js byte for byte, so generated indexes, settings, filenames and note contents are identical. Upgrading is safe without reconfiguring anything.
  • Same eleven options, same six groups, same order and wording. Minimum app version stays at 1.4.0.

Installation

Download main.js, manifest.json and styles.css into <Vault>/.obsidian/plugins/ezindex/, then enable EzIndex in Settings → Community plugins.

If the name still shows the old value after upgrading, toggle the plugin off and on, or restart Obsidian, to force the manifest to be re-read.

See all version on GitHub

README file from

Github

EzIndex - Easy Index Generator for Obsidian

GitHub Release License: MIT

EzIndex generates a structured, hierarchical table of contents for any folder in your vault, including everything nested inside it.

Point it at a folder and it walks every subfolder, producing one index note with Markdown headings per subfolder level and links to every file. Choose where the note is saved, name it with a {{folderName}} pattern, and exclude templates or attachments you don't want listed.

Everything runs locally. The plugin makes no network requests and sends no telemetry.

✨ Features

  • 🌲 Recursive Subfolder & File Indexing: Scans all subfolders and files nested inside a target directory.
  • 📑 Hierarchical Markdown Headings:
    • 1st-level subfolders: ## Subfolder (H2 Heading)
    • 2nd-level subfolders: ### Subfolder (H3 Heading)
    • 3rd-level subfolders: #### Subfolder (H4 Heading), and so on.
  • 🚫 Custom Exclude List: Easily exclude specific file names, subfolder names, or file extensions (e.g. templates, archive, .png, _Index) using a multi-line text box. Entries may be separated by commas, newlines, semicolons or the Chinese enumeration comma 、.
  • 🔍 Live Output Preview: The settings page shows the exact filename and full path that will be written, plus whether the note will be created, overwritten or skipped.
  • 🌐 English / 繁體中文 Descriptions: All labels, descriptions, the modal and notices are available in both languages. They follow the Obsidian interface language by default and can be forced to either one in settings.
  • 🎯 Multiple Convenient Ways to Trigger:
    1. Plugin Settings Page: Pick a target directory and click 🚀 Generate index right inside settings!
    2. Interactive Modal: Open via Ribbon Icon or Command Palette (EzIndex: Open Index Generator Modal...).
    3. File Explorer Context Menu: Right-click any folder in the left sidebar -> EzIndex: Generate Index for this folder.
  • 🛠️ Flexible Filename & Output Location:
    • Dynamic placeholders like {{folderName}}-Index.md.
    • Save inside the target folder, at vault root, or in a custom folder.

🚀 Quick Start & Usage

1. Generate Index via Settings Page

  1. Go to Obsidian Settings -> EzIndex.
  2. Select your Target directory.
  3. (Optional) Adjust Index location, Index filename, Index header and Exclude list.
  4. Check the Output preview section — it shows the resulting path and what will happen.
  5. Click 🚀 Generate index in the Run section at the bottom.

2. Generate Index via File Explorer

  1. Right-click any folder in the left sidebar File Explorer.
  2. Click EzIndex: Generate Index for this folder.

3. Generate Index via Modal

  1. Click the Ribbon Icon on the left sidebar (or press Cmd + P and search EzIndex).
  2. Pick the target folder and click 🚀 Generate index.

⚙️ Configuration Options

Option Description Default
Target directory Select the directory to index directly from settings Active folder / Vault Root
Index header Title heading at the top of the generated note # Directory Index
Index filename Filename pattern (supports {{folderName}}; .md is appended automatically) _Index.md
Exclude list Names or extensions to ignore, separated by commas, newlines, ; or 、 (empty)
Index location Where to save (Inside Target Folder, Vault Root, or Custom Folder) Inside Target Folder
Custom folder path Vault-relative folder, created automatically if missing (only when output location is Custom Folder) (empty)
Show file extensions Display or hide .md extension in generated links Off
Overwrite existing index Overwrite existing index note with same name; off = skip and keep manual edits On
Description language Follow Obsidian interface, English, or 繁體中文 — affects UI text only, never your notes Follow Obsidian interface

📦 Installation

Manual Installation

  1. Download main.js, manifest.json, and styles.css from the Latest Release.
  2. Create a folder named ezindex inside your vault's .obsidian/plugins/ directory: 
    <VaultFolder>/.obsidian/plugins/ezindex/
  3. Move the downloaded files into <VaultFolder>/.obsidian/plugins/ezindex/.
  4. Reload Obsidian -> Go to Settings -> Community Plugins -> Enable EzIndex.

🛠️ Development

# Install dependencies
npm install

# Build production bundle
npm run build

# Start development watcher
npm run dev

📄 License

This project is licensed under the MIT License.

Similar Plugins

info
• Similar plugins are suggested based on the common tags between the plugins.
TagFolder
5 years ago by vorotamoroz
obsidian floating toc
4 years ago by curtgrimes modified by Cuman
Automatic Table Of Contents
3 years ago by Johan Satgé
💠 An Obsidian plugin to create a table of contents in a note, that updates itself when the note changes
Create List of Notes
3 years ago by Andrew Heekin
Insta TOC
2 years ago by Nick C.
Generate, update, and maintain a table of contents for your notes while typing in real time.
Dynamic Outline
2 years ago by theopavlove
Adds a customizable GitHub-like floating table of contents to Obsidian.
Note ID
2 years ago by Dominik Mayer
Displays notes by their ID, enabling structured sequences for manuscripts or a Zettelkasten ("Folgezettel")
TOC compatible with Publish
a year ago by Brian Collery
Create a table of contents that will display in publish. Choose how you wish to style it once and then it works.
Folder Filelist
a year ago by Bill Anderson
Obsidian plugin for simple folder listing
Next TOC
9 months ago by RavenHogWarts
Floating TOC panel
Floating Headings
8 months ago by k0src
Displays a floating, collapsible outline of a note's headings on the right side of the editor. Expands on hover, click to navigate.
Advanced Exclude
4 months ago by mnaoumov
Obsidian plugin that enhances the Excluded files setting bringing gitignore syntax.
Sponsors