Slate API Docs Generator

Slate API Docs Generator
软件描述
创建美观、智能、响应式的 API 文档。
官方网站
访问软件的官方网站了解更多信息
github.com
什么是 Slate API Docs Generator?
Slate - 为您的 API 提供精美静态文档的工具。
特性
简洁直观的设计 —— 使用 Slate,API 描述位于文档左侧,所有代码示例位于右侧。设计灵感来自 Stripe 和 PayPal 的 API 文档。Slate 响应式布局,在平板、手机甚至打印时均表现良好。
全部内容集中于单页 —— 用户不再需要在成百上千页面中搜索所需内容。Slate 将整个文档整合在一页中。我们并未牺牲链接功能:滚动时浏览器哈希值会自动更新至最近的标题,因此仍可自然便捷地链接到文档中的特定位置。
Slate 仅需 Markdown —— 使用 Slate 编写文档时,只需编写 Markdown,简单易用且易于理解。所有内容均以 Markdown 格式编写,包括代码示例也仅为 Markdown 代码块。
支持多种语言的代码示例 —— 若您的 API 支持多种编程语言,可轻松添加标签页进行切换。在文档中,通过在每个代码块顶部标明语言名称即可区分不同语言,方式与 GitHub 风格 Markdown 一致。
开箱即用,支持近 60 种语言的语法高亮,无需任何配置。
页面最左侧自动显示平滑滚动的目录。滚动时实时显示当前位置。性能出色,即使在包含超过 180 个条目的大型文档中(如 TripIt 新 API 文档)也能保持流畅。
🔄 替代方案
29 个选择
ReadMe
ReadMe 是一个完全可定制且支持协作的动态 API 和/或产品文档空间。用户可以直接在文档中试用 API,这些文档由 Swagger / OAS 文件自动生成。它也可作为知识库平台使用。

Natural Docs
Natural Docs 是一种用于多种编程语言的开源文档生成工具。您可以用类似自然英语的语法来注释代码,Natural Docs 会扫描您的代码并生成高质量的 HTML 文档。

DoxyS
DoxyS 是 C++/C 的代码文档生成工具。DoxyS 致力于生成外观非常专业的输出,以结构化、易于导航的 HTML 页面展示代码。使用简单:只需进入代码根目录,输入 doxys 即可。

ApiGen
ApiGen 是一款从 PHP 源代码生成专业 API 文档的工具,类似于 phpDocumentor 2。

CppDoc
CppDoc 根据您的源代码以及其中嵌入的特殊注释,为 C++ 类生成 HTML 文档。它可生成与 Javadoc 输出非常相似的结果,并支持 @see、@return 等 Javadoc 标签。

dAPI
Node.js/JavaScript Dojo API 浏览器及静态 API 文档生成器。

Docma
Docma 是一个功能强大的工具,可轻松从 JavaScript(JSDoc)、Markdown 和 HTML 文件生成美观的 HTML 文档。
