rtfd

构建文档的命令工具
授权协议 BSD-3-Clause
开发语言 Google Go
所属分类 开发工具、 程序文档工具
软件类型 开源软件
地区 国产
投 递 者 黄跃
操作系统 Linux
开源组织
适用人群 未知
 软件概览

rtfd是一个基于sphinx来构建文档的命令工具,用来生成并阅读文档。

类似于 readthedocs.org 提供的服务,当然功能是比不上的,只是作为备用工具使用。

它源于我在readthedocs上遇到的致命问题以及一直想造这么个轮子的想法,在一个脚本的基础上,快速地加了其他代码,形成的一个命令行工具~~

只是,当你不想用或不能用readthedocs时,可以用它构建你的文档。

特性:

  • 使用简单,依靠命令行、API
  • 配置简单,rtfd配置依靠ini文件,构建文档时也支持直接写ini文件配置文档所需环境
  • 支持https(HTTP2、TLS1.3),支持自定义域名(包含HTTPS的支持)
  • 文档项目直接支持多语言(翻译)和多标签(版本),在页面右下角有按钮可以显示
  • 支持webhook触发、文档构建状态的徽章、文档单一版本等
  • 允许github公开仓库和私有仓库

目前相对于readthedocs不足的特性是:

  • 仅支持github
  • 不支持生成PDF、EPUB
  • 不支持添加翻译版本(目前翻译版本要求直接包含在文档中才行)
  • 不支持设置子项目、构建时环境变量等
  • RTF:Rich Text Format 富文本格式 RTFD:Rich Text Format Document RTF,富文本格式,是由微软公司开发的跨平台文档格式,大多数的文字处理软件都能读取和保存RTF文档。 首先它是一般来写字板的默认文档之一,但除了它以外,Word、WPS Office、Excel等都可以打开RTF格式的文件。它的打开速度快,rtf是一种非常流行的文件结构,而且无损害的

 相关资料
  • 前端构建工具指的是coolie-cli,基于 nodejs,是系统工具,安装之后会注册全局命令coolie。 工具全部源码均已开源(仓库:https://github.com/cooliejs/coolie-cli)。 coolie-cli 是前端构建工具,是前端工程化解决方案,不是编译工具 (常见问题:什么是编译,什么是构建)。 全局命令 ➜ coolie

  • 所有的构建命令,都会通过NPM脚本执行。 npm run dev 启动一个Node.js本地开发服务器。在 开发环境代理api中查看更多细节。 Webpack + vue-loader 来处理Vue单文件组件 状态支持热更新 状态支持浮层显示编译错误 在保存的时候,通过ESLint做语法检测 可以开启Source maps npm run build 构建生产环境的资源. 在 整合后端框架 查看更

  • 初始化 在前端根目录,可以使用命令生成配置文件模板: ➜ coolie init -c ╔══════════════════════════════════════════════════════╗ ║ coolie@1.1.1 ║ ║ The front-end development builder.

  • Beta 阶段 介绍 coolie-cli 中间件作用于构建工具构建的不同阶段。 中间件必须是一个同步函数,该函数在构建阶段会接受到一个配置参数options: function coolieMiddlewareSample(options) { // ... do } 中间件忽略处理,需要原样返回 options 对象。 function coolieMiddlewareSample(

  • 文档是任何项目的必需品。 文档在维护项目中起着重要作用。 Java通过使用内置的javadoc工具使文档更容易。 通过按需生成文档,Ant使其变得更加容易。 如您所知,javadoc工具非常灵活,允许许多配置选项。 Ant通过javadoc任务公开这些配置选项。 如果您不熟悉javadoc,我们建议您从本Java Documentation Tutorial开始 。 以下部分列出了Ant中使用的最