bisheng-plugin-api-doc

1.0.0 • Public • Published

bisheng-plugin-api-doc

To extract api doc from Markdown.

Usage

Install:

npm i --save bisheng-plugin-api-doc

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

module.exports = {
  plugins: ['bisheng-plugin-api-doc'],
};

In Markdown:

---
title: ...
...
---
 
This is description.
 
---
 
## API
 
This is api doc content.

In template:

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

Liscense

MIT

Package Sidebar

Install

npm i bisheng-plugin-api-doc

Weekly Downloads

0

Version

1.0.0

License

MIT

Unpacked Size

3.18 kB

Total Files

5

Last publish

Collaborators

  • liujinyang
  • jinyang1994