bisheng-plugin-toc

Generate a Table of Contents (TOC) for Markdown files in bisheng.

Usage

Install:

npm i --save bisheng-plugin-toc

Add 'bisheng-plugin-toc to bisehng.config.js's plugins.

module.exports = {
  plugins: ['bisheng-plugin-toc?maxDepth=2'],
};

In template:

<div>
  { utils.toReactComponent(pageData.toc) }
</div>

API

maxDepth: Number

default: 6

keepElem: Boolean

default: false

Whether to keep elements in heading text.

License

MIT

Current Tags

• 0.4.4                                ...           latest (8 years ago)

2 Versions

• 0.4.0                                ...           9 years ago
• 0.4.4                                ...           8 years ago