Home/Developer Tools/github-markdown-toc
github-markdown-toc logo

github-markdown-toc

ekalinin/github-markdown-toc

Tool for generating Table of Contents for GitHub README.md files

GraphCanon updated Sep 20, 2026 · GitHub synced Sep 20, 2026

19views this month

3.3k stars2.7k forksLast push Oct 12, 2024 Shell MIT

Decision brief

github-markdown-toc is a shell script for generating Table of Contents for README.md files without requiring additional software installation.

Good fit when

  • When you need to generate a Table of Contents for README.md files or GitHub wiki pages and prefer not to install additional software.
  • If you are working on Linux or macOS and want a tool that can process stdin, local files, and remote files.

Avoid when

  • If you are working on Windows, as the tool is not natively supported and a Go-based alternative is recommended for better reliability and parallel processing.
  • When you require a tool with more advanced features such as parallel processing or if you need a more solid and reliable solution, as the Go-based alternative github-markdown-toc.go is recommended.
Requirements:
The tool is a shell script and does not require additional software installation.

Observed Sep 18, 2026 · Source: enrich:decision_facts

Verify the decision

Maintenance and security

Full trust report
Maintenance
Dormant (705d since push)
As of Sep 18, 2026
Provenance
Not a fork · Personal account
As of Sep 18, 2026
Security (OSV)
No lockfile
As of Sep 18, 2026

Public GitHub metadata and optional OSV scans. Signals, not a guarantee. Trust methodology.

Install

git clone https://github.com/ekalinin/github-markdown-toc

Similar tools

Same-category neighbours. No typed graph edges are catalogued for this tool yet.

Evidence and technical details

Sourced facts, taxonomy, compatibility claims, README excerpt, and machine-readable endpoints.

Overview

A shell script that generates Table of Contents for README.md files without requiring additional software installation.

Capability facts

Deploy
Self-host

Source: dockerfile:Dockerfile · Sep 18, 2026

Docker
Dockerfile present

Source: dockerfile:Dockerfile · Sep 18, 2026

Languages
shell

Source: github.language · Sep 18, 2026

Categories

Tags

README

gh md toc ========= gh md toc — is for you if you want to generate TOC (Table Of Content) for a README.md or a GitHub wiki page without installing additional software . It's my try to fix a problem: github/issues/215 gh md toc is able to process: stdin local files (markdown files...

For agents

This page has a .md twin and JSON over the API.

Was this helpful?

Anonymous feedback helps us improve pages and translations.