Skip to content

An Obsidian plugin that creates a curated list of important tags to serve as meaningful entry points to your knowledge base.

License

Notifications You must be signed in to change notification settings

wenlzhang/obsidian-tag-index

Repository files navigation

Tag Index

GitHub release (Latest by date) GitHub all releases

An Obsidian plugin that creates a curated list of important tags to serve as meaningful entry points to your knowledge base.

demo

Features

Tag Index solves the problem of tag overload by giving you a dedicated space for your most important tags:

Core Features

  • Curated Tag Collection: Create a personalized list of your most important tags separate from Obsidian's default tag pane
  • Hierarchical Tag Support: Full support for nested tags with automatic tree structure (e.g., #project/dev/feature)
  • Multiple Addition Methods: Add tags from the editor context menu, default tag pane, or command palette
  • Visual Organization: Rearrange tags via intuitive drag and drop in custom sort mode
  • Quick Note Access: Click any tag to instantly see all notes using that tag
  • Dual Sorting System: Independent sorting for tags and notes
    • Tag Sorting: Sort tags by custom order, frequency, name, or added time
    • Note Sorting: Sort notes under each tag by file name, modified time, or created time

Line Content Display

  • See Where Tags Appear: View the actual line content where each tag exists in your notes
  • Clickable Navigation: Click any line content to jump directly to that location in your note

Interactive Navigation

  • Jump to Line: Click line content to open the file at the exact line
  • Jump and Search: Optionally open the search pane to see all tag occurrences across your vault
  • Configurable Cursor: Choose whether the cursor lands at the start or end of the line
  • Hover Preview: Hover over note names to preview their content without opening them

Performance & Customization

  • Configurable Refresh Delay: Set refresh delays from instant to 60 minutes based on vault size
  • Customizable Behavior: Choose whether new tags are added to the top or bottom of your list
  • Persistent Settings: All sort preferences are saved and restored across sessions

Videos and Articles

Videos

New Obsidian Plugin: Avoid tag pane chaos, create a curated list of important tags

Articles

Why Tag Index?

The default Obsidian tag pane can quickly become overwhelming for several reasons:

  1. Tag Overload: As your vault grows, so does your tag list, creating visual chaos and making it difficult to find important tags
  2. External Syncing: When syncing notes from external tools, unnecessary tags can clutter your tag pane
  3. No Prioritization: The default tag pane treats all tags equally, with no way to highlight your most important ones
  4. Limited Entry Points: Methods like the Zettelkasten (slip-box) require clear entry points to your knowledge system, which a cluttered tag pane can't provide
  5. Inefficient Navigation: While you can click tags in the default pane to search for them, this workflow isn't optimized for frequent access

Tag Index solves these problems by giving you a dedicated space for the tags that matter most to you, with improved organization and navigation features.

Getting Started

Adding Tags

You can add tags to your index in multiple ways:

  1. From the Editor: Right-click on any tag in your notes → "Add to tag index"
  2. From Tag Pane: Right-click on any tag in Obsidian's default tag pane → "Add to tag index"
  3. Via Command: Use the command palette (Ctrl/Cmd+P) → "Tag Index: Add to tag index"

Sorting Tags

Organize your tag list with multiple sorting options:

  1. Quick sort: Click the left sort button (list icon) in the tag panel header
  2. Choose from 7 sorting methods:
    • Custom order: Drag and drop tags to arrange them manually (default)
    • Frequency (high to low): Most frequently used tags appear first
    • Frequency (low to high): Least frequently used tags appear first
    • Tag name (A to Z): Alphabetical order ascending
    • Tag name (Z to A): Alphabetical order descending
    • Added time (new to old): Most recently added tags first
    • Added time (old to new): Oldest tags first
  3. Set default: Configure your preferred default in Settings → Tag Index → "Default tag sort method"
  4. Drag and drop: Only available in "Custom order" mode. Other modes will display a notice if you attempt to drag.

Sorting Notes

Change how notes are sorted under each tag:

  1. Quick sort: Click the right sort button (arrow icon) in the tag panel header
  2. Choose from 6 sorting options:
    • File name (A to Z / Z to A): Alphabetical order with natural number sorting
    • Modified time (new to old / old to new): Sort by last modification date
    • Created time (new to old / old to new): Sort by file creation date
  3. Set default: Configure your preferred default in Settings → Tag Index → "Default note sort method"

💡 Note: Tag sorting and note sorting are independent. You can sort tags by frequency while sorting notes by name, for example.

Using Line Content Display

The plugin can show you exactly where tags appear in your files:

  1. Enable "Show line content" in settings
  2. Click on any tag to expand it
  3. See all files containing that tag
  4. View the actual lines where the tag appears
  5. Click any line to jump directly to that location

Configuring Behavior

Access settings via Settings → Tag Index:

General Settings

  • Add new tags to top: Control where new tags appear in your list
  • Auto-open tag index panel: Automatically open the panel when Obsidian starts

Line Content Display

  • Show line content: Toggle the line content display feature
  • Line content click behavior: Choose between "Jump to line" or "Jump to line and search"
  • Cursor position: Set cursor position when jumping (start or end of line)
  • Refresh delay: Configure auto-refresh timing (0-60 minutes) based on your vault size

Sorting Options

  • Default tag sort method: Choose how tags in the index are sorted (custom order, frequency, name, or added time)
    • Custom order allows drag-and-drop rearrangement
    • Other methods automatically organize tags
  • Default note sort method: Choose how notes under each tag are sorted (file name, modified time, or created time)
    • Can be changed on-the-fly using the sort buttons in the panel header

Advanced

  • Debug mode: Enable console logging for troubleshooting

Documentation

📚 View Full Documentation

Visit the documentation site to learn how to make the most of Tag Index in your Obsidian workflow.

Support & Community

This plugin is developed and maintained during my free time. A lot of thought, energy, and care goes into making it reliable and user-friendly.

If you find Tag Index valuable in your daily workflow:

  • If it helps you organize your tags more effectively
  • If it saves you time and mental energy navigating your knowledge base
  • If it provides a better entry point to your notes

Please consider supporting my work. Your support would help me dedicate more time and energy to:

  • Developing new features
  • Maintaining code quality
  • Providing support and documentation
  • Making the plugin even better for everyone

Ways to Support

You can support this project in several ways:

  • ⭐ Star the project on GitHub
  • 💝 Buy Me a Coffee at ko-fi.com
  • 💌 Share your success stories and feedback
  • 📢 Spread the word about the plugin
  • 🐛 Report issues to help improve the plugin

Thank you for being part of this journey! 🙏

About

An Obsidian plugin that creates a curated list of important tags to serve as meaningful entry points to your knowledge base.

Resources

License

Stars

Watchers

Forks

Sponsor this project

  •  

Packages

No packages published