前言

今天跟大家分享一个写接口文档的工具slate，从此告别用word写接口文档。

环境要求

• Linux 或者 macOS 。Windows 可以工作，但是不支持。（我是在macOS中用的）
• Ruby版本>2.3.1
• Bundler，如果你已经安装了ruby但是bundler没有办法运行，你需要执行gem install bundler

安装

1.git clone https://github.com/lord/slate.git
2.cd slate && bundle install
3.bundle exec middleman server
这样访问127.0.0.1:4567,就可以看到初始化的slate文档页面了，接下来你就可以在这个基础上修改成自己的文档了

文档编写

slate目录结构如下：

image.png

我们的工作就是在include文件夹中的添加.md文件，一般一级标题为模块名称，一个模块一个文件。命名方式采用_xxx.md。并将这些文件名添加到index.html.md的include下边，这样我们的文档就编写完了。整个文档的编写是基于markdown语法的，至于每个.md如何编写可以参考例子中的_errors.md。

文档发布

执行slate文件夹下的deploy.sh脚本，会生成一个build文件夹，这个文件夹就是我们的离线文档了。