https://github.com/canfoo/doc-react

react componet on markdown
https://github.com/canfoo/doc-react

Last synced: 6 months ago
JSON representation

react componet on markdown

• Host: GitHub
• URL: https://github.com/canfoo/doc-react
• Owner: canfoo
• Created: 2018-12-06T03:30:47.000Z (about 7 years ago)
• Default Branch: master
• Last Pushed: 2020-09-04T00:55:14.000Z (over 5 years ago)
• Last Synced: 2025-07-19T07:13:54.643Z (6 months ago)
• Language: CSS
• Size: 445 KB
• Stars: 3
• Watchers: 1
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

          
## doc-react

react 组件文档：通过markdown语法渲染出组件，快速方便为你的组件写出优美的文档。

## 如何使用

下载：

```

npm install raw-loader -dev

```

```

npm install doc-react --save

```

在你webpack的loader添加一行规则：

```

{

  test: /\.md$/,

  loader : 'raw-loader'

}

```

代码引入

```

import Tooltip from 'rc-tooltip'

import docReact from 'doc-react'

import toolipMd from '../doc/tooltip.md'

const Doc = docReact({ Tooltip }, toolipMd)

const Home = () => 
;

```


tooltip.md 部分代码



渲染出



详细demo：[https://github.com/canfoo/doc-react/blob/master/example/app.js](https://github.com/canfoo/doc-react/blob/master/example/app.js)