Download
markdown-toc is a JavaScript API and CLI for generating tables of contents from Markdown files. It uses Remarkable to parse Markdown headings and turn them into linked TOC entries. Developers can run it from the command line, inject a TOC directly into a file, or use it programmatically from Node.js. The tool can also output JSON so applications can render their own TOC templates. It includes options for heading depth, bullet style, filtering, slug generation, indentation, and first-heading behavior. It is especially useful for maintaining README files, documentation pages, and generated docs where headings change over time.
Features
- Markdown table of contents generation
- CLI and Node API support
- In-place README injection
- JSON TOC output
- Custom slug generation
- Heading filtering and depth control
Project Samples
Categories
Markdown EditorsLicense
MIT LicenseFollow markdown-toc
Other Useful Business Software
Ship Agents Faster
Gemini Enterprise Agent Platform lets you rapidly build, scale, govern and optimize production-ready agents grounded in your organization's data. The platform enables developers to build custom or pre-built agents for virtually any use case. New customers get $300 in free credits.
Rate This Project
Login To Rate This Project
User Reviews
Be the first to post a review of markdown-toc!