Elegant toc plugin for GitBook
JavaScript CSS
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
assets
.gitignore
LICENSE
README.md
index.js
package.json

README.md

gitbook-plugin-etoc

npm npm npm

This plugin will add table of content to the page automatically. When you build the book, it will insert a table of content automatically or to place where you insert <!-- toc -->. Sometimes you may want to disable toc on some page, just add <!-- notoc --> on the the markdown page.

Demo site ==> https://yuanbin.gitbooks.io/test/content/

Sample

screenshot 2016-09-13 23 21 36

Config

Add etoc in book.json is enough for most users.

{
  "plugin": ["etoc"]
}

It will add toc automatically if the markdown page has ### header3(mindepth required to generate toc), and the maxdepth of toc is #### header4 by default. You can also change the default parameter such as:

{
  "plugins": [
    "etoc"
  ],
  "pluginsConfig": {
    "etoc": {
      "mindepth": 3,
      "maxdepth": 4,
      "notoc": false
    }
  }
}

The configuration json schema is shown as following:

"gitbook": {
    "properties": {
        "mindepth": {
          "type": "number",
          "description": "minimal heading level required to generate toc",
          "default": 3
        },
        "maxdepth": {
          "type": "number",
          "description": "maximal heading level to generate toc",
          "default": 4
        },
        "notoc": {
          "type": "boolean",
          "description": "whether to generate toc automatically",
          "default": false
        }
    }
}

LICENSE

MIT