安装

其他安装命令

macOS

Homebrew已验证 · 100%

brew install github-markdown-toc

local Homebrew formula metadata

概览

软件包摘要

Easy TOC creation for GitHub README.md (in go)

项目链接

命令和别名

gh-md-toc

历史

项目历史与用法

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.

来源

安全态势

风险级别：绿色

narrow executable package without higher-risk signals.

风险分类器

绿色风险 · 低置信度 · appliance

原因

narrow executable package without higher-risk signals

信号

metadata:no-higher-risk-signals

安装行为

formula 元数据中未记录 Homebrew post-install 钩子。
Homebrew bottle 元数据适用于 6 个平台目标。
构建元数据列出 1 个构建依赖。

建议审查

在无人值守的代理使用前，请检查该工具是否读取明文凭据、写入远程状态、发布制品或调用插件。

可执行文件

已安装的可执行文件

命令	类型	暴露范围	备注
`gh-md-toc`	cli	全局可执行文件

新鲜度

版本和新鲜度

这些信号区分页生成时间、软件包管理器活动和上游发布比较。只有存在证据 URL 和可比较版本时，才会提示版本落后。

页面生成时间2026-07-25

管理器版本2.0.1

管理器更新时间2026-07-11

本地数据OK

上游当前

检测到的最新版本v2.0.1

https://github.com/ekalinin/github-markdown-toc.go

OK没有生成新鲜度警告。

安装元数据

软件包元数据

软件包键	brew:github-markdown-toc
版本	2.0.1
软件包管理器	Homebrew
软件包管理器页面	https://formulae.brew.sh/formula/github-markdown-toc
主页	https://github.com/ekalinin/github-markdown-toc.go
仓库	https://github.com/ekalinin/github-markdown-toc.go
上游文档	https://github.com/ekalinin/github-markdown-toc.go#readme
许可证	MIT
源码归档	https://github.com/ekalinin/github-markdown-toc.go/archive/refs/tags/v2.0.1.tar.gz
最后更新	2026-07-11T19:18:42+02:00
Pulse	updated
构建依赖	go
Bottle	可用 (于 arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
Homebrew post-install	未定义
服务	未声明

注册表事实

源数据库详情

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

软件包图谱

链接来自本地软件包关系图、补充数据、依赖边、生态匹配和软件包 hub 归属。

来源线索

由仓库数据生成

此页面由 av-web 从 scripts/generate-pkg-sqlite.py 生成的私有软件包 SQLite 工件提供。

Combined YAML source

View the package source record on GitHub.

combined/github-markdown-toc.yml

使用的来源

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

使用 Homebrew 安装 github-markdown-toc