# Install github-markdown-toc with Homebrew

Easy TOC creation for GitHub README.md (in go). Version 2.0.1 via Homebrew; verified 2026-07-29.

## 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
- **Version:** 2.0.1
- **Source summary:** Easy TOC creation for GitHub README.md (in go)
- **Homepage:** <https://github.com/ekalinin/github-markdown-toc.go>
- **Repository:** <https://github.com/ekalinin/github-markdown-toc.go>
- **Last updated:** 2026-07-29T16:05:02+02:00
- **Generated:** 2026-08-03T19:37:03+00:00

## Executables

- gh-md-toc (alias)

## Install behavior

- Bottle: not available

## Freshness

- Page generated: 2026-08-03
- Package-manager version: 2.0.1
## 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

- <https://github.com/ekalinin/github-markdown-toc.go>
- <https://github.com/ekalinin/github-markdown-toc.go/releases>
- <https://pkg.go.dev/github.com/ekalinin/github-markdown-toc.go>


## Security Notes

narrow executable package without higher-risk signals.

- **Geiger risk:** green / low
- narrow executable package without higher-risk signals


## Combined YAML source

View the package source record on GitHub. [combined/github-markdown-toc.yml](https://github.com/mxcl/pkgdb/blob/main/combined/github-markdown-toc.yml)


## Sources

- pkg.so package database
- Geiger risk classifier
- curated package history
- pkgdb category and tag curation
- cross-ecosystem install command graph