willin / gitbook-plugin-atoc

A TOC plugin for GitBook

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

gitbook-plugin-atoc

npm npm npm

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": ["atoc"],
	"pluginsConfig": {
		"atoc": {
			"addClass": true,
			"className": "atoc"
		}
	}
}

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

LICENSE

MIT

Alipay Donation(通过支付宝捐赠):

qr

About

A TOC plugin for GitBook

License:MIT License


Languages

Language:JavaScript 69.5%Language:CSS 30.5%