开发者.github.com
这是一个使用构建的 GitHub API 资源。
设置
构建站点需要 Ruby 1.9。
获取 nanoc gem,以及用于降价解析的 kramdown:
bundle install
您可以使用 nanoc 查看可用命令:
nanoc -h
Nanoc 有可以帮助您入门。 但是,如果您主要关注编辑或添加内容,则不需要对 nanoc 了解太多。
时尚指南
不确定如何构建文档? API 文档的结构如下所示:
# API title
## API endpoint title
[VERB] /path/to/endpoint.json
### Parameters
name
: description
### Input (request json body)
<%= json :field => "sample value" %>
###