Build a TOC for markdown files, meant to work with github pages (built with jekyll).
npm install --save-dev tocify
In package.json:
{
"scripts": {
"toc": "tocify docs > README.md"
}
}
Then README.md would be the index page with navigation links (toc) to pages built from markdown files in the directory docs.
Usage: tocify [options]
Options:
-V, --version output the version number
-d, --toc-dir directory where the toc file is meant to host
-e, --ext <extname> extname of markdown files (default: .md)
-m, --max-level <level> max level of header should be rendered (default: 2)
-s, --word-splitter <splitter> word splitters in path (default: _)
-h, --help output usage information
FAQs
Build table of contents from markdown directory structure
We found that tocify demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Multiple high-impact npm maintainers confirm they have been targeted in the same social engineering campaign that compromised Axios.
Security News
Axios compromise traced to social engineering, showing how attacks on maintainers can bypass controls and expose the broader software supply chain.
Security News
Node.js has paused its bug bounty program after funding ended, removing payouts for vulnerability reports but keeping its security process unchanged.