程序文档工具Slate、Docsify、API-doc、gitdocument介绍

以下为你介绍的程序文档工具都可用在Linux系统上:Slate(API 文档生成器)、Docsify(神奇的文档生成工具)、API-doc(RESTful API 文档生成工具)、gitdocument(基于markdown的在线文档自动化构建服务)。

1、Slate(API 文档生成器)

程序文档工具Slate、Docsify、API-doc、gitdocument介绍

Slate 可帮助您创建美观,智能,响应式的 API 文档。

具有以下特性:

干净、直观的设计。

支持 Markdown 语法。

有多种编程语言的代码示例。

开箱即用的语法高亮功能,支持超过 100 种语言,无需配置。

目前仅支持 Linux 以及 OS X,在 Windows 上可能可以运行,但官方不支持。

设定:

在GitHub上分叉此存储库。

使用git clone https://github.com/YOURUSERNAME/slate.git将您的分叉存储库(不是我们的原始存储库)复制到硬盘上。

cd slate

初始化并启动Slate,您可以在本地执行此操作,也可以使用Vagrant:

#运行此命令以在本地运行

bundle install

bundle exec middleman server

#或运行此命令与vagrant一起运行

vagrant up

您现在可以在http://localhost:4567上查看文档。

下载地址:https://gitee.com/mirrors/slate

2、Docsify(神奇的文档生成工具)

程序文档工具Slate、Docsify、API-doc、gitdocument介绍

Docsify-一个神奇的文档网站生成工具。

是什么:

docsify 是一个动态生成文档网站的工具。不同于 GitBook、Hexo 的地方是它不会生成将 .md 转成 .html 文件,所有转换工作都是在运行时进行。

这将非常实用,如果只是需要快速的搭建一个小型的文档网站,或者不想因为生成的一堆 .html 文件“污染” commit 记录,只需要创建一个 index.html 就可以开始写文档而且直接部署在 GitHub Pages。

特性:

无需构建,写完文档直接发布。

容易使用并且轻量 (~18kB gzipped)。

智能的全文搜索。

提供多套主题。

丰富的 API。

支持 Emoji。

与IE11兼容及兼容 IE11+。

支持 SSR。

支持嵌入式文件。

下载地址:https://gitee.com/mirrors/docsify

3、API-doc(RESTful API 文档生成工具)

RESTful API 标准文档生成工具,可生成直观的HTML形式、PDF格式的文档,方便API开发者查阅。

1].遵循OpenAPI规范编写RESTful API的接口定义。

2].生成直观的HTML和PDF格式的文档。

3].对中文的完美支持,解决asciidoctor生成中文时的乱码问题。

HTML格式的文档截图:

程序文档工具Slate、Docsify、API-doc、gitdocument介绍

PDF格式文档截图:

程序文档工具Slate、Docsify、API-doc、gitdocument介绍

下载地址:https://gitee.com/mirrors/api-doc

4、gitdocument(基于markdown的在线文档自动化构建服务)

gitdocument是一个基于git的markdown在线文档自动化构建服务,支持文档索引和共享管理。

同时支持简单的搜索功能和代码高亮功能,提升阅读者的阅读体验。

作者只需要把自己的文档托管到git服务中,并按照如下格式存放indexes.json索引文件、md文件和img等其他资源文件:

程序文档工具Slate、Docsify、API-doc、gitdocument介绍

即可将文档在gitdocument服务中使用。

注明

以上就是程序文档工具Slate、Docsify、API-doc、gitdocument的介绍内容,这些程序文档工具都能使用在Linux操作系统中。

栏目相关文章