README

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

上面的示例是用 Slate 创建的。请访问 lord.github.io/slate 查看更多。

功能

简洁直观的设计 — 使用 Slate，您的 API 描述位于文档的左侧，所有代码示例都在右侧。灵感来自 Stripe 和 Paypal 的 API 文档。Slate 是响应式的，因此它在平板电脑、手机甚至打印版上看起来都很棒。
单页显示所有内容 — 那些用户需要翻阅成千上万页才能找到所需内容的时代已经过去。Slate 将整个文档都放在一个页面上。但我们没有牺牲链接性。当您滚动时，浏览器的哈希值会更新到最近的标题，因此链接到文档中的特定点仍然自然且简单。
Slate 就是 Markdown — 当您使用 Slate 编写文档时，您只是在编写 Markdown，这使得它易于编辑和理解。一切都是用 Markdown 编写的 — 即使是代码示例也只是 Markdown 代码块。
用多种语言编写代码示例 — 如果您的 API 在多种编程语言中有绑定，您可以轻松地添加选项卡来在它们之间切换。在您的文档中，您可以通过在每个代码块顶部指定语言名称来区分不同的语言，就像在 Github Flavored Markdown 中一样。
为近 100 种语言提供开箱即用的语法高亮，无需配置。
页面左侧自动、平滑滚动的目录。当您滚动时，它显示文档中的当前位置。它也很快。我们在 TripIt 使用 Slate 来构建新 API 的文档，其中目录有超过 180 个条目。我们已经确保即使对于更大的文档，性能仍然出色。
让您的用户为您更新文档

Slate 入门超级简单！只需将此存储库分叉并按照下面的说明操作。或者，如果您想看看 Slate 能做什么，请查看示例文档。

Slate 入门

先决条件

您需要

Linux 或 OS X — Windows 可能可行，但不被支持。
Ruby，版本 2.0 或更高
Bundler — 如果 Ruby 已经安装，但 bundle 命令无法工作，请在终端中运行 gem install bundler。

准备设置

在 Github 上创建此仓库的分支。
使用 git clone https://github.com/YOURUSERNAME/slate.git 将您创建的分支（而不是我们的原始分支）克隆到您的硬盘上。
cd slate
初始化并启动 Slate。您可以在本地或使用 Vagrant 进行操作。

# either run this to run locally
bundle install
bundle exec middleman server

# OR run this to run with vagrant
vagrant up

现在您可以在 https://:4567 查看文档。哇！这真快！

现在 Slate 已经在您的机器上设置好了，您可能想了解更多关于编辑 Slate Markdown 或如何发布您的文档的信息。

如果您想使用 Docker，可以在维基上找到说明。

使用 Slate 的公司

您可以在维基上的列表中查看更多。

需要帮助？发现了错误？

如果您需要任何帮助，请向 Slate 的 Github 提交问题。当然，您也可以提交带有错误修复或更改的拉取请求。

贡献者

Slate 是由 Robert Lord 在 TripIt 实习期间开发的。

感谢以下人员提交了重要的拉取请求

此外，感谢 Sauce Labs 帮助赞助此项目。

smartbridge / slate

维护者

详情