# 使用 Homebrew 安装 github-markdown-toc

查看 github-markdown-toc 的安装路径、可执行文件、元数据以及面向 AI 代理工作流的安全说明。

## 安装

```sh
sudo av install brew:github-markdown-toc
```

其他安装命令:

### macOS

- Homebrew (100%):

```sh
brew install github-markdown-toc
```

  证据: local Homebrew formula metadata

## 软件包事实

- **软件包键:** brew:github-markdown-toc
- **软件包管理器:** Homebrew
- **软件包管理器页面:** <https://formulae.brew.sh/formula/github-markdown-toc>
- **版本:** 2.0.1
- **来源摘要:** Easy TOC creation for GitHub README.md (in go)
- **主页:** <https://github.com/ekalinin/github-markdown-toc.go>
- **仓库:** <https://github.com/ekalinin/github-markdown-toc.go>
- **许可证:** MIT
- **源码归档:** <https://github.com/ekalinin/github-markdown-toc.go/archive/refs/tags/v2.0.1.tar.gz>
- **最后更新:** 2026-07-29T16:05:02+02:00
- **已生成:** 2026-08-04T22:13:35+00:00

## 可执行文件

- gh-md-toc (cli)
- gh-md-toc (别名)

## 构建依赖

- go

## 安装行为

- post-install 钩子: 未定义
- Bottle: 可用 于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux

## 版本和新鲜度

- 页面生成时间: 2026-08-04
- 管理器版本: 2.0.1
- 管理器更新时间: 2026-07-29
- 本地数据: OK
- 上游仓库: https://github.com/ekalinin/github-markdown-toc.go
- 检测到的最新版本: v2.0.1 (当前)
## 项目历史与用法

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.

### 项目历史

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.

### 采用历史

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.

### 使用方式

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.

### 为什么软件包爱好者会关心

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.

### 时间线

- 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.

### 来源

- <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>


## 安全说明

narrow executable package without higher-risk signals.

- **Geiger 风险:** 绿色 / 低
- narrow executable package without higher-risk signals

## 源数据库详情

- **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:** stable


## 相关链接

- [Source-control packages](https://pkg.so/zh-hans/source-control-tools/) - Belongs to a source-control command family.
- [Terminal utility packages](https://pkg.so/zh-hans/terminal-utilities/) - Matched terminal and command-line workflow metadata.
- [Text processing packages](https://pkg.so/zh-hans/text-processing-tools/) - Matched text, document, or structured-data processing metadata.
- [Developer build packages](https://pkg.so/zh-hans/developer-build-tools/) - Matched build, compiler, generator, or developer workflow metadata.
- [go](https://pkg.so/zh-hans/brew/go/) - Build dependency declared by Homebrew.
- [grip](https://pkg.so/zh-hans/brew/grip/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, github, markdown.
- [go-md2man](https://pkg.so/zh-hans/brew/go-md2man/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [mdbook](https://pkg.so/zh-hans/brew/mdbook/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [mkdocs-material](https://pkg.so/zh-hans/brew/mkdocs-material/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [adr-tools](https://pkg.so/zh-hans/brew/adr-tools/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [markdown](https://pkg.so/zh-hans/brew/markdown/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [docmd](https://pkg.so/zh-hans/brew/docmd/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [ronn](https://pkg.so/zh-hans/brew/ronn/) - Shares pkgdb curated category or tags: cli, developer-tools, documentation, markdown.
- [markdown-toc](https://pkg.so/zh-hans/npm/markdown-toc/) - Both packages work with overlapping file formats or content types. Shared terms: cli, contents, developer, developer-tools, documentation.
- [markdown-toc-gen](https://pkg.so/zh-hans/npm/markdown-toc-gen/) - Both packages work with overlapping file formats or content types. Shared terms: cli, contents, developer, developer-tools, documentation.
- [github-keygen](https://pkg.so/zh-hans/brew/github-keygen/) - Package names and metadata indicate a similar tool family. Shared terms: cli, developer, developer-tools, github.

## 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)


## 来源

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