23.93330046.js

(window.webpackJsonp=window.webpackJsonp||[]).push([[23],{391:function(n,e){n.exports='\x3c!--\ntitle: 命令说明 \nsort: 1\n--\x3e\n\n提供了一个 `rdoc-cli` 命令，跟 `rdoc` 命令是一样的，目的是解决 `Mac` 系统自带的 `Ruby` 命令 `rdoc` 冲突。\n\n## 命令帮助\n\n```shell\nUsage: rdoc [options]\n\nFast static site generator for React.\n\nOptions:\n\n  -i, init [path]        Create an empty website or reinitialize an existing one.\n  -d, --doc <path>       Other documents generated.\n  -o, --output <path>    Writes the compiled file to the disk directory. (default: .rdoc-dist)\n  -p, --port [number]    The port. (default: 5858)\n  -h, --host [host]      The host. (default: 0.0.0.0)\n  -b, --branch <branch>  Name of the branch you are pushing to. (default: gh-pages)\n  --publish [url]        Other documents generated.\n  --build                Creating an optimized production build.\n  --clean                Delete the .cache folder.\n  -h, --help             output usage information\n\nExamples:\n\n  $ rdoc init\n  $ rdoc init doc-example\n  $ rdoc -d doc/mm\n  $ rdoc -d tutorial,doc\n  $ rdoc -d tutorial,doc --clean --build\n  $ rdoc -p 2323  -d doc --clean\n  $ rdoc -h 0.0.0.0 -d doc --clean\n  $ rdoc --publish https://<your-git-repo>.git --branch master\n```\n\n\n## 命令配置实例\n\n通常情况下，将上面命令配置到 `package.json` 中\n\n```json\n{\n  "name": "doc-example",\n  "version": "1.0.0",\n  "scripts": {\n    "start": "rdoc -d home,introduce,faq,doc --clean"\n  },\n  "license": "MIT"\n}\n```\n\n也可以全局安装，直接运行全局命令，这样的话，每次只能编译一个网站。\n\n```shell\n$ rdoc -d doc/mm\n$ rdoc -d tutorial,doc\n$ rdoc -p 2323  -d doc --clean\n$ rdoc -h 0.0.0.0 -d doc --clean\n```\n\n\n'}}]);