Skip to content

Displays notes by their ID, enabling structured sequences for manuscripts or a Zettelkasten ("Folgezettel")

License

Notifications You must be signed in to change notification settings

dominikmayer/obsidian-note-id

Repository files navigation

Note ID

The Obsidian Note ID Plugin displays notes by their ID, enabling structured sequences for manuscripts or a Zettelkasten ("Folgezettel").

Features

  • Note Organization by ID: Displays notes in alphanumeric order based on the id property.
  • Cluster Identification: Reveals clusters of related ideas, helping you see how your notes interconnect and where gaps or areas of high activity exist.
  • Support for Zettelkasten: Ideal for Zettelkasten practitioners looking to position new notes logically and expand existing threads of thought.
  • Easily Create New Notes: Use the context menu or a command to seamlessly create new notes that continue an existing sequence (e.g., 1.2 → 1.3) or start a subsequence branching from a note (e.g., 1.2 → 1.2a). This makes it simple to extend ideas and maintain logical connections.
  • Dedicated Table of Contents View: The table of contents view functions as a curated index, displaying top-level notes and/or notes explicitly marked with the toc property – e.g., toc: Zettelkasten for the note that starts the Zettelkasten cluster. Unlike the main note list, which shows all notes, the table of contents view provides a structured way to highlight key topics without cluttering the sidebar
  • Enhanced Note Search: Quickly search your notes using fuzzy matching by note title, note ID, or table of contents title for more efficient navigation.
  • Set Note IDs Based on Other Notes: Easily set the ID of an existing note to be in sequence or subsequence of another note, helping you reorganize and integrate notes into your clusters.

How Clusters Work

Clusters form when related notes branch off from an initial idea, creating a web of connections. For example:

1.1 Initial idea
1.1a Related thought branching from 1.1
1.1a1 And another one branching from 1.1a
1.1a1a And one branching from 1.1a1
1.1a2 This one relates to 1.1a again
1.2 A new idea in the same theme
1.2a Further exploration of 1.2

By organizing notes this way, you can:

  • Track the development of specific ideas.
  • See where your focus has been and identify underdeveloped areas.
  • Gain a bird's-eye view of your knowledge landscape.

For a more in-depth introduction check out How to Use Folgezettel in Your Zettelkasten: Everything You Need to Know to Get Started.

Benefits over Filename-Based Sequences

Some users prepend sequence numbers to file names (e.g., 1.1 Note Title), but this approach can make notes harder to manage. Notes appear cluttered, and the numbers show up in links, reducing readability. Using the id property avoids these issues, keeping filenames clean while maintaining a structured sequence in the sidebar view.

Installation

From the web

  1. Open the plugin on the Obsidian Plugin Website.
  2. Click on Install.

From within Obsidian

  1. Open Obsidian.
  2. Go to Settings > Community Plugins.
  3. Search for "Note ID".
  4. Install and enable the plugin.

Usage

  1. Press Ctrl + P or Cmd + P to open the Command palette.
  2. Execute Note ID: Open side panel and you will see a sidebar panel with all your notes. (You can change which notes to include/exclude in the plugin settings.)
  3. Add an id property to your first note (e.g., id: 1.1). (You can change the name of the property in the settings.)
  4. Use the Command palette, a configurable hotkey or the context menu in the sidebar panel to create a new note in sequence (1.11.2) or subsequence (1.11.1a).
  5. Optionally add a toc property with the title that should show up in the table of contents (e.g., toc: Productivity).

Example

This note has the title Deep work is the key to being productive:

---
id: 3.1
toc: Productivity
---

Deep work is the ability to focus without distraction on cognitively demanding tasks. It allows you to produce at an elite level and should be a core part of any knowledge worker's routine.
  • This note serves as an entry point for the Productivity cluster, so it appears in the table of contents under Productivity.
  • Related notes can reference or extend it (e.g., id: 3.1a for a note on time blocking)

Searching for Notes

You can search for notes with the command Note ID: Search notes by title, title of contents title or ID. Assign a hotkey like Cmd/Ctrl-Shift-O to easily access it.

Setting Note IDs Based on Other Notes

You can set the ID of an existing note based on another note's ID, either as a sequence or a subsequence. This is useful for reorganizing your notes or integrating new ideas into existing clusters.

To set the ID of the current note:

  1. Open the note you want to assign an ID to.
  2. Use the command Note ID: Set note ID based on another note. You can assign a hotkey like Cmd/Ctrl-Shift-M (for "move").
  3. In the search modal, find and select the note you want to base the ID on.
  4. Press Enter to set the ID as a subsequence of the selected note (e.g., if the selected note is "1.1", the current note will become "1.1a").
  5. Press Cmd+Enter (or Ctrl+Enter) to set the ID as a sequence following the selected note (e.g., if the selected note is "1.1", the current note will become "1.2").

This feature allows you to quickly integrate notes into your existing structure without manually calculating the next ID.

Settings

The plugin allows you to

  • change the name of id and toc properties,
  • select the folders with notes to include or exclude,
  • decide whether notes without ID should be shown,
  • choose whether the table of contents should automatically include notes based on hierarchy level, or only show manually selected entries,
  • indent notes depending on the "hierarchy" level of their ID, and
  • configure the visual separation between notes.

Feedback and Contributions

Feedback and contributions are welcome! Visit GitHub to report issues, ask questions, or submit pull requests.

Other Plugins

  • Reader Mode ensures that notes are opened in reader mode, so you can see dialogs rendered right away.
  • Yesterday lets you create and edit a Yesterday journal in Obsidian.

About

Displays notes by their ID, enabling structured sequences for manuscripts or a Zettelkasten ("Folgezettel")

Resources

License

Stars

Watchers

Forks

Packages

No packages published