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, rea...
Overview:
The markdown-toc is an npm package that allows users to generate a table of contents (TOC) for markdown files using the Remarkable library. The package provides a simple and customizable way to create TOCs in markdown files, making it easier for readers to navigate through the document. The package is developed and maintained by Jon Schlinkert, and it can be installed via npm.
Features:
- Generate Markdown TOC: The markdown-toc package allows users to generate a table of contents for markdown files, making it easier for readers to navigate through the document.
- Easy Installation: The package can be easily installed using npm, which makes it convenient for developers to add TOCs to their markdown files.
- Customizable: Users have the option to customize the TOC output by using options such as filtering headings, changing link creation, and adjusting indentation.
Summary:
The markdown-toc package provides a convenient way to generate table of contents in markdown files. With this package, users can easily navigate through lengthy markdown documents. The package is customizable and can be easily installed via npm.
- Documentation
Documentation themes are built specifically for writing technical and product documentation. They are normally written and maintained in Markdown. The often include a navigation menu, search bar, clear headings, semantic document structure and clean typography.
