md-toc-generator
v2.0.0
Published
> Creates and updates tables of content in your markdown files.
Downloads
710
Readme
md-toc-generator
Creates and updates tables of content in your markdown files.
Usage
Install the package globally or as a local dependency:
# npm install md-toc-generator
# npm install --global md-toc-generator
# yarn global add md-toc-generator
yarn add md-toc-generator
Add a placeholder to files that you want to create ToC for:
[//]: # "BEGIN_TOC"
[//]: # "END_TOC"
Then call the script:
# adds/updates ToC README.md in current directory
md-toc-generator
# adds/updates ToC wherever you point it to
md-toc-generator --paths <PATH_TO_MD_FILE>
If you want to lint your markdown files to see if the ToC is up to date, but without changing anything, use the --ci
flag (example usage in the GitHub actions of this project).
md-toc-generator --ci
If you want to ensure that given markdown files have a toc, use the --placeholder-required
option.
License
See LICENSE
file.