This plugin adds a table of content (TOC) button to your GitBook page. All three GitBook themes (White, Sepia, Night) are supported. This project took heavy inspiration from https://plugins.gitbook.com/plugin/anchor-navigation.
Add the plugin to your book.json:
{
"plugins" : [ "page-toc-button" ]
}
You can add the following configuration params to your book.json:
{
"plugins" : [
"page-toc-button"
],
"pluginsConfig": {
"page-toc-button": {
"maxTocDepth": 2,
"minTocSize": 2
}
}
}
| Name | Type | Default | Description |
|---|---|---|---|
| maxTocDepth | Number | 2 | Maximal depth of headers (2 = h1 + h2 + h3). A value > 2 is not supported. |
| minTocSize | Number | 2 | Minimal number of toc entries for showing the toc button. |
The page toc button:
The page toc menu:
- 0.1.0 Releases:
- 0.1.0 First release
- 0.1.1 Button icon switched