installation

Commandes d'installation supplémentaires

macOS

Homebrewvérifié · 100%

brew install github-markdown-toc

local Homebrew formula metadata

aperçu

Résumé du paquet

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

Liens du projet

Commandes et alias

gh-md-toc

historique

Historique du projet et usages

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.

Historique du projet

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.

Historique d'adoption

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.

Modes d'utilisation

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.

Pourquoi les passionnés de paquets s'y intéressent

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.

Chronologie

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

posture de sécurité

Niveau de risque : vert

narrow executable package without higher-risk signals.

Classificateur de risque

risque vert · confiance faible · appliance

Pourquoi

narrow executable package without higher-risk signals

Signaux

metadata:no-higher-risk-signals

Comportement d'installation

Aucun hook post-install Homebrew n’est enregistré dans les métadonnées de formule.
Les métadonnées de bottle Homebrew sont disponibles pour 6 plateformes.
Les métadonnées de compilation listent 1 dépendances de compilation.

Revue recommandée

Avant une utilisation sans surveillance par un agent, vérifiez si l'outil lit des identifiants en clair, écrit un état distant, publie des artefacts ou lance des plugins.

exécutables

Exécutables installés

Commande	Type	Exposition	Note
`gh-md-toc`	cli	exécutable global

fraîcheur

Version et fraîcheur

Ces signaux séparent l'âge de génération de la page, l'activité du gestionnaire de paquets et la comparaison avec les versions amont. Un retard de version n'est signalé que lorsqu'une URL de preuve et des versions comparables sont présentes.

page générée2026-07-25

version du gestionnaire2.0.1

gestionnaire mis à jour2026-07-11

données localesOK

amontà jour

dernière version détectéev2.0.1

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

OKAucun avertissement de fraîcheur n'a été généré.

métadonnées d'installation

Métadonnées du paquet

Clé du paquet	brew:github-markdown-toc
Version	2.0.1
Gestionnaire de paquets	Homebrew
Page du gestionnaire de paquets	https://formulae.brew.sh/formula/github-markdown-toc
Page d'accueil	https://github.com/ekalinin/github-markdown-toc.go
Dépôt	https://github.com/ekalinin/github-markdown-toc.go
Docs amont	https://github.com/ekalinin/github-markdown-toc.go#readme
Licence	MIT
Archive source	https://github.com/ekalinin/github-markdown-toc.go/archive/refs/tags/v2.0.1.tar.gz
Dernière mise à jour	2026-07-11T19:18:42+02:00
Pulse	updated
Dépendances de compilation	go
Bouteille	disponible (sur arm64_linux, arm64_sequoia, arm64_sonoma, arm64_tahoe, sonoma, x86_64_linux)
post-install Homebrew	non défini
Service	aucun déclaré

faits du registre

Détails de la base source

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

graphe de paquets

Les liens viennent du graphe local de relations entre paquets, des suppléments, des dépendances, des correspondances d'écosystèmes et de l'appartenance aux hubs.

piste source

Généré depuis les données du dépôt

Cette page est servie par av-web depuis l'artéfact SQLite privé des paquets généré par scripts/generate-pkg-sqlite.py.

Combined YAML source

View the package source record on GitHub.

combined/github-markdown-toc.yml

Sources utilisées

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

Installer github-markdown-toc avec Homebrew