RDoc
RDoc 是一个文档生成工具，用于生成文档网站或简单的博客网站。
简单到你只需写 Markdown 文件就可以帮助你生成网站。
同时可以方便的集成到你的项目工程中。
快速开始
在开始之前，推荐先学习 Markdown 语法，并正确安装和配置了 [Node.js](https://nodejs.org) v8.0 或以上。 主要用于快速生成文档工具或简单的网站，只需要写Markdown文件既可。 ```bash npm install rdoc -g # 安装工具 # /usr/local/bin/rdoc -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js # /usr/local/bin/rdoc-cli -> /usr/local/lib/node_modules/rdoc/.bin/rdoc.js rdoc init my-project # 初始化项目 # 也可以使用 rdoc-cli 命令，跟 rdoc 命令是一样的 # 增加 用 rdoc-cli 命令，目的是解决 Mac 系统自带的 Ruby 命令 rdoc 冲突 cd my-project && npm start # 进入工程，启动服务 ``` ### Command ```shell Usage: rdoc [options] Fast static site generator for React. Options: -i, init [path] Create an empty website or reinitialize an existing one. -d, --doc
Other documents generated. -o, --output
Writes the compiled file to the disk directory. (default: .rdoc-dist) -p, --port [number] The port. (default: 5858) --host [host] The host. (default: 0.0.0.0) -b, --branch
Name of the branch you are pushing to. (default: gh-pages) --publish [url] Other documents generated. --build Creating an optimized production build. --clean Delete the .cache folder. -h, --help output usage information Examples: $ rdoc init $ rdoc init doc-example $ rdoc -d doc/mm $ rdoc -d tutorial,doc $ rdoc -d tutorial,doc --clean --build $ rdoc -p 2323 -d doc --clean $ rdoc --host 0.0.0.0 -d doc --clean $ rdoc --publish https://
.git --branch master ```