RDoc-cli基于 React 的文檔生成工具

RDoc-cli

主要用于快速生成文檔工具或簡(jiǎn)單的網(wǎng)站，只需要寫Markdown文件既可。

立即開始

通過安裝rdoc來快速開始，默認(rèn)生成 rdoc 文檔網(wǎng)站，基于這個(gè)簡(jiǎn)單工程創(chuàng)建自己的網(wǎng)站，更詳細(xì)的配置請(qǐng)參閱官方文檔。

1. 安裝

npm install rdoc -g # 安裝rdoc

2. 初始化一個(gè)網(wǎng)站

rdoc init my-project

3. 運(yùn)行網(wǎng)站

$ cd my-project
$ npm start

4. 編譯輸出HTML靜態(tài)資源

npm run build

5. 部署到 github 的 gh-pages 分支，需要關(guān)聯(lián) github 并設(shè)置 package.json 參數(shù) push 到指定倉(cāng)庫(kù)的指定分支，默認(rèn)推送到 gh-pages，指定分支需要跟上參數(shù) -b master 即可。

{
  "scripts": {
    "deploy": "rdoc --publish  -b master"
    ...
  },
  ...
}

npm run deploy