开源中国

我们不支持 IE 10 及以下版本浏览器

It appears you’re using an unsupported browser

为了获得更好的浏览体验,我们强烈建议您使用较新版本的 Chrome、 Firefox、 Safari 等,或者升级到最新版本的IE浏览器。 如果您使用的是 IE 11 或以上版本,请关闭“兼容性视图”。
RDoc-cli首页、文档和下载 - 基于 React 的文档生成工具 - 开源中国社区
Float_left Icon_close
全部项目分类
MIT
JavaScript HTML/CSS
跨平台
同一种调调
分享
收藏
36 人收藏
收录时间:2018-01-17
RDoc-cli 详细介绍

RDoc-cli

主要用于快速生成文档工具或简单的网站,只需要写Markdown文件既可。

立即开始

通过安装rdoc来快速开始,默认生成 rdoc 文档网站,基于这个简单工程创建自己的网站,更详细的配置请参阅官方文档

1. 安装

npm install rdoc -g # 安装rdoc

2. 初始化一个网站

rdoc init my-project

3. 运行网站

$ cd my-project
$ npm start

4. 编译输出HTML静态资源

npm run build

5. 部署到 github 的 gh-pages 分支,需要关联 github 并设置 package.json 参数 push 到指定仓库的指定分支,默认推送到 gh-pages,指定分支需要跟上参数 -b master 即可。

{
  "scripts": {
    "deploy": "rdoc --publish  -b master"
    ...
  },
  ...
}
npm run deploy
RDoc-cli

选择将代码托管在码云
你还在等什么

可能是中国最大最好的代码托管平台


大家对 RDoc-cli 的评论 (全部 3 条评论)
{{repayCom.userName}}
yanhl
有模板嘛,类似普通博客的那种模板 hexo
同一种调调
界面不一样 :) :-) o(*≧▽≦)ツ
hbzhangmao
与 gitbook 有啥区别?
顶部