RDoc-cli 基于 React 的文档生成工具开源项目

我要开发同款
匿名用户2018年01月17日
66阅读
开发技术JavaScriptHTML/CSS
所属分类程序文档工具、开发工具
授权协议MIT

作品详情

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,指定分支需要跟上参数 -bmaster 即可。

{  "scripts": {    "deploy": "rdoc --publish  -b master"    ...  },  ...}npm run deploy
声明:本文仅代表作者观点,不代表本站立场。如果侵犯到您的合法权益,请联系我们删除侵权资源!如果遇到资源链接失效,请您通过评论或工单的方式通知管理员。未经允许,不得转载,本站所有资源文章禁止商业使用运营!
下载安装【程序员客栈】APP
实时对接需求、及时收发消息、丰富的开放项目需求、随时随地查看项目状态

评论