Jekyll cheatsheet

Installation

# Install the gems
gem install jekyll bundler

# Create a new site at `./myblog`
jekyll new myblog
cd myblog

# Optional: if you're targeting github-pages,
# use this Gemfile instead.
cat > Gemfile <<-END
source 'https://rubygems.org'
gem 'github-pages', group: :jekyll_plugins
END

bundle exec jekyll serve

See: Jekyll quickstart
See: github/pages-gem

Directories

./
├── _config.yml
│
├── _data/
│   └── ...
│
├── _drafts/
│   └── ...
│
├── _posts/
│   └── 2014-01-01-hello.md
│
├── _layouts/
│   ├── default.html
│   └── post.html
│
├── _includes/             - partials
│   ├── header.html
│   └── footer.html
│
└── _site/
    └── ...

Front-matter

Basic frontmatter

---
layout: post
title: Hello
---
Hello! this is my post.

Attach metadata to a page by adding them on top of the page, delimited by ---. See: Front-matter

Other frontmatter stuff

permalink: '/hello'
published: false
category: apple
categories: ['html', 'css']
tags: ['html', 'css']

Configuration

In _config.yml:

source: .
destination: _site
exclude:
- Gemfile
- Gemfile.lock
include: ['.htaccess']

All config keys are optional. See: Configuration

Markup

Page variables

<title>
  {{ page.title }}
</title>

Filters

<p>
  {{ page.description | truncate_words: 20 }}
</p>

Loops

{% for post in site.posts %}
  <a href="{{ post.url }}">
    <h2>{{ post.title }}</h2>
    <p>{{ post.date | date_to_string }}</h2>
  </a>
{% endfor %}

Dates

{{ page.date | date: "%b %d, %Y" }}

Conditionals

{% if page.image.feature %}
  ...
{% elsif xyz %}
  ...
{% else %}
  ...
{% endif %}

{% if page.category == 'React' %}
{% if page.category == 'React' or page.featured %}
{% if page.tags contains 'Featured' %}

Case

{% case shipping.title %}
  {% when 'international' %}
     Arriving in 2-3 weeks
  {% when 'Domestic' %}
     Arriving in 2-3 days
  {% else %}
     Thank you for your order!
{% endcase %}

Includes (partials)

{% include header.html %}

<!-- Including local vars -->
{% include header.html page=page %}

Comments

{% comment %}
  This is a comment!
{% endcomment %}

Variables

Top-level variables

See: Variables

Site

{{ site.time }}

Page

{{ page.content }}  - un-rendered content
{{ page.title }}
{{ page.excerpt }}  - un-rendered excerpt
{{ page.url }}
{{ page.date }}
{{ page.id }}       - unique id for RSS feeds
{{ page.categories }}
{{ page.tags }}
{{ page.path }}
{{ page.dir }}
{{ page.excerpt | remove: '<p>' | remove: '</p>' }}
{{ page.excerpt | strip_html }}

<!-- blog pagination: -->
{{ page.next }}
{{ page.previous }}

Filters

Dates

{{ site.time | date: "%Y %m %d" }}

Preprocessors

{{ page.description | markdownify }}

Array filters

{{ site.pages | where: "year", "2014" }}

String filters

{{ page.title | default: "xxx" }}

See: String filters

String filters (Jekyll-only)

{{ page.excerpt | number_of_words }}

Numbers

{{ site.posts.size | minus: 2 }}

Paginator

Paginator setup

Add this to _config.yml:

paginate: 5
paginate_path: "blog/:num"

See: Paginator

Numbers

{{ paginator.page }}         - page number
{{ paginator.total_posts }}
{{ paginator.total_pages }}
{{ paginator.per_page }}

Iterating through posts

{% for post in paginator.posts %} ... {% endfor %}

Previous button

{% if paginator.total_pages > 1 %}
  {% if paginator.previous_page %}
    <a href="{{ paginator.previous_page_path }}">Previous</a>
  {% else %}
  {% endif %}
{% endif %}

{{ paginator.next_page }}     - page number
{{ paginator.next_page_path }}

Blogging

Paths

_posts/YEAR-MONTH-DAY-title.md

See: Blogging

Image paths

![My helpful screenshot]({{ site.url }}/assets/screenshot.jpg)

See: Image paths

Drafts

vi _drafts/a-draft-post.md
jekyll build --drafts

Posts in _drafts only show up in development, but not production. See: Drafts

Defining excerpts

---
title: My blog post
excerpt: This post is about cats
---

Hello, let's talk about cats. (···)

Put a key excerpt in the frontmatter. See: Excerpts

Displaying excerpts

{{ post.excerpt }}

{{ post.excerpt | remove: '<p>' | remove: '</p>' }}
{{ post.excerpt | strip_html }}

Excerpt separator

---
excerpt_separator: <!--more-->
---

Excerpt here
<!--more-->
More post body here

Alternatively, you can put excerpts inline in your post by defining excerpt_separator.

Permalinks

# _config.yml
permalink: date   # /:categories/:year/:month/:day/:title.html
permalink: pretty # /:categories/:year/:month/:day/:title/
permalink: none   # /:categories/:title.html
permalink: "/:title"

See: Permalinks

More features

Data

_data/members.yml

{% for member in site.data.members %}
  ...
{% endfor %}

See: Data

Collections

# _config.yml
collections:
  - authors

# _/authors/a-n-roquelaire.md
---
name: A. N. Roquelaire
real_name: Anne Rice
---

{% for author in site.authors %}

See: Collections

Code highlighter

{% highlight ruby linenos %}
def show
  ...
end
{% endhighlight %}

Integration

Bundler

In _plugins/bundler.rb:

require "bunder/setup"
Bundler.require :default

Compass

• Compass
• Asset pipeline

Also see

• Jekyll docs jekyllrb.com
• CloudCannon Jekyll cheatsheet cloudcannon.com
• Jekyll: templates jekyllrb.com
• Liquid: output shopify.com
• Liquid: logic shopify.com
• Liquid: filters shopify.com
• Liquid for designers github.com/Shopify