组件文档-react-docz

标签：doc   com   div   配置   code   href   http   github   定义   

推荐指数：????????

一、参考

https://github.com/doczjs/docz

二、特性

1、支持性

目前仅支持react。

2、创建mdx文件

使用Markdown语法的扩展MDX(在Markdown里引入React组件并渲染出组件)来书写文档。

3、gatsby

docz是在gatsby的基础上做文档。

4、可配置

支持自定义配置主题，可插拔插件。

5、支持typescript

全面支持typescript， 不需要额外配置。

6、构建飞速

热重载，代码分割。

三、开启新项目

1、创建项目

npx create-docz-app create-react-app-docz
# or
yarn create docz-app create-react-app-docz --example typescript

2、新建文件mdx

3、配置doczrc.js文件

4、运行

yarn docz dev

四、在老项目加docz

1、安装

2、新建mdx文件和jsx文件

3、配置doczrc.js文件

五、利弊

安装依赖较慢。

组件文档-react-docz

标签：doc   com   div   配置   code   href   http   github   定义   

原文地址：https://www.cnblogs.com/camille666/p/react-docz.html