https://github.com/willin/gitbook-plugin-atoc

A TOC plugin for GitBook
https://github.com/willin/gitbook-plugin-atoc

gitbook gitbook-plugin plugin toc toc-generator

Last synced: 10 months ago
JSON representation

A TOC plugin for GitBook

• Host: GitHub
• URL: https://github.com/willin/gitbook-plugin-atoc
• Owner: willin
• License: mit
• Created: 2015-09-30T15:01:08.000Z (over 10 years ago)
• Default Branch: master
• Last Pushed: 2017-07-20T09:28:10.000Z (over 8 years ago)
• Last Synced: 2025-04-10T18:47:31.103Z (10 months ago)
• Topics: gitbook, gitbook-plugin, plugin, toc, toc-generator
• Language: JavaScript
• Size: 11.7 KB
• Stars: 24
• Watchers: 4
• Forks: 5
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# gitbook-plugin-atoc

[![npm](https://img.shields.io/npm/v/gitbook-plugin-atoc.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-atoc) [![npm](https://img.shields.io/npm/dm/gitbook-plugin-atoc.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-atoc) [![npm](https://img.shields.io/npm/dt/gitbook-plugin-atoc.svg?style=plastic)](https://npmjs.org/package/gitbook-plugin-atoc)

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

Add `` to the markdown files. When you build the book, it will insert a table of content where you insert ``

`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](https://cloud.githubusercontent.com/assets/1890238/15489630/fccbb9cc-2193-11e6-9fed-b93c59d6ef37.png)