Jekyll cheatsheet

# 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

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

Variable	Description
{{ site }}	Data from config.yml
{{ page }}	From frontmatter, and page-specific info
{{ content }}	HTML content (use in layouts)
{{ paginator }}	Paginator

See: Variables

{{ site.time }}

Variable	Description
site.time	Current time
site.pages	List of pages
site.posts	List of blog posts
site.related_posts	List of posts related to current
site.categories.CATEGORY	List
site.tags.TAG	List
site.static_files	List

{{ 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 }}

Add this to _config.yml:

paginate: 5
paginate_path: "blog/:num"

See: Paginator

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

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

{% 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 }}

_posts/YEAR-MONTH-DAY-title.md

See: Blogging

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

See: Image paths

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

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

---
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

{{ post.excerpt }}

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

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

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

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

# _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

_data/members.yml

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

See: Data

# _config.yml
collections:
  - authors

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

{% for author in site.authors %}

See: Collections

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

In _plugins/bundler.rb:

require "bunder/setup"
Bundler.require :default

• Compass
• Asset pipeline