Markdown-it-github-toc NPM

markdown-it-github-toc

markdown-it plugin to add toc and GitHub style heading anchors

Installation

$ npm install markdown-it-github-toc

Usage

import markdownIt from "markdown-it"
import markdownItGithubToc from "markdown-it-github-toc"

markdownIt({
    html: true,
    linkify: true,
    typography: true,
  })
    .use(markdownItGithubToc, {
      // ...options
    })
    .render(md)

Options

`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>.