# ekalinin/github-markdown-toc

Easy TOC creation for GitHub README.md

Repository: https://github.com/ekalinin/github-markdown-toc
Canonical: https://ross.abutalabs.com/products/github-markdown-toc
Language: Shell
License: MIT
License Family: permissive
Topics: github, markdown, toc, table-of-contents, shell
Last push: 2024-10-12T19:30:59+00:00

## Health v2 (maintenance only)
Score: 23/100 (v2, computed 2026-09-03T02:20:16.233290+00:00)
- activity 0, release rhythm 8, longevity 100
- inputs: {"age_days": 4383, "days_push": 690, "days_rel": null, "gap_med": null, "n_releases_24m": 0}
- flags: none
- formula: round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10)

## Adoption (not part of the score)
Stars 3296, forks 2684 (observed 2026-08-28T04:07:55.542288+00:00)

## What it is
gh-md-toc is a dependency-free shell script that generates a table of contents for GitHub README.md files and wiki pages. It can process stdin, local markdown files, or remote files hosted on github.com, and supports auto-inserting and updating TOC sections.

## Use cases
- generate a table of contents for my GitHub README.md
- auto-insert and update TOC in markdown docs
- create TOC for a GitHub wiki page without installing software
- generate markdown TOC from stdin in a shell pipeline
- add table of contents to multiple markdown files at once
- generate TOC in GitHub Actions CI

## When to choose
- you want a zero-dependency shell script for GitHub markdown TOC generation
- you work on Linux or macOS and want a quick CLI utility
- you want to automate TOC updates via GitHub Actions or CI

## When to avoid
- you are on Windows and prefer a native binary (use the Go implementation instead)
- you need general-purpose markdown processing beyond TOC generation
- you need parallel processing or a more robust implementation

## Facets
- artifact type: cli-tool
- maturity: stable
- function: markdown, developer-tools, cli, documentation
- domain: developer-tools, documentation
- platform: cli
- tags: table-of-contents, github-readme, shell-script, markdown-toc, command-line, linux, macos

## Member repositories
- ekalinin/github-markdown-toc (main) score 23

## Provenance
- Observed fields: from GitHub, fetched 2026-08-28T04:07:55.542288+00:00.
- Health v2: computed from the inputs above; adoption is never an input.
- Inferred fields (summary, facets, guidance): AI-extracted, prompt v1, taxonomy v1, on 2026-08-29T18:42:58.303298+00:00, confidence not recorded.
  - readme: https://github.com/ekalinin/github-markdown-toc (fetched 2026-08-28T04:07:55.542288+00:00, sha 29a974f11231)
- Data as of 2026-08-30T08:39:29.467469+00:00.