# Install github-markdown-toc with Homebrew Easy TOC creation for GitHub README.md (in go). Version 2.0.1 via Homebrew; verified from local package data. ## Install ```sh sudo av install brew:github-markdown-toc ``` Additional install commands: ### macOS - Homebrew (100%): ```sh brew install github-markdown-toc ``` Evidence: local Homebrew formula metadata ## Package facts - **Package key:** brew:github-markdown-toc - **Package manager:** Homebrew - **Package manager page:** - **Version:** 2.0.1 - **Source summary:** Easy TOC creation for GitHub README.md (in go) - **Homepage:** - **Repository:** - **Upstream docs:** - **License:** MIT - **Source archive:** - **Generated:** 2026-07-08T07:18:31+00:00 ## Executables - gh-md-toc (cli) - gh-md-toc (alias) ## Build dependencies - go ## Install behavior - Post-install hook: not defined - Bottle: available on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux ## Freshness - Page generated: 2026-07-08 - Package-manager version: 2.0.1 - Local data: ok - Upstream repository: https://github.com/ekalinin/github-markdown-toc.go - Upstream latest detected: v2.0.1 (current) - info: No package-manager update timestamp was available. ## Project history and usage github-markdown-toc is the Go implementation of ekalinin's GitHub README table-of-contents generator. It produces GitHub-style Markdown links for headings in local files, remote GitHub files, multiple documents, or standard input. ### Project history The Go repository began in July 2015 as a compiled alternative to the original shell-oriented github-markdown-toc tool. Its README highlights the reasons for the Go rewrite: no curl, wget, awk, or similar runtime dependencies; cross-platform binaries; regular-expression parsing; and processing multiple documents. The release history moved quickly through 0.x tags in 2015 and 2016, reached 1.0.0 in 2018, and later added a 2.x line in 2025. The README documents installation through prebuilt release archives, Go install, source builds, and Homebrew under the gh-md-toc executable. ### Adoption history The tool fits a common GitHub documentation practice: long README files often include a manually pasted table of contents, but GitHub's generated heading anchors can be fussy to reproduce by hand. github-markdown-toc packages that convention into a repeatable CLI for maintainers. ### How it is used Practitioners pipe Markdown to gh-md-toc, point it at local README files, or give it GitHub URLs. Options control serial processing, heading depth, indentation, escaping, GitHub tokens, and GitHub Enterprise Server endpoints. The generated output is usually copied into the source README, making the tool part of documentation maintenance rather than a runtime dependency of the documented project. ### Why package nerds care For package-manager users, the appeal is a single static-feeling command that replaces shell pipelines and browser guessing with a reproducible GitHub-compatible TOC generator. It is small, narrow, and easy to install for documentation chores. ### Timeline - 2015: Initial Go implementation commit appears. - 2015: 0.1.0 and early 0.x tags establish the gh-md-toc command. - 2018: 1.0.0 is tagged. - 2025: v2.0.0 starts the 2.x release line. - 2026: v2.0.1 appears in the release stream. ### Related projects - github-markdown-toc.go is related to the original github-markdown-toc project, GitHub-flavored Markdown, GitHub Enterprise Server, and README maintenance workflows. ### Sources - - - ## Security Notes narrow executable package without higher-risk signals. - **Geiger risk:** green / low - narrow executable package without higher-risk signals ## Source Database Details - **Source Database:** Homebrew formula API - **Tap:** homebrew/core - **Full Name:** github-markdown-toc - **Version Scheme:** 0 - **Revision:** 0 - **Bottle Stable Root URL:** - **Deprecated:** no - **Disabled:** no - **Keg Only:** no - **URL Keys:** stable ## Related links - [Source-control packages](https://www.automicvault.com/pkg/source-control-tools/) - Belongs to a source-control command family. - [Terminal utility packages](https://www.automicvault.com/pkg/terminal-utilities/) - Matched terminal and command-line workflow metadata. - [Text processing packages](https://www.automicvault.com/pkg/text-processing-tools/) - Matched text, document, or structured-data processing metadata. - [Developer build packages](https://www.automicvault.com/pkg/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata. - [go](https://www.automicvault.com/pkg/brew/go/) - Build dependency declared by Homebrew. - [grip](https://www.automicvault.com/pkg/brew/grip/) - Shares av.db curated category or tags: cli, developer-tools, documentation, github, markdown. - [mandown](https://www.automicvault.com/pkg/brew/mandown/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [mmark](https://www.automicvault.com/pkg/brew/mmark/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [action-docs](https://www.automicvault.com/pkg/brew/action-docs/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [docfx](https://www.automicvault.com/pkg/brew/docfx/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [docmd](https://www.automicvault.com/pkg/brew/docmd/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [go-md2man](https://www.automicvault.com/pkg/brew/go-md2man/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. - [gtree](https://www.automicvault.com/pkg/brew/gtree/) - Shares av.db curated category or tags: cli, developer-tools, documentation, markdown. ## Combined YAML source View the package source record on GitHub. [combined/github-markdown-toc.yml](https://github.com/automic-vault/db/blob/main/combined/github-markdown-toc.yml) ## Sources - Nucleus package database - Geiger risk classifier - package-page enrichment - curated package history - package version freshness - av.db category and tag curation - package relationship graph - cross-ecosystem install command graph