石板，创建漂亮、响应性强的API文档

干净、直观的设计--在Slate中，API的描述在文档的左侧，所有的代码示例都在右侧。灵感来自条纹和贝宝的API文档。Slate反应灵敏，所以它在平板电脑、手机上，甚至在印刷版上看起来都很棒。

所有东西都在一个页面上-用户必须在一百万个页面中搜索才能找到他们想要的东西的日子已经一去不复返了。Slate将整个文档放在一页上。不过，我们并没有牺牲链接性。当您滚动时，浏览器的散列将更新到最近的标题，因此链接到文档中的特定点仍然是自然而简单的。

Slate就是Markdown--当您使用Slate编写文档时，您就是在编写Markdown，这使得编辑和理解变得简单。所有内容都是用Markdown编写的-即使是代码示例也只是Markdown代码块。

编写多种语言的代码示例--如果您的API具有多种编程语言的绑定，您可以很容易地在选项卡中进行切换。在您的文档中，您将通过在每个代码块的顶部指定语言名称来区分不同的语言，就像使用GitHub风格的Markdown一样。

自动、平滑地滚动页面最左侧的目录。当您滚动时，它会显示您在文档中的当前位置。它也很快。我们正在使用TripIt的Slate为我们的新API构建文档，我们的目录中有180多个条目。我们已确保性能保持优异，即使是较大的文档也是如此。

让您的用户为您更新文档-默认情况下，Slate生成的文档托管在公共GitHub存储库中。这不仅意味着您可以通过GitHub页面免费托管您的文档，而且还使得其他开发人员在发现打字错误或其他问题时可以很容易地向您的文档发出拉请求。当然，如果您不想使用GitHub，也欢迎您在其他地方托管您的文档。

RTL支持完全从右向左布局的RTL语言，如阿拉伯语、波斯语(波斯语)、希伯来语等。

开始使用Slate超级简单！只需按上面的绿色“使用此模板”按钮，然后按照下面的说明操作即可。或者，如果您想了解Slate的功能，请看一下示例文档。

如果您有关于安装、部署、特殊功能实现方面的问题，或者只是想与开发人员聊天，请随时在我们的讨论选项卡中创建一个主题！

发现上游Slate有漏洞吗？请继续提交一期。当然，您可以随时向dev分支提交带有错误修复或更改的拉取请求。

石板是罗伯特·洛德在TripIt时建造的。该项目现在由马修·皮夫勒(Matthew Peveler)和迈克·拉尔夫森(Mike Ralphson)维护。