16
Slate-API的精美静态文档。功能干净，直观的设计—使用Slate，API的描述位于文档的左侧，而所有代码示例均位于右侧。受Stripe和Paypal的API文档启发。Slate具有响应能力，因此在平板电脑，手机甚至印刷品上看起来都很棒。一页上的所有内容—用户不得不搜索一百万个页面以查找所需内容的日子已经一去不复返了。Slate将整个文档放在单个页面上。不过，我们并未牺牲可链接性。滚动时，浏览器的哈希值将更新为最接近的标头，因此链接到文档中的特定点仍然很自然且容易。Slate就是Markdown —使用Slate编写文档时，您只是在编写Markdown，这使得编辑和理解变得简单。一切都用Markdown编写-甚至代码示例也只是Markdown代码块。用多种语言编写代码示例—如果您的API具有多种编程语言的绑定，则可以轻松地在选项卡中进行切换。在您的文档中，您将通过在每个代码块的顶部指定语言名称来区分不同的语言，就像Github Flavored Markdown一样。开箱即用的语法突出显示了将近60种语言，无需进行配置。自动，平滑滚动的目录位于页面最左侧。滚动时，它将显示您在文档中的当前位置。它也很快。我们在TripIt上使用Slate为新的API构建文档，其中目录包含180多个条目。我们确保即使对于较大的文档，其性能也保持出色。
slate-api-docs-generator
分类目录
Web版Slate API Docs Generator的替代品
11
