doc-platform

v2.0

依赖的框架从v1.0的 bisheng，切换到 react-styleguidist(了解更多)

v1.0 vs v2.0

版本	框架	在线调试	UI定制化	配置灵活度	md meta
1.0	bisheng	不支持	弱	低	支持
2.0	react-styleguidist	支持	强	高	不支持

文档配置

1. 在docs中新建目录 A，在 A/中新建 config.json

之所以引入config.json文件，原因有二：

1. 为了扩展md文档本身的属性，如：丰富菜单的内容、控制文档是否显示、meta剥离出md文件等场景
2. 内部是有一个平台统一管理这里的文档，大部分文档是通过其平台配置的gitlab地址去实时爬取，对应了一份配置数据。但同时需要兼容手动塞入的文档 你也可以不采用这种方案，修改router.config.js内的逻辑，改为读取目录下的文件生成菜单树

2. 在config.json中输入对应的组件文档信息

3. 在 A/ 中放入组件文档

4. 重新打包应用

服务器部署

将build下面的产物放置到对应的资源服务器目录，配置代理服务器（如nginx）和域名之后，即可访问

本地调试

npm i
npm start

本地打包

npm run build

其他

• 文档中如果需要展示代码运行的结果，请设置代码块类型为jsx
• 如果文档目录命名为mobile，系统会自动适配，把mobile组件放置到一个手机模型中展示
• 为了演示方便，引入了[email protected]的包，可自行替换为自研组件库或者其他三方库