package
markdown-it plugin to add toc and anchor links in headings
npm install markdown-it-github-tocGitHub-flavored package documentation.
Across all versions.
Download trend unavailable.
Runtime metadata.
Tagged topics.
markdown-it plugin to add toc and GitHub style heading anchors
$ npm install markdown-it-github-tocimport markdownIt from "markdown-it"
import markdownItGithubToc from "markdown-it-github-toc"
markdownIt({
html: true,
linkify: true,
typography: true,
})
.use(markdownItGithubToc, {
// ...options
})
.render(md)toc(default: true)
Allow you to enable/disable the toc transformation of [toc]
tocClassName(default: "markdownIt-TOC")
Option to customize html class of the <ul> wrapping the toc
tocFirstLevel(default: 1)
Allow you to skip some heading level. Example: use 2 if you want to skip <h1>
from the TOC.
tocLastLevel(default: 6)
Allow you to skip some heading level. Example: use 5 if you want to skip <h6>
from the TOC.
anchorLink(default: true)
Allow you to enable/disable the anchor link in the headings
anchorLinkSymbol(default: "#")
Allow you to customize the anchor link symbol
anchorLinkSpace(default: true)
Allow you to enable/disable inserting a space between the anchor link and heading.
anchorLinkSymbolClassName(default: null)
Allow you to customize the anchor link symbol class name. If not null, symbol will be rendered as <span class="anchorLinkSymbolClassName">anchorLinkSymbol</span>.
anchorLinkBefore(default: true)
Allow you to prepend/append the anchor link in the headings
anchorClassName(default: "markdownIt-Anchor")
Allow you to customize the anchor link class
resetIds(default: true)
Allow you to reset (or not) ids incrementation. Use it if you will have multiple documents on the same page.
indentation(default: " ")
Allow you to customize indentation
MIT
Estimated unpacked size across 3 packages.
147.4 kB
Includes dependencies.