RDoc协助你天生静态网站，你只需要写Markdown

RDoc 是一个文档天生东西，用于天生文档网站或简朴的博客网站。
简朴到你只需写 Markdown 文件就能够协助你天生网站。
同时能够轻易的集成到你的项目工程中。

• 官方网站
• 开源Github

下图官方网站，是 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

祝贺你，你已天生了一个网站。?