RDoc-cli

基于 React 的文档生成工具
授权协议 MIT
开发语言 JavaScript HTML/CSS
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 漆雕和昶
操作系统 跨平台
开源组织
适用人群 未知
 软件概览

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
  • Mac OS 10.11 终端:$ sudo gem install fir-cli --no-ri --no-rdoc 报错: ERROR:  While executing gem ... (Errno::EPERM)     Operation not permitted - /usr/bin/restclient 查看gem 环境:gem environment RubyGems Envi

  • 首先要说明的是bosh cli既可以装在服务器上也可以装在虚拟机中。 所有的操作都是通过bosh cli完成的,如安装bosh的时候bosh cli先target到micro bosh,安装cloudfoundry的时候是bosh cli要target到bosh 的director。 我是在虚拟机中装的的bosh cli,操作系统是ubuntu。 1. 安装cli的前提条件,必须先安装下面的包 $

  •        上一篇介绍了ubuntu10.04的系统安装以后的一些问题,本编主要着重介绍安装依耐包的安装,使用ruby的工具bundler来完成这个任务。        首先参考 http://blog.csdn.net/kent45/article/details/16883747 完成ruby的安装以及rvm的安装。        1.$sudo apt-get -y install lib

 相关资料
  • 我使用的是Swashbuckle(5.3.2),它生成了一个很好的API文档。 PetController CarController WebApiConfig null 获取/api/pets post/api/pets 获取/api/pets/{id} carowner_api_key: 汽车 get/api/cars 邮政/API/CARS get/api/cars/{id} null nu

  • 在使用时,这些构建文件是否通常被隐藏?我之所以感到疑惑,是因为我想更改我创建的一个名称不佳的的名称,并发现这些文件中也引用了该名称。

  • 本文向大家介绍Python文档生成工具pydoc使用介绍,包括了Python文档生成工具pydoc使用介绍的使用技巧和注意事项,需要的朋友参考一下 在Python中有很多很好的工具来生成字符串文档(docstring),比如说: epydoc、doxygen、sphinx,但始终觉得pydoc还是不错的工具,用法非常简单,功能也算不错,本文主要介绍pydoc. pydoc是Python自带的模块,

  • 我有一个如下的房间模式: 它包含一个事件ID数组。事件架构: 我试过这样的东西: 但它当然不起作用(房间总是空数组)。我真的很难弄清楚。 如何查询具有基于子文档(事件)的条件的文档(房间)?

  • https://github.com/estan/protoc-gen-doc 这是一个Google Protocol Buffers编译器(protoc)的文档生成插件。这个插件可以从.proto文件中的注释内容生成HTML, DocBook 或者 Markdown 文档。 安装 参考 protoc-gen-doc Installation章节的信息。 linux安装 对于ubuntu系统,参考

  • easyopen提供一个简单的api文档查看页面,类似于swagger,基于注解功能来生成文档页面。生成的文档页面可以查看参数、结果说明,也可以进行模拟请求。对于前后端分离的项目来说会很有帮助。文档界面如下图所示: 左边的树形菜单对应文档名称,点击树可前往查看对应的接口说明。点击请求按钮可以发起请求进行测试。可修改业务参数中的值进行测试。 下面来讲解文档注解的使用方法。 文档页面默认是关闭的,需要