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
複製代碼

恭喜你，你已經生成了一個網站。😆