使用Gulp,Jekyll和markdow构建API文档的站点

时间:2015-05-28 17:29:09

标签: api gulp markdown jekyll liquid-layout

我正在使用Gulp,Jekyll和markdown为API文档构建网站。

我有两个API部分,例如用户角色,每个部分都有以下API端点:

  • 列出资源字段
  • 列出所有项目
  • 查看单项
  • 创建新项目
  • 更新项目
  • 删除项目

为实现这一目标,我在

下创建了文件
  

用户/ _posts / YYYY-MM-DD-ALL_FILE_NAME.markdown

     

角色/ _posts / YYYY-MM-DD-ALL_FILE_NAME.markdown

_posts 文件夹中的

我为每个API终点创建了六个文件(意味着_post文件夹中共有12个文件)。这对我有用,创建了左导航(两个标题用户角色和六个六个子标题,用于上述API端点)并呈现两个部分的内容和自动滚动也有效。

现在我的问题是,如何通过仅创建两个文件而不是12个单独的文件来获得相同的功能?

  

users / _posts / YYYY-MM-DD-users.markdown(包含用户的所有六个终点内容)

     

roles / _posts / YYYY-MM-DD-roles.markdown(包含角色的所有六个终点内容)

0 个答案:

没有答案