Learn about our RFC process, Open RFC meetings & more.Join in the discussion! »

bisheng-plugin-toc

0.4.4 • Public • Published

bisheng-plugin-toc

npm package NPM downloads Dependency Status

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

Install

npm i bisheng-plugin-toc

DownloadsWeekly Downloads

2,479

Version

0.4.4

License

MIT

Last publish

Collaborators

  • avatar