slate
slate 介绍
slate 配置简单、干净,直观的设计、上手快 。您使用Slate编写文档时,您只需编写Markdown,这使编辑和理解变得简单。一切都是用Markdown编写的 - 即使代码示例只是Markdown代码块。如果您的API具有多种编程语言的绑定,您可以轻松地在选项卡中切换它们。
默认情况下,您的Slate生成的文档托管在公共GitHub存储库中。这不仅意味着您可以通过GitHub页面免费托管您的文档,而且还可以让其他开发人员在发现拼写错误或其他问题时向您的文档提出拉取请求。当然,如果您不想使用GitHub,也欢迎您在其他地方托管您的文档。
使用前:
Linux或macOS - Windows可能有效,但不受支持。
Ruby,2.3.1或更新版本
Bundler - 如果已经安装了Ruby,但bundle命令不起作用,只需gem install bundler在终端中运行即可。
网站地址:https://spectrum.chat/slate
GitHub:https://github.com/lord/slate
网站描述:漂亮的API文档生成工具