kubernetes-handbook/node_modules/gitbook-plugin-page-toc-button
Jimmy Song 8994b10440
update cover
2022-03-01 22:28:42 +08:00
..
assets add node modules 2021-04-13 00:24:28 +08:00
.npmignore add node modules 2021-04-13 00:24:28 +08:00
LICENSE add node modules 2021-04-13 00:24:28 +08:00
README.md add node modules 2021-04-13 00:24:28 +08:00
index.js add node modules 2021-04-13 00:24:28 +08:00
package.json add node modules 2021-04-13 00:24:28 +08:00
screenshot1.png update cover 2022-03-01 22:28:42 +08:00
screenshot2.png update cover 2022-03-01 22:28:42 +08:00

README.md

Gitbook Page TOC Button Plugin npm version

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.

Usage

Installation

Add the plugin to your book.json:

{
	"plugins" : [ "page-toc-button" ]
}		

Optional configuration

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.

Screenshots

The page toc button:

Page Toc Button

The page toc menu:

Page Toc Menu

Changelog

  • 0.1.0 Releases:
    • 0.1.0 First release
    • 0.1.1 Button icon switched