Skip to content

treehole api 文档

zhangyw edited this page Jul 17, 2017 · 1 revision

对于 TreeHole 主题开发来说,我们必须先要了解一下所有 API 接口。 本系统在 API 的设计上尽最大的努力像 jekyll 靠近,但是毕竟是不同的系统,所以差别还是有的。下边将详细介绍 treehole 的所有接口。

基础概念

  • site: 博客系统信息,以及主题中 _config.yml 配置文件中的配置信息。
  • page: 页面信息,包含页面信息。
  • post: 文章信息

具体信息

site

  • name: 网站名称
  • desc: 网站简介
  • time: 打开页面的时间
  • theme: 当前使用主题信息
  • links: 所有友链信息
  • tags: 标签信息
  • categories: 分类信息

page

  • title 当前页面的标题
  • url 当前地址
  • description 当前页的描述
  • relatedPosts 相关文章,与当前文章分类相同的文章按时间排序的 top6

post

  • title 文章的标题
  • excerpt 文章摘要
  • content 文章内容
  • url 帖子以斜线打头的相对路径,例子: /articles/1
  • date 文章发表时间
  • id 文章唯一标识
  • categories 文章分类信息
  • tags 文章标签列表
  • path 帖子以斜线打头的相对路径,例子: /articles/1
Clone this wiki locally