RDoc-cli 基于 React 的文档生成工具 项目简介
RDoc-cli主要用于快速生成文档工具或简单的网站,只需要写Markdown文件既可。立即开始通过安装rdoc来快速开始,默认生成 rdoc 文档网站,基于这个简单工程创建自己的网站,更详细的配置请参阅官方文档。1. 安装npm install rdoc -g # 安装rdoc2. 初始化一个网站rdoc init my-project3. 运行网站$ cd my-project
$ npm start4. 编译输出HTML静态资源npm run build5. 部署到 github 的 gh-pages 分支,需要关联 github 并设置 package.json 参数 push 到指定仓库的指定分支,默认推送到 gh-pages,指定分支需要跟上参数 -b master 即可。{
"scripts": {
"deploy": "rdoc --publish -b master"
...
},
...
}npm run deploy
$ npm start4. 编译输出HTML静态资源npm run build5. 部署到 github 的 gh-pages 分支,需要关联 github 并设置 package.json 参数 push 到指定仓库的指定分支,默认推送到 gh-pages,指定分支需要跟上参数 -b master 即可。{
"scripts": {
"deploy": "rdoc --publish -b master"
...
},
...
}npm run deploy