Slate 魔法:让您的 API 文档更具吸引力
文章标签：
html免费模板下载
Slate 是开源的产品， 帮助创建美观、智能、响应式的 API 文档。
这个是一款可以直接使用md的方式编辑并产出响应式的API文档的工程。
先上一个默认的截图
下面将介绍如何创建自己的Slate，你不需要了解ruby以及开发相关的知识， 根据以下步骤执行， 最后修改工程中的md的文件即可。
- 创建自己的Github repo
使用官方源码为模版创建。
https://github.com/slatedocs/slate
- 下载到自己的git代码到本地。
- 电脑中准备环境
brew install ruby
sudo gem install bundler
sudo gem update --system 3.2.3- 进入到代码目录执行以下命令
安装依赖包
sudo bundle install - 运行
=> bundle exec middleman server
Calling `DidYouMean::SPELL_CHECKERS.merge!(error_name => spell_checker)' has been deprecated. Please call `DidYouMean.correct_error(error_name, spell_checker)' instead.
== The Middleman is loading
== Sprockets will render css with ruby sass
consider using Sprockets 4.x to render with SassC
== View your site at "http://localhost:4567", "http://127.0.0.1:4567"
== Inspect your site configuration at "http://localhost:4567/__middleman", "http://127.0.0.1:4567/__middleman"这时可以开启浏览器开启http://127.0.0.1:4567后即可查看到对应的页面了。
- 生成静态文件。
bundle exec middleman build --clean将生成静态的index.html的文件，可以将对应 的build 文件夹部署到对应的环境中， 即可对外公开API档案了。
简单介绍一下， 当工程搭建起来后， 你可以通过修改source文件夹中的index.html.md的文件来编写主API文件， 当然也可以根据需要自行拆分不同的md， 拆分的MD文件可以放到includes的文件夹内,并index.html.md重includes 对应的文件名。
layouts/layout.erb 文件，框架文件， 可以修改logo，标题等内容， 如果不了解语法，只需要有基本的html的经验， 参考原来写法改动即可。
整体上， 该工具提供较为便利并通过MD的方式来维护API文档的方法。