GitHub Wiki TOC Generator

An Obsidian community plugin that automatically generates a Table of Contents for GitHub wiki-style vaults. It writes a structured, wikilink-based TOC to one or more configurable target files (e.g. _Sidebar.md).

Features

• Generates a TOC from the vault's file and folder structure
• Folder notes (files named exactly after their parent folder) are rendered as bold wikilinks
• Regular files are listed as bullet-point wikilinks
• Configurable heading depth — optionally include H1, H2, H3, … from each file
• Gitignore-style exclusion patterns (e.g. /images, *.draft.md, private/)
• Supports multiple TOC target files (e.g. separate sidebars for different sub-wikis)
• GitHub Wiki URL injection — automatically writes a wiki_url frontmatter property to every note so you can share the live GitHub Wiki link with colleagues
• URLs stay current: updated automatically whenever a file is renamed or created, and on every manual TOC run
• Trigger manually via the command palette or the ribbon icon

Installation

From Community Plugins (once published)

1. Open Obsidian → Settings → Community plugins → Browse
2. Search for GitHub Wiki TOC Generator
3. Click Install, then Enable

Manual Installation

1. Download main.js, manifest.json, and styles.css from the latest release
2. Copy them into your vault at .obsidian/plugins/github-wiki-toc/
3. Reload Obsidian and enable the plugin under Settings → Community plugins

Configuration

Open Settings → GitHub Wiki TOC Generator.

TOC Target Files

Vault-relative paths to the files the TOC should be written into, one per line.

_Sidebar.md
docs/_Sidebar.md

If a target file is inside a subfolder (e.g. docs/_Sidebar.md), the TOC only covers that subfolder and its descendants downward.

Heading Depth

Controls whether file headings are included in the TOC.

Value	Effect
(blank)	No headings included
#	Include H1 headings only
##	Include H1 and H2 headings
###	Include H1, H2, and H3 headings

Ignore Folder Notes

When enabled, files whose name matches their parent folder (folder notes) are excluded from the TOC. The folder still appears as a plain bold entry without a wikilink.

Ignore Patterns

Gitignore-style patterns for excluding files and folders. One pattern per line. Lines starting with # are comments.

Pattern	Effect
/images	Exclude the top-level images folder only
images/	Exclude any folder named images at any depth
*.draft.md	Exclude all files matching this glob
private/	Exclude any folder named private
!important.md	Un-ignore a specific file (negation)

GitHub Wiki URLs

When enabled, the plugin writes a wiki_url property to the YAML frontmatter of every note (except TOC files and ignored files):

---
wiki_url: https://github.com/owner/repo/wiki/My-Page-Name
---

The URL is derived from the Wiki base URL you set (e.g. https://github.com/owner/repo/wiki) plus the note's filename, with spaces replaced by hyphens — exactly how GitHub Wiki constructs its page URLs.

URLs are kept current automatically:

• On rename or new file — the affected note is updated immediately
• On manual TOC run — all notes are updated in bulk

Usage

Once the plugin is enabled and configured:

1. Open the command palette (Ctrl/Cmd + P) and run "Generate Table of Contents"
2. Or click the list icon in the left ribbon

The configured target file(s) will be created or overwritten with the generated TOC.

TOC Output Format

Given this vault structure:

_Sidebar.md          ← TOC target (always excluded from TOC)
Home.md
API.md               ← sibling folder note for API/
API/
  Authentication.md
  Endpoints.md
Setup/               ← no folder note exists
  Installation.md
  Configuration.md
images/              ← excluded via /images pattern

The generated _Sidebar.md (with heading depth ##) looks like:

- [[Home]]
**[[API]]**
  - [[Authentication]]
    - Overview
    - Token types
  - [[Endpoints]]
**Setup**
  - [[Installation]]
  - [[Configuration]]

Folder note rules:

1. If a .md file exists at the same level as a folder with the same basename (e.g. API.md next to API/), it becomes the folder's note — rendered as **[[API]]** and removed from the flat file list.
2. If no sibling note exists, the plugin checks inside the folder for a file with the same name (e.g. API/API.md).
3. If neither exists, the folder name is rendered as plain bold text with no link.

License

MIT © 2026 Pitt Biebach