@m860/react-docgen-markdown

react-docgen-markdown

生成react组件的markdown文档

Install

$ npm i @m860/react-docgen-markdown -D

Simple Usage

$ react-docgen-markdown build test/components --output test/doc
$ react-docgen-markdown readme ...

example doc

将文档添加到README.md中

• 先在README.md文件中表示文档的插入位置,如:

<!--begin react doc markdown-->
<!--end react doc markdown-->

• 然后运行命令

$ react-docgen-markdown readme test/README.md --src test/doc --table-content

example readme