jonschlinkert/markdown-toc
API and CLI for generating a markdown TOC (table of contents) for a README or any markdown files. Uses Remarkable to parse markdown. Used by NASA/openmct, Prisma, Joi, Mocha, Sass, Prettier, Orbit DB, FormatJS, Raneto, hapijs/code, webpack-flow, docusaurus, release-it, ts-loader, json-server, reactfire, bunyan, husky, react-easy-state, react-snap, chakra-ui, carbon, alfresco, repolinter, Assemble, Verb, and thousands of other projects. observed · 2026-08-28
Health v2 · maintenance only
32/100
- Activity 0
- Release rhythm 35
- Longevity 100
Flags: no_releases
How is this computed?
round(0.45*activity + 0.35*rhythm + 0.20*longevity); archived -> min(score, 10) — computed 2026-09-03. Adoption (stars, forks) is never an input.
- gap_med: n/a
- age_days: 4681
- days_rel: n/a
- days_push: 754
- n_releases_24m: 0
Adoption not part of the score
1756 stars · 712 forks observed · 2026-08-28
What it is AI-extracted, prompt v1, taxonomy v1, 2026-08-30, confidence not recorded
A Node.js library and CLI that generates a table of contents for markdown files like READMEs, using Remarkable to parse headings. It can inject the TOC directly into a file at a <!-- toc --> marker and also exposes a JSON API.
Use cases
- generate a table of contents for a README
- auto-insert TOC into markdown docs
- extract heading structure from a markdown file as JSON
- add navigation links to documentation
- keep README TOC in sync with headings via a script
When to choose
- you maintain markdown docs or READMEs and want an auto-generated, linkable TOC
- you need a programmatic API to extract markdown heading structure
- you want a simple CLI to inject a TOC at a marker in place
When to avoid
- you need a full static site generator or docs framework
- your project uses MDX or non-standard markdown syntax Remarkable may not handle
- you need actively developed features rather than a stable maintenance-mode tool
Facets
library · maturity maintenance
markdown parser cli documentation developer-tools documentation developer-tools cli cross-platform table-of-contents toc-generator remarkable readme npm-package command-line nodejs
3 sources
- readme: https://github.com/jonschlinkert/markdown-toc · fetched 2026-08-28 · 99a410d61afa
- homepage: https://github.com/jonschlinkert · fetched 2026-08-29 · 5ff17830cf36
- registry_npm: https://registry.npmjs.org/markdown-toc · fetched 2026-08-29 · 0dfa2f0b2ce8
Member repositories
| Repository | Role | Health v2 |
|---|---|---|
| jonschlinkert/markdown-toc | main | 32 |
For agents
markdown · JSON · MCP: product_card(name="jonschlinkert/markdown-toc")
Data as of 2026-08-30T08:39:29.467469+00:00 · Report a problem