gitbook-plugin-toc3

0.2.0 • Public • Published

gitbook-plugin-toc

This plugin will add table of content to the page and provide navigation function inside a page.

Add <!-- toc --> to the markdown files. When you build the book, it will insert a table of content where you insert <!-- toc -->

book.json Config:

{
    "plugins": ["toc"],
    "pluginsConfig": {
        "toc": {
            "addClass": true,
            "className": "toc",
      "maxDepth": 6
        }
    }
}

You can add this config to add a HTML ClassName to the TOC ul element

Versions

Current Tags

  • Version
    Downloads (Last 7 Days)
    • Tag
  • 0.2.0
    1
    • latest

Version History

  • Version
    Downloads (Last 7 Days)
    • Published
  • 0.2.0
    1
  • 0.1.0
    0

Package Sidebar

Install

npm i gitbook-plugin-toc3

Weekly Downloads

1

Version

0.2.0

License

MIT

Last publish

Collaborators

  • ibigbug