客服电话
APP下载
迪恩网络APP
随时随地掌握行业动态
官方微信
扫描二维码
关注迪恩网络微信公众号
|
rdoc
基于React的快速静态网站生成器，你只需要写 Markdown 文档即可。访问 react-doc.github.io网站获取更多信息。
 开始rdoc 使用非常简单，只需将其它作为模块安装并运行即可创建您的网站。 让我们开始吧！ 安装安装 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 # Init project# 或者rdoc-cli init my-project
cd my-project && npm install # 进入目录安装依赖npm start # 启动服务。
npm run build
{ "scripts": { "deploy": "rdoc --publish <your repo url>" ... }, ...}
npm run deploy命令帮助Usage: rdoc [options]Fast static site generator for React.Options: -i, init [path] 创建一个空的网站或重新初始化一个现有网站。 -d, --doc <path> 生成指定其他文档。 -o, --output <path> 将编译的文件写入磁盘目录。（默认：.rdoc-dist） -p, --port [number] 端口。(默认: 5858) --host [host] 主机. (默认: 0.0.0.0) -b, --branch <branch> <分支>您要推送的分支的名称。（默认：gh-pages） --publish [url] 将生成的代码，push到指定仓库，已经分支。 --build 创建编译的生产版本。 --clean 删除.cache文件夹。 -h, --help 输出使用帮助文档。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://<your-git-repo>.git --branch master开发获取代码，进入目录，运行自动重载构建，： $ git clone https://github.com/jaywcjlove/rdoc.git$ cd rdoc # 进入目录$ npm install # or yarn install要开发，请运行自重载构建： # 运行应用程序# 每次代码更改时，自动重新启动应用程序。# 在开发过程中很有用。$ npm run start打开浏览器并访问 http://localhost:5858 Folders.├── README.md├── .rdoc-dist├── package.json├── src│ ├── build.js│ ├── commands│ ├── conf│ ├── publish.js│ ├── server.js│ ├── utils│ └── web├── templates│ └── default # 记录静态文件。└── theme └── defaultLicenseThe MIT License (MIT)  |
请发表评论