ToC Generator

pending

by Luca-Pascal Junge

A simple plugin to insert a dynamic code block based table of contents into your notes.

★ 2 starsUpdated 2mo agoMITDiscovered via Obsidian Unofficial Plugins
View on GitHub

ToC Generator for Obsidian

A simple Obsidian plugin that generates a dynamic Table of Contents for your notes.

The plugin uses a code block approach. This means the table of contents stays automatically updated as you write, rename, or reorder your headings.

Table of Contents

Preview

https://github.com/user-attachments/assets/58662563-1c98-4256-b13b-f9b8e305ba46

Features

  • Dynamic Updates: The ToC updates automatically in Reading Mode and Live Preview. No manual refreshing needed.
  • Configurable Levels: Choose exactly which heading levels (H1–H6) to display via settings.
  • Context Menu Integration: - Insert ToC at your cursor position.
    • Right-click a file in the explorer to prepend a ToC to the very top of the note.
  • Command Palette: Quickly insert via Ctrl/Cmd + P.

Usage

Method 1: Manual Code Block

Simply type the following code block anywhere in your note:

```toc
```

Method 2: Command Palette

  1. Open the Command Palette (Ctrl/Cmd + P).
  2. Search for ToC Generator.
  3. Press Enter to insert the block at your cursor.

Method 3: File Menu / Context Menu

  • Inside a note: Click the 3-dots menu (top right) -> Insert dynamic toc.
  • File Explorer: Right-click any Markdown file -> Insert dynamic toc. This will add the toc to the very beginning of the file.

Settings

Go to Settings > ToC Generator to customize your experience. You can toggle visibility for each heading level (H1 through H6) individually.

Installation

  1. Download the main.js and manifest.json from the latest release
  2. Create a folder named toc-generator in your vault's .obsidian/plugins/ directory.
  3. Paste the files into that folder.
  4. Reload Obsidian and enable the plugin in Community Plugins.

License

See LICENSE.

© lpj.app. Licensed under MIT.

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.