github-markdown-toc
« Back to VersTracker
Description:
Easy TOC creation for GitHub README.md (in go)
Type: Formula  |  Tracked Since: Dec 28, 2025
Links: Homepage  |  formulae.brew.sh
Category: Developer tools
Tags: markdown documentation github cli golang toc
Install: brew install github-markdown-toc
About:
GithubMarkdownToc is a command-line tool written in Go that automatically generates a Table of Contents (TOC) for Markdown files. It parses headings and creates a nested list of links, making large documents easier to navigate. This streamlines documentation workflows by ensuring READMEs and technical guides remain organized and user-friendly.
Key Features:
  • Automatic TOC generation from Markdown headers
  • GitHub-compatible link formatting
  • Written in Go for fast performance and single binary deployment
  • Supports standard Markdown heading syntax
Use Cases:
  • Generating TOCs for GitHub README.md files
  • Automating documentation builds in CI/CD pipelines
  • Improving navigation in large technical wikis or blog posts
Alternatives:
  • doctoc – Node.js-based alternative; requires a JavaScript runtime environment.
  • markdown-toc – Similar Node.js tool; Go version offers better portability and performance.
Version History
Detected Version Rev Change Commit
Oct 9, 2025 5:06pm 0 VERSION_BUMP 6650a9f5
Sep 12, 2025 6:39am 0 VERSION_BUMP 7ec55338