# bisheng-plugin-toc

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

Latest version **0.4.4** (published 2017-10-17) · MIT license · 0 weekly downloads

## Install

```sh
npm install bisheng-plugin-toc
pnpm add bisheng-plugin-toc
yarn add bisheng-plugin-toc
bun add bisheng-plugin-toc
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.4.4 |
| Published | 2017-10-17 |
| First published | 2016-05-19 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Author | Benjy Cui |
| Maintainers | benjycui |
| Keywords | bisheng, plugin, toc, markdown |

## Links

- npm: https://www.npmjs.com/package/bisheng-plugin-toc
- Repository: https://github.com/benjycui/bisheng-plugin-toc
- Homepage: https://github.com/benjycui/bisheng-plugin-toc#readme
- Issues: https://github.com/benjycui/bisheng-plugin-toc/issues
- npm.io page: https://npm.io/package/bisheng-plugin-toc

## Dependencies (1)

- [jsonml.js](https://npm.io/package/jsonml.js.md) ^0.1.0

## Alternatives

- [@mdxeditor/editor](https://npm.io/package/@mdxeditor/editor.md) — 962.4K weekly downloads
- [mmdb-lib](https://npm.io/package/mmdb-lib.md) — 680.9K weekly downloads
- [playcanvas](https://npm.io/package/playcanvas.md) — 36.2K weekly downloads
- [@glw907/cairn-cms](https://npm.io/package/@glw907/cairn-cms.md) — 967 weekly downloads
- [markdown-to-confluence](https://npm.io/package/markdown-to-confluence.md) — 103 weekly downloads

## Recent versions

- 0.4.4 (latest) — 2017-10-17
- 0.4.3 — 2017-10-16
- 0.4.2 — 2017-03-28
- 0.4.1 — 2017-02-09
- 0.4.0 — 2016-07-29
- 0.3.0 — 2016-07-25
- 0.2.0 — 2016-05-24
- 0.2.0-beta.0 — 2016-05-24
- 0.1.0 — 2016-05-20
- 0.1.0-beta.0 — 2016-05-19

## README

# bisheng-plugin-toc

[![](https://img.shields.io/travis/benjycui/bisheng.svg?style=flat-square)](https://travis-ci.org/benjycui/bisheng)
[![npm package](https://img.shields.io/npm/v/bisheng-plugin-toc.svg?style=flat-square)](https://www.npmjs.org/package/bisheng-plugin-toc)
[![NPM downloads](http://img.shields.io/npm/dm/bisheng-plugin-toc.svg?style=flat-square)](https://npmjs.org/package/bisheng-plugin-toc)
[![Dependency Status](https://david-dm.org/benjycui/bisheng-plugin-toc.svg?style=flat-square)](https://david-dm.org/benjycui/bisheng-plugin-toc)

Generate a Table of Contents (TOC) for Markdown files in [`bisheng`](https://github.com/benjycui/bisheng).

## Usage

Install:

```bash
npm i --save bisheng-plugin-toc
```

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

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

In template:

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

## API

### maxDepth: Number

> default: 6

### keepElem: Boolean

> default: false

Whether to keep elements in heading text.

## License

MIT

---
_Source: https://npm.io/package/bisheng-plugin-toc · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._