RDoc-cli 正在参加 2021 年度 OSC 中国开源项目评选,请投票支持!
RDoc-cli 在 2021 年度 OSC 中国开源项目评选 中已获得 {{ projectVoteCount }} 票,请投票支持!
2021 年度 OSC 中国开源项目评选 正在火热进行中,快来投票支持你喜欢的开源项目!
2021 年度 OSC 中国开源项目评选 >>> 中场回顾
RDoc-cli 获得 2021 年度 OSC 中国开源项目评选「最佳人气项目」 !
授权协议 MIT
开发语言 JavaScript HTML/CSS
操作系统 跨平台
软件类型 开源软件
开源组织
地区 国产
投 递 者 小弟调调
适用人群 未知
收录时间 2018-01-17

软件简介

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
展开阅读全文

代码

的 Gitee 指数为
超过 的项目

评论

点击加入讨论🔥(4)
2018/03/15 10:05

RDoc 1.3.9 发布,只需写 Markdown 即可生成网站

RDoc 1.3.9 发布,这是一款基于 React 的文档生成工具,只需要写Markdown 文件,即可帮助你生成静态页面,更详细的说明请参阅官方文档。 更新内容 更新文档内容 添加部署错误日志输出 重构部署命令

3
15
发表于服务端专区
2018/03/14 13:40

RDoc 1.3.8 发布,只需写 Markdown 即可生成网站

RDoc 1.3.8 发布,这是一款基于 React 的文档生成工具,只需要写Markdown 文件,即可帮助你生成静态页面,更详细的说明请参阅官方文档。 更新内容: 修复windows路径问题,兼容windows下使用 - 4f44942

0
3
2018/03/08 15:55

RDoc 1.3.7 发布,只需写 Markdown 即可生成网站

RDoc 1.3.7 发布,这是一款基于 React 的文档生成工具,只需要写Markdown 文件,即可帮助你生成静态页面,更详细的说明请参阅官方文档。 更新内容: #5 修复babel配置排除目录引发的问题以及依赖问题 更新babel preset 更新ESLint配置

2
19
2018/01/30 13:37

RDoc 1.3.4 发布,只需写 Markdown 即可生成网站

RDoc 1.3.4 发布,这是一款基于 React 的文档生成工具,只需要写Markdown 文件,即可帮助你生成静态页面,更详细的说明请参阅官方文档。 更新内容: 使用文档更新. dd5e8e1 修复与Mac上面自带的RDoc 工具冲突 43d4304

13
11
2018/01/23 09:18

RDoc 1.3.3 发布,兼容 Windows 系统下运行

RDoc 1.3.3 发布,这是一款基于 React 的文档生成工具,只需要写Markdown 文件,即可帮助你生成静态页面。 更新内容: 775b252 - 兼容Windows系统下运行.

9
3
发表于服务端专区
2018/01/21 22:46

RDoc 1.3.2 发布,只需写 Markdown 即可生成网站

RDoc 1.3.2 发布,这是一款基于 React 的文档生成工具。 主要用于快速生成文档工具或简单的网站,只需要写 Markdown 文件即可。 RDoc 1.3.2更新内容: npm 忽略.rdoc-dist目录上传。 662043c 修复Publish命令loading错误。 5f09dc2 RDoc 1.3.1更新内容: 添加编译loading效果. a00c941 修改开始命令. 826dfff 更新文档. 8fea0be...

6
9
2018/01/19 10:06

RDoc 1.3.0 发布,只需写 Markdown 即可生成网站

RDoc 1.2.3 发布,这是一款基于 React 的文档生成工具。 主要用于快速生成文档工具或简单的网站,只需要写 Markdown 文件即可。 更新内容: 编译之前清理编译输出文件夹. 5e23311 固定网站宽度. 9a24cd9 修复代码超出滚动条问题. 3059524 修复404页面错误问题. 066b51a 修改配置输出目录. 8a01ab4 优化菜单索引. b5d4590 修改编译目录。 89dadf2 修改网站背景问题。 dea31cf 更新大量文档。 78f4c7d 更新命令帮助文档。 6f3ea9...

6
15
发表于服务端专区
2018/01/17 19:47

RDoc 1.2.3 发布,只需写 Markdown 即可生成网站

RDoc 1.2.3 发布,这是一款基于 React 的文档生成工具。 主要用于快速生成文档工具或简单的网站,只需要写 Markdown 文件即可。 更新内容: 添加logo配置支持. 7237330 添加初始化项目依rdoc赖版本. 77b53af 修复webpack配置错误. 3d7f06b 更新 rdoc.png 8f580dd 优化 babel-loader 配置. c98a22f 优化webpack Markdown loader配置. cdac4d3 优化webpack JS相关 loader配置. 6114cee 网站设置文档更新. 9d4e667 添加博客文档更新...

7
17
2018/01/17 09:40

RDoc 1.2.1 发布,用于生成文档网站或简单的博客

RDoc 1.2.1 发布,这是一款基于 React 的文档生成工具。 主要用于快速生成文档工具或简单的网站,只需要写 Markdown 文件既可。 更新内容: 添加logo. 1b2c772 添加favicon.ico 64707d1 修复网站标题重复. 1b8282d 修复网站标题不存在的问题. 01dfba2 忽略dist目录. 2f6b8e9 修复菜单重定向问题. 9387fd7 菜单重定向优化. e7237cf 更改主题背景颜色. 8bc4d1d 更改主题页脚内容. a1f2cdc 更新文档描述. 28e7f4f...

4
12
没有更多内容
加载失败,请刷新页面
点击加载更多
加载中
下一页
发表了博客
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
发表了问答
{{o.pubDate | formatDate}}

{{formatAllHtml(o.title)}}

{{parseInt(o.replyCount) | bigNumberTransform}}
{{parseInt(o.viewCount) | bigNumberTransform}}
没有更多内容
暂无内容
4 评论
39 收藏
分享
OSCHINA
登录后可查看更多优质内容
返回顶部
顶部
返回顶部
顶部