Jekyll 模板 简单语法 笔记

目录结构

一般建议在每个目下建一个 index 文件。

Jekyll 的标准目录结构如下。

├── _config.yml
├── _includes/
├── _layouts/
├── _posts/
├── _site/
├── about/
|   └── index.html  # => http://tiankonguse.github.io/about/
├── contact/
|   └── index.html  # => http://tiankonguse.github.io/contact/
└── index.html      # => http://tiankonguse.github.io/

• _config.yml Jekyll的配置文件

  _includes文件夹中所放的文件是最终要放到模版中的一些代码片段。

• _includes include 文件所在的文件夹

  _layouts中放的一些模版，模版是用包含page或post内容的。Jekyll的模版使用HTML语法来写，并包含YAML Front Matter。

  所有的模版都可用Liquid来与网站进行交互。

  所的的模版都可以使用全局变量site和page

  site变量包含该网站所有可以接触得到的内容和元数据(meta-data)

  page变量包含的是当前渲染的page或post的所有可以接触得到的数据。

• _layouts 模版文件夹

• _posts 自己要发布的内容

  _post文件夹中放的是自己要发布的post文章。

  post文件的命名规则为YEAR-MONTH-DATE-title.MARKUP，使用rake post会自动将post文件命名合适。

  而对于page，所有放在根目录下或不以下划线开头的文件夹中有格式的文件都会被Jekyll处理成page。

  这里说的有格式是指文件含有YAML Front Matter。

  所有的post和page都要用markdown或者texile或者HTML语法来写，并可以包含Liquid模版的语法。

  还要有 YAML Front Matter (Jekyll只处理具有YAML Front Matter的文件)。

  YAML Front Matter必须放在文件的开头，一对—之间，用户可在这一对—间设置预先定义的变量或用户自己的数据

• _sites 预览时产生的文件都放在该文件夹中

全局变量

关于 jekyllrb 的变量文档，可以参考官方文档。

Site 变量

Page 变量

Paginator 变量

分页只在 html 页面中[^1]有效，所以对于 index 页面尽量使用 html 后缀。

Collections

官方有这么一句话：

Collections support is unstable and may change
This is an experimental feature and that the API may likely change until the feature stabilizes.

Data Files

Jekyll 支持 从 _data 目录中加载 YAML, JSON, 和 CSV 格式的文件数据。

例如创建 _data/members.yml 文件。

- name: 袁小康
  github: tiankonguse
  oldnick : shen1000
  nick : skyyuan

使用

<ul>
{% for member in site.data.members %}
  <li>
    <a href="https://github.com/{{ member.github }}">
    {% assign nick = member.nick %}
    {% assign name = member.name %}
      {{ nick}} ( {{name}} )
    </a>
  </li>
{% endfor %}
</ul>