gitbook-plugin-atoc

Add table of content for GitBook

Usage no npm install needed!

<script type="module">
  import gitbookPluginAtoc from 'https://cdn.skypack.dev/gitbook-plugin-atoc';
</script>

README

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