macOS
Homebrewverified · 100%
brew install github-markdown-toclocal Homebrew formula metadata
brew
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
Additional install commands
overview
Package summary
Easy TOC creation for GitHub README.md (in go)
Project links
Commands and aliases
- gh-md-toc
history
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 posture
Risk level: green
narrow executable package without higher-risk signals.
Risk classifier
green risk · low confidence · appliance
Why
- narrow executable package without higher-risk signals
Signals
- metadata:no-higher-risk-signals
Install behavior
- No Homebrew post-install hook is recorded in formula metadata.
- Homebrew bottle metadata is available for 6 platform targets.
- Build metadata lists 1 build dependencies.
Recommended review
Before unattended agent use, check whether the tool reads plaintext credentials, writes remote state, publishes artifacts, or shells out to plugins.
executables
Installed executables
| Command | Kind | Exposure | Note |
|---|---|---|---|
gh-md-toc | cli | global executable |
freshness
Version and freshness
These signals separate page generation age, package-manager activity, and upstream release comparison. Version lag is warned only when an evidence URL and comparable versions are present.
page generated2026-07-08
manager version2.0.1
manager updated
local dataok
upstreamcurrent
latest detectedv2.0.1
https://github.com/ekalinin/github-markdown-toc.go
- infoNo package-manager update timestamp was available.low confidence
install metadata
Package metadata
| Package key | brew:github-markdown-toc |
|---|---|
| Version | 2.0.1 |
| Package manager | Homebrew |
| Package manager page | https://formulae.brew.sh/formula/github-markdown-toc |
| Homepage | https://github.com/ekalinin/github-markdown-toc.go |
| Repository | https://github.com/ekalinin/github-markdown-toc.go |
| Upstream docs | https://github.com/ekalinin/github-markdown-toc.go#readme |
| License | MIT |
| Source archive | https://github.com/ekalinin/github-markdown-toc.go/archive/refs/tags/v2.0.1.tar.gz |
| Build dependencies | go |
| Bottle | available (on arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux) |
| Homebrew post-install | not defined |
| Service | none declared |
registry facts
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 | https://ghcr.io/v2/homebrew/core |
| Deprecated | no |
| Disabled | no |
| Keg Only | no |
| URL Keys |
|
source trail
Generated from repository data
This page is generated by av-web from the private package SQLite artifact built by scripts/generate-pkg-sqlite.py.
Combined YAML source
View the package source record on GitHub.
Used sources
- Geiger risk classifier
- Nucleus package database
- av.db category and tag curation
- cross-ecosystem install command graph
- curated package history
- package relationship graph
- package version freshness
- package-page enrichment