RDoc 是一个文档生成工具,用于生成文档网站或简单的博客网站。 简单到你只需写 Markdown 文件就可以帮助你生成网站。 同时可以方便的集成到你的项目工程中。
下图官方网站,是 rdoc 生成的:
基于React的快速静态站点生成器,只需编写Markdown文件即可。 访问react-doc.github.io网站获取更多信息。
快速开始
在您的系统上全局安装rdoc。需要在本地开发机器上具有Node> = 8
。 您可以使用 n 来轻松切换不同项目之间的Node版本。
全局安装
npm install rdoc -g
复制代码
初始化网站
rdoc init my-project # Init project
复制代码
运行网站
cd my-project && npm start # Into the directory, start the service.
## Compiled successfully!
## You can now view doc-example in the browser.
## Local: http://localhost:5858/
## On Your Network: http://192.168.188.109:5858/
## Note that the development build is not optimized.
## To create a production build, use npm run build.
复制代码
编译生成HTML
npm run build
复制代码
修改部署配置
在 package.json
中配置部署URL
{
"scripts": {
"deploy": "rdoc --publish <您的GitHub仓库地址>"
...
},
...
}
复制代码
例如:
{
"scripts": {
"deploy": "rdoc --publish https://github.com/react-doc/react-doc.github.io.git --branch master"
...
},
...
}
复制代码
上面 deploy
实例,将当前工程生成的静态 push
到 https://github.com/react-doc/react-doc.github.io.git
仓库的 master
分支中。
--branch master
参数指定分支,默认没有这个参数,推向指定网站的gh-pages
分支。
部署网站
npm run deploy
复制代码
恭喜你,你已经生成了一个网站。?