Slate

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

特色功能

• 简洁、直观的设计 — 使用 Slate，API 描述显示在文档的左侧，所有代码示例显示在右侧。灵感来源于 Stripe 和 PayPal 的 API 文档。Slate 是响应式的，因此在平板电脑、手机甚至印刷品中都会有美观的效果。

• 所有内容都在一个页面 — 用户再也不用翻阅大量页面才能找到所需内容了。Slate 将所有文档内容都放在同一个页面中。但我们并未牺牲链接性。在滚动时，浏览器的哈希将更新到最近的标题，因此链接到文档中的特定点仍然很自然也很容易。

• Slate 仅是 Markdown — 使用 Slate 编写文档时，你只需编写 Markdown，编辑和理解都很直观。一切内容都以 Markdown 编写 — 即使代码示例也仅仅是 Markdown 代码块。

• 使用多种语言编写代码示例 — 如果你的 API 具有多种编程语言的绑定，则你可以轻松地添加标签页在它们之间切换。在文档中，你可以通过在每个代码块顶部指定语言名称来区分不同的语言，就像使用 GitHub 风格标记一样。

• 即开即用语法高亮，支持 100 多种语言，无需任何配置。

• 自动平滑滚动的目录位于页面的最左侧。在滚动时，它会显示你在文档中的当前位置。它也很快速。我们在 TripIt 中使用 Slate 为我们的新 API 构建文档，其中目录有 180 多个条目。即使对于较大的文档，我们也确保性能卓越。

• 让您的用户来更新您的文档 ——默认情况下，您的 Slate 生成的文档会托管在一个公共 GitHub 存储库中。这不仅意味着您可以利用 GitHub Pages 为您的文档获取免费托管，而且如果其他开发人员在文档中发现了错别字或其他问题，那么也能够轻松地向您的文档提交拉取请求。当然，如果您不想使用 GitHub，那么也可以将您的文档托管到其他地方。

• RTL 支持 针对阿拉伯语、波斯语 (法语)、希伯来语等 RTL 语言的完全从右到左布局。

使用 Slate 超级简单！只需复制此存储库并按照下面的说明进行操作。或者，如果您想了解 Slate 的功能，请查看 示例文档。