Chapter 1.1 - Welcome

• So what is Jekyll, exactly?
• Helpful Hints

This site aims to be a comprehensive guide to Jekyll. We’ll cover topics such as getting your site up and running, creating and managing your content, customizing the way your site works and looks, deploying to various environments, and give you some advice on participating in the future development of Jekyll itself.

So what is Jekyll, exactly?

Jekyll is a simple, blog-aware, static site generator. It takes a template directory containing raw text files in various formats, runs it through a converter (like Markdown) and our Liquid renderer, and spits out a complete, ready-to-publish static website suitable for serving with your favorite web server. Jekyll also happens to be the engine behind GitHub Pages, which means you can use Jekyll to host your project’s page, blog, or website from GitHub’s servers for free.

Helpful Hints

Throughout this guide there are a number of small-but-handy pieces of information that can make using Jekyll easier, more interesting, and less hazardous. Here’s what to look out for.

If you come across anything along the way that we haven’t covered, or if you know of a tip you think others would find handy, please file an issue and we’ll see about including it in this guide.

Chapter 1.2 - Quick-start guide

For the impatient, here’s how to get a boilerplate Jekyll site up and running.

~ $ gem install jekyll
~ $ jekyll new myblog
~ $ cd myblog
~/myblog $ jekyll serve
# => Now browse to http://localhost:4000

If you wish to install jekyll into an existing directory, you can do so by running jekyll new . from within the directory instead of creating a new one. If the existing directory isn’t empty, you’ll also have to pass the --force option like so jekyll new . --force.

That’s nothing, though. The real magic happens when you start creating blog posts, using the front matter to control templates and layouts, and taking advantage of all the awesome configuration options Jekyll makes available.

If you’re running into problems, ensure you have all the requirements installed.

Chapter 1.3 - Basic Usage

The Jekyll gem makes a jekyll executable available to you in your Terminal window. You can use this command in a number of ways:

$ jekyll build
# => The current folder will be generated into ./_site

$ jekyll build --destination <destination>
# => The current folder will be generated into <destination>

$ jekyll build --source <source> --destination <destination>
# => The <source> folder will be generated into <destination>

$ jekyll build --watch
# => The current folder will be generated into ./_site,
#    watched for changes, and regenerated automatically.

Jekyll also comes with a built-in development server that will allow you to preview what the generated site will look like in your browser locally.

$ jekyll serve
# => A development server will run at http://localhost:4000/
# Auto-regeneration: enabled. Use `--no-watch` to disable.

$ jekyll serve --detach
# => Same as `jekyll serve` but will detach from the current terminal.
#    If you need to kill the server, you can `kill -9 1234` where "1234" is the PID.
#    If you cannot find the PID, then do, `ps aux | grep jekyll` and kill the instance. [Read more](http://unixhelp.ed.ac.uk/shell/jobz5.html).

$ jekyll serve --no-watch
# => Same as `jekyll serve` but will not watch for changes.

These are just a few of the available configuration options. Many configuration options can either be specified as flags on the command line, or alternatively (and more commonly) they can be specified in a _config.yml file at the root of the source directory. Jekyll will automatically use the options from this file when run. For example, if you place the following lines in your _config.yml file:

source:      _source
destination: _deploy

Then the following two commands will be equivalent:

$ jekyll build
$ jekyll build --source _source --destination _deploy

For more about the possible configuration options, see the configuration page.

If you’re interested in browsing these docs on-the-go, install the jekyll-docs gem and run jekyll docs in your terminal.

Chapter 1.4 - Directory structure

Jekyll is, at its core, a text transformation engine. The concept behind the system is this: you give it text written in your favorite markup language, be that Markdown, Textile, or just plain HTML, and it churns that through a layout or series of layout files. Throughout that process you can tweak how you want the site URLs to look, what data gets displayed in the layout, and more. This is all done through editing text files, and the static web site is the final product.

A basic Jekyll site usually looks something like this:

.
├── _config.yml
├── _drafts
|   ├── begin-with-the-crazy-ideas.textile
|   └── on-simplicity-in-technology.markdown
├── _includes
|   ├── footer.html
|   └── header.html
├── _layouts
|   ├── default.html
|   └── post.html
├── _posts
|   ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
|   └── 2009-04-26-barcamp-boston-4-roundup.textile
├── _data
|   └── members.yml
├── _site
├── .jekyll-metadata
└── index.html

An overview of what each of these does:

Chapter 1.5 - Configuration

• Configuration Settings
  • Global Configuration
  • Build Command Options
  • Serve Command Options
• Custom WEBRick Headers
  • Defaults
• Specifying a Jekyll environment at build time
• Front Matter defaults
• Default Configuration
• Markdown Options
  • Redcarpet
  • Kramdown
  • Custom Markdown Processors
• Incremental Regeneration

Jekyll allows you to concoct your sites in any way you can dream up, and it’s thanks to the powerful and flexible configuration options that this is possible. These options can either be specified in a _config.yml file placed in your site’s root directory, or can be specified as flags for the jekyll executable in the terminal.

Configuration Settings

Global Configuration

The table below lists the available settings for Jekyll, and the various options (specified in the configuration file) and flags (specified on the command-line) that control them.

Build Command Options

Serve Command Options

In addition to the options below, the serve sub-command can accept any of the options for the build sub-command, which are then applied to the site build which occurs right before your site is served.

Custom WEBRick Headers

You can provide custom headers for your site by adding them to _config.yml

# File: _config.yml
webrick:
  headers:
    My-Header: My-Value
    My-Other-Header: My-Other-Value

Defaults

We only provide one default and that’s a Content-Type header that disables caching in development so that you don’t have to fight with Chrome’s aggressive caching when you are in development mode.

Specifying a Jekyll environment at build time

In the build (or serve) arguments, you can specify a Jekyll environment and value. The build will then apply this value in any conditional statements in your content.

For example, suppose you set this conditional statement in your code:

{% if jekyll.environment == "production" %}
   {% include disqus.html %}
{% endif %}

When you build your Jekyll site, the content inside the if statement won’t be run unless you also specify a production environment in the build command, like this:

JEKYLL_ENV=production jekyll build

Specifying an environment value allows you to make certain content available only within specific environments.

The default value for JEKYLL_ENV is development. Therefore if you omit JEKYLL_ENV from the build arguments, the default value will be JEKYLL_ENV=development. Any content inside {% if jekyll.environment == "development" %} tags will automatically appear in the build.

Your environment values can be anything you want (not just development or production). Some elements you might want to hide in development environments include Disqus comment forms or Google Analytics. Conversely, you might want to expose an “Edit me in GitHub” button in a development environment but not include it in production environments.

By specifying the option in the build command, you avoid having to change values in your configuration files when moving from one environment to another.

Front Matter defaults

Using YAML Front Matter is one way that you can specify configuration in the pages and posts for your site. Setting things like a default layout, or customizing the title, or specifying a more precise date/time for the post can all be added to your page or post front matter.

Often times, you will find that you are repeating a lot of configuration options. Setting the same layout in each file, adding the same category - or categories - to a post, etc. You can even add custom variables like author names, which might be the same for the majority of posts on your blog.

Instead of repeating this configuration each time you create a new post or page, Jekyll provides a way to set these defaults in the site configuration. To do this, you can specify site-wide defaults using the defaults key in the _config.yml file in your projects root directory.

The defaults key holds an array of scope/values pairs that define what defaults should be set for a particular file path, and optionally, a file type in that path.

Let’s say that you want to add a default layout to all pages and posts in your site. You would add this to your _config.yml file:

defaults:
  -
    scope:
      path: "" # an empty string here means all files in the project
    values:
      layout: "default"

Here, we are scoping the values to any file that exists in the scopes path. Since the path is set as an empty string, it will apply to all files in your project. You probably don’t want to set a layout on every file in your project - like css files, for example - so you can also specify a type value under the scope key.

defaults:
  -
    scope:
      path: "" # an empty string here means all files in the project
      type: "posts" # previously `post` in Jekyll 2.2.
    values:
      layout: "default"

Now, this will only set the layout for files where the type is posts. The different types that are available to you are pages, posts, drafts or any collection in your site. While type is optional, you must specify a value for path when creating a scope/values pair.

As mentioned earlier, you can set multiple scope/values pairs for defaults.

defaults:
  -
    scope:
      path: ""
      type: "posts"
    values:
      layout: "my-site"
  -
    scope:
      path: "projects"
      type: "pages" # previously `page` in Jekyll 2.2.
    values:
      layout: "project" # overrides previous default layout
      author: "Mr. Hyde"

With these defaults, all posts would use the my-site layout. Any html files that exist in the projects/ folder will use the project layout, if it exists. Those files will also have the page.author liquid variable set to Mr. Hyde as well as have the category for the page set to project.

collections:
  - my_collection:
      output: true

defaults:
  -
    scope:
      path: ""
      type: "my_collection" # a collection in your site, in plural form
    values:
      layout: "default"

In this example the layout is set to default inside the collection with the name my_collection.

Precedence

Jekyll will apply all of the configuration settings you specify in the defaults section of your _config.yml file. However, you can choose to override settings from other scope/values pair by specifying a more specific path for the scope.

You can see that in the second to last example above. First, we set the default layout to my-site. Then, using a more specific path, we set the default layout for files in the projects/ path to project. This can be done with any value that you would set in the page or post front matter.

Finally, if you set defaults in the site configuration by adding a defaults section to your _config.yml file, you can override those settings in a post or page file. All you need to do is specify the settings in the post or page front matter. For example:

# In _config.yml
...
defaults:
  -
    scope:
      path: "projects"
      type: "pages"
    values:
      layout: "project"
      author: "Mr. Hyde"
      category: "project"
...

# In projects/foo_project.md
---
author: "John Smith"
layout: "foobar"
---
The post text goes here...

The projects/foo_project.md would have the layout set to foobar instead of project and the author set to John Smith instead of Mr. Hyde when the site is built.

Default Configuration

Jekyll runs with the following configuration options by default. Alternative settings for these options can be explicitly specified in the configuration file or on the command-line.

# Where things are
source:       .
destination:  ./_site
plugins_dir:  ./_plugins
layouts_dir:  ./_layouts
data_dir:     ./_data
includes_dir: ./_includes
collections:  null

# Handling Reading
safe:         false
include:      [".htaccess"]
exclude:      []
keep_files:   [".git", ".svn"]
encoding:     "utf-8"
markdown_ext: "markdown,mkdown,mkdn,mkd,md"

# Filtering Content
show_drafts: null
limit_posts: 0
future:      false
unpublished: false

# Plugins
whitelist: []
gems:      []

# Conversion
markdown:    kramdown
highlighter: rouge
lsi:         false
excerpt_separator: "\n\n"
incremental: false

# Serving
detach:  false
port:    4000
host:    127.0.0.1
baseurl: "" # does not include hostname

# Outputting
permalink:     date
paginate_path: /page:num
timezone:      null

quiet:    false
defaults: []

# Markdown Processors
rdiscount:
  extensions: []

redcarpet:
  extensions: []

kramdown:
  auto_ids:       true
  footnote_nr:    1
  entity_output:  as_char
  toc_levels:     1..6
  smart_quotes:   lsquo,rsquo,ldquo,rdquo
  enable_coderay: false

  coderay:
    coderay_wrap:              div
    coderay_line_numbers:      inline
    coderay_line_number_start: 1
    coderay_tab_width:         4
    coderay_bold_every:        10
    coderay_css:               style

Markdown Options

The various Markdown renderers supported by Jekyll sometimes have extra options available.

Redcarpet

Redcarpet can be configured by providing an extensions sub-setting, whose value should be an array of strings. Each string should be the name of one of the Redcarpet::Markdown class’s extensions; if present in the array, it will set the corresponding extension to true.

Jekyll handles two special Redcarpet extensions:

• no_fenced_code_blocks — By default, Jekyll sets the fenced_code_blocks extension (for delimiting code blocks with triple tildes or triple backticks) to true, probably because GitHub’s eager adoption of them is starting to make them inescapable. Redcarpet’s normal fenced_code_blocks extension is inert when used with Jekyll; instead, you can use this inverted version of the extension for disabling fenced code.

Note that you can also specify a language for highlighting after the first delimiter:

    ```ruby
    # ...ruby code
    ```

With both fenced code blocks and highlighter enabled, this will statically highlight the code; without any syntax highlighter, it will add a class="LANGUAGE" attribute to the <code> element, which can be used as a hint by various JavaScript code highlighting libraries.

• smart — This pseudo-extension turns on SmartyPants, which converts straight quotes to curly quotes and runs of hyphens to em (---) and en (--) dashes.

All other extensions retain their usual names from Redcarpet, and no renderer options aside from smart can be specified in Jekyll. A list of available extensions can be found in the Redcarpet README file. Make sure you’re looking at the README for the right version of Redcarpet: Jekyll currently uses v3.2.x. The most commonly used extensions are:

• tables
• no_intra_emphasis
• autolink

Kramdown

In addition to the defaults mentioned above, you can also turn on recognition of GitHub Flavored Markdown by passing an input option with a value of “GFM”.

For example, in your _config.yml:

kramdown:
  input: GFM

Incremental Regeneration

Incremental regeneration helps shorten build times by only generating documents and pages that were updated since the previous build. It does this by keeping track of both file modification times and inter-document dependencies in the .jekyll-metadata file.

Under the current implementation, incremental regeneration will only generate a document or page if either it, or one of its dependencies, is modified. Currently, the only types of dependencies tracked are includes (using the {% include %} tag) and layouts. This means that plain references to other documents (for example, the common case of iterating over site.posts in a post listings page) will not be detected as a dependency.

To remedy some of these shortfalls, putting regenerate: true in the front-matter of a document will force Jekyll to regenerate it regardless of whether it has been modified. Note that this will generate the specified document only; references to other documents’ contents will not work since they won’t be re-rendered.

Incremental regeneration can be enabled via the --incremental flag (-I for short) from the command-line or by setting incremental: true in your configuration file.

Chapter 2.1 - Front Matter

The front matter is where Jekyll starts to get really cool. Any file that contains a YAML front matter block will be processed by Jekyll as a special file. The front matter must be the first thing in the file and must take the form of valid YAML set between triple-dashed lines. Here is a basic example:

---
layout: post
title: Blogging Like a Hacker
---

Between these triple-dashed lines, you can set predefined variables (see below for a reference) or even create custom ones of your own. These variables will then be available to you to access using Liquid tags both further down in the file and also in any layouts or includes that the page or post in question relies on.

Predefined Global Variables

There are a number of predefined global variables that you can set in the front matter of a page or post.

Custom Variables

Any variables in the front matter that are not predefined are mixed into the data that is sent to the Liquid templating engine during the conversion. For instance, if you set a title, you can use that in your layout to set the page title:

<!DOCTYPE HTML>
<html>
  <head>
    <title>{{ page.title }}</title>
  </head>
  <body>
    ...

Predefined Variables for Posts

These are available out-of-the-box to be used in the front matter for a post.

Chapter 2.2 - Writing posts

One of Jekyll’s best aspects is that it is “blog aware”. What does this mean, exactly? Well, simply put, it means that blogging is baked into Jekyll’s functionality. If you write articles and publish them online, this means that you can publish and maintain a blog simply by managing a folder of text-files on your computer. Compared to the hassle of configuring and maintaining databases and web-based CMS systems, this will be a welcome change!

The Posts Folder

As explained on the directory structure page, the _posts folder is where your blog posts will live. These files are generally Markdown or HTML, but can be other formats with the proper converter installed. All posts must have YAML Front Matter, and they will be converted from their source format into an HTML page that is part of your static site.

Creating Post Files

To create a new post, all you need to do is create a new file in the _posts directory. How you name files in this folder is important. Jekyll requires blog post files to be named according to the following format:

YEAR-MONTH-DAY-title.MARKUP

Where YEAR is a four-digit number, MONTH and DAY are both two-digit numbers, and MARKUP is the file extension representing the format used in the file. For example, the following are examples of valid post filenames:

2011-12-31-new-years-eve-is-awesome.md
2012-09-12-how-to-write-a-blog.textile

Content Formats

All blog post files must begin with YAML Front Matter. After that, it’s simply a matter of deciding which format you prefer. Jekyll supports Markdown out of the box, and has myriad extensions for other formats as well, including the popular Textile format. These formats each have their own way of marking up different types of content within a post, so you should familiarize yourself with these formats and decide which one best suits your needs.

Including images and resources

Chances are, at some point, you’ll want to include images, downloads, or other digital assets along with your text content. While the syntax for linking to these resources differs between Markdown and Textile, the problem of working out where to store these files in your site is something everyone will face.

Because of Jekyll’s flexibility, there are many solutions to how to do this. One common solution is to create a folder in the root of the project directory called something like assets or downloads, into which any images, downloads or other resources are placed. Then, from within any post, they can be linked to using the site’s root as the path for the asset to include. Again, this will depend on the way your site’s (sub)domain and path are configured, but here are some examples (in Markdown) of how you could do this using the site.url variable in a post.

Including an image asset in a post:

... which is shown in the screenshot below:
![My helpful screenshot]({{ site.url }}/assets/screenshot.jpg)

Linking to a PDF for readers to download:

... you can [get the PDF]({{ site.url }}/assets/mydoc.pdf) directly.

Displaying an index of posts

It’s all well and good to have posts in a folder, but a blog is no use unless you have a list of posts somewhere. Creating an index of posts on another page (or in a template) is easy, thanks to the Liquid template language and its tags. Here’s a basic example of how to create a list of links to your blog posts:

<ul>
  {% for post in site.posts %}
    <li>
      <a href="{{ post.url }}">{{ post.title }}</a>
    </li>
  {% endfor %}
</ul>

Of course, you have full control over how (and where) you display your posts, and how you structure your site. You should read more about how templates work with Jekyll if you want to know more.

Note that the post variable only exists inside the for loop above. If you wish to access the currently-rendering page/posts’s variables (the variables of the post/page that has the for loop in it), use the page variable instead.

Post excerpts

Each post automatically takes the first block of text, from the beginning of the content to the first occurrence of excerpt_separator, and sets it as the post.excerpt. Take the above example of an index of posts. Perhaps you want to include a little hint about the post’s content by adding the first paragraph of each of your posts:

<ul>
  {% for post in site.posts %}
    <li>
      <a href="{{ post.url }}">{{ post.title }}</a>
      {{ post.excerpt }}
    </li>
  {% endfor %}
</ul>

Because Jekyll grabs the first paragraph you will not need to wrap the excerpt in p tags, which is already done for you. These tags can be removed with the following if you’d prefer:

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

If you don’t like the automatically-generated post excerpt, it can be explicitly overridden by adding an excerpt value to your post’s YAML Front Matter. Alternatively, you can choose to define a custom excerpt_separator in the post’s YAML front matter:

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

Excerpt
<!--more-->
Out-of-excerpt

You can also set the excerpt_separator globally in your _config.yml configuration file.

Completely disable excerpts by setting your excerpt_separator to "".

Also, as with any output generated by Liquid tags, you can pass the | strip_html filter to remove any html tags in the output. This is particularly helpful if you wish to output a post excerpt as a meta="description" tag within the post head, or anywhere else having html tags along with the content is not desirable.

Highlighting code snippets

Jekyll also has built-in support for syntax highlighting of code snippets using either Pygments or Rouge, and including a code snippet in any post is easy. Just use the dedicated Liquid tag as follows:

{% highlight ruby %}
def show
  @widget = Widget(params[:id])
  respond_to do |format|
    format.html # show.html.erb
    format.json { render json: @widget }
  end
end
{% endhighlight %}

And the output will look like this:

def show
  @widget = Widget(params[:id])
  respond_to do |format|
    format.html # show.html.erb
    format.json { render json: @widget }
  end
end

These basics should be enough to get you started writing your first posts. When you’re ready to dig into what else is possible, you might be interested in doing things like customizing post permalinks or using custom variables in your posts and elsewhere on your site.

Chapter 2.3 - Working with drafts

Drafts are posts without a date. They’re posts you’re still working on and don’t want to publish yet. To get up and running with drafts, create a _drafts folder in your site’s root (as described in the site structure section) and create your first draft:

|-- _drafts/
|   |-- a-draft-post.md

To preview your site with drafts, simply run jekyll serve or jekyll build with the --drafts switch. Each will be assigned the value modification time of the draft file for its date, and thus you will see currently edited drafts as the latest posts.

Chapter 2.4 - Creating pages

In addition to writing posts, another thing you may want to do with your Jekyll site is create static pages. By taking advantage of the way Jekyll copies files and directories, this is easy to do.

Homepage

Just about every web server configuration you come across will look for an HTML file called index.html (by convention) in the site’s root folder and display that as the homepage. Unless the web server you’re using is configured to look for some different filename as the default, this file will turn into the homepage of your Jekyll-generated site.

Where additional pages live

Where you put HTML or Markdown files for pages depends on how you want the pages to work. There are two main ways of creating pages:

• Place named HTML or Markdown files for each page in your site’s root folder.
• Create a folder in the site’s root for each page, and place an index.html or index.md file in each page folder.

Both methods work fine (and can be used in conjunction with each other), with the only real difference being the resulting URLs.

Named HTML files

The simplest way of adding a page is just to add an HTML file in the root directory with a suitable name for the page you want to create. For a site with a homepage, an about page, and a contact page, here’s what the root directory and associated URLs might look like:

.
|-- _config.yml
|-- _includes/
|-- _layouts/
|-- _posts/
|-- _site/
|-- about.html    # => http://example.com/about.html
|-- index.html    # => http://example.com/
|-- other.md      # => http://example.com/other.html
└── contact.html  # => http://example.com/contact.html

Named folders containing index HTML files

There is nothing wrong with the above method. However, some people like to keep their URLs free from things like filename extensions. To achieve clean URLs for pages using Jekyll, you simply need to create a folder for each top-level page you want, and then place an index.html file in each page’s folder. This way the page URL ends up being the folder name, and the web server will serve up the respective index.html file. Here’s an example of what this structure might look like:

.
├── _config.yml
├── _includes/
├── _layouts/
├── _posts/
├── _site/
├── about/
|   └── index.html  # => http://example.com/about/
├── contact/
|   └── index.html  # => http://example.com/contact/
|── other/
|   └── index.md    # => http://example.com/other/
└── index.html      # => http://example.com/

This approach may not suit everyone, but for people who like clean URLs it’s simple and it works. In the end the decision is yours!

Chapter 2.5 - Static Files

In addition to renderable and convertible content, we also have static files.

A static file is a file that does not contain any YAML front matter. These include images, PDFs, and other un-rendered content.

They’re accessible in Liquid via site.static_files and contain the following metadata:

Chapter 2.6 - Variables

Jekyll traverses your site looking for files to process. Any files with YAML front matter are subject to processing. For each of these files, Jekyll makes a variety of data available via the Liquid templating system. The following is a reference of the available data.

Global Variables

Site Variables

Page Variables

Paginator

Chapter 2.7 - Collections

Not everything is a post or a page. Maybe you want to document the various methods in your open source project, members of a team, or talks at a conference. Collections allow you to define a new type of document that behave like Pages or Posts do normally, but also have their own unique properties and namespace.

Using Collections

Step 1: Tell Jekyll to read in your collection

Add the following to your site’s _config.yml file, replacing my_collection with the name of your collection:

collections:
- my_collection

You can optionally specify metadata for your collection in the configuration:

collections:
  my_collection:
    foo: bar

Default attributes can also be set for a collection:

defaults:
  - scope:
      path: ""
      type: my_collection
    values:
      layout: page

Step 2: Add your content

Create a corresponding folder (e.g. <source>/_my_collection) and add documents. YAML Front Matter is read in as data if it exists, and everything after it is stuck in the Document’s content attribute. If no YAML Front Matter is provided, Jekyll will not generate the file in your collection.

Step 3: Optionally render your collection’s documents into independent files

If you’d like Jekyll to create a public-facing, rendered version of each document in your collection, set the output key to true in your collection metadata in your _config.yml:

collections:
  my_collection:
    output: true

This will produce a file for each document in the collection. For example, if you have _my_collection/some_subdir/some_doc.md, it will be rendered using Liquid and the Markdown converter of your choice and written out to <dest>/my_collection/some_subdir/some_doc.html.

As for posts with Permalinks, the document URL can be customized by setting permalink metadata for the collection:

collections:
  my_collection:
    output: true
    permalink: /awesome/:path/

For example, if you have _my_collection/some_subdir/some_doc.md, it will be written out to <dest>/awesome/some_subdir/some_doc/index.html.

Liquid Attributes

Collections

Each collection is accessible via the site Liquid variable. For example, if you want to access the albums collection found in _albums, you’d use site.albums. Each collection is itself an array of documents (e.g. site.albums is an array of documents, much like site.pages and site.posts). See below for how to access attributes of those documents.

The collections are also available under site.collections, with the metadata you specified in your _config.yml (if present) and the following information:

Documents

In addition to any YAML Front Matter provided in the document’s corresponding file, each document has the following attributes:

Accessing Collection Attributes

Attributes from the YAML front matter can be accessed as data anywhere in the site. Using the above example for configuring a collection as site.albums, one might have front matter in an individual file structured as follows (which must use a supported markup format, and cannot be saved with a .yaml extension):

title: "Josquin: Missa De beata virgine and Missa Ave maris stella"
artist: "The Tallis Scholars"
director: "Peter Phillips"
works:
  - title: "Missa De beata virgine"
    composer: "Josquin des Prez"
    tracks:
      - title: "Kyrie"
        duration: "4:25"
      - title: "Gloria"
        duration: "9:53"
      - title: "Credo"
        duration: "9:09"
      - title: "Sanctus & Benedictus"
        duration: "7:47"
      - title: "Agnus Dei I, II & III"
        duration: "6:49"

Every album in the collection could be listed on a single page with a template:

{% for album in site.albums %}
  <h2>{{ album.title }}</h2>
  <p>Performed by {{ album.artist }}{% if album.director %}, directed by {{ album.director }}{% endif %}</p>
  {% for work in album.works %}
    <h3>{{ work.title }}</h3>
    <p>Composed by {{ work.composer }}</p>
    <ul>
    {% for track in work.tracks %}
      <li>{{ track.title }} ({{ track.duration }})</li>
    {% endfor %}
    </ul>
  {% endfor %}
{% endfor %}

Chapter 2.8 - Data Files

In addition to the built-in variables available from Jekyll, you can specify your own custom data that can be accessed via the Liquid templating system.

Jekyll supports loading data from YAML, JSON, and CSV files located in the _data directory. Note that CSV files must contain a header row.

This powerful feature allows you to avoid repetition in your templates and to set site specific options without changing _config.yml.

Plugins/themes can also leverage Data Files to set configuration variables.

The Data Folder

As explained on the directory structure page, the _data folder is where you can store additional data for Jekyll to use when generating your site. These files must be YAML files (using either the .yml, .yaml, .json or csv extension) and they will be accessible via site.data.

Example: List of members

Here is a basic example of using Data Files to avoid copy-pasting large chunks of code in your Jekyll templates:

In _data/members.yml:

- name: Tom Preston-Werner
  github: mojombo

- name: Parker Moore
  github: parkr

- name: Liu Fengyun
  github: liufengyun

Or _data/members.csv:

name,github
Tom Preston-Werner,mojombo
Parker Moore,parkr
Liu Fengyun,liufengyun

This data can be accessed via site.data.members (notice that the filename determines the variable name).

You can now render the list of members in a template:

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

Example: Organizations

Data files can also be placed in sub-folders of the _data folder. Each folder level will be added to a variable’s namespace. The example below shows how GitHub organizations could be defined separately in a file under the orgs folder:

In _data/orgs/jekyll.yml:

username: jekyll
name: Jekyll
members:
  - name: Tom Preston-Werner
    github: mojombo

  - name: Parker Moore
    github: parkr

In _data/orgs/doeorg.yml:

username: doeorg
name: Doe Org
members:
  - name: John Doe
    github: jdoe

The organizations can then be accessed via site.data.orgs, followed by the file name:

<ul>
{% for org_hash in site.data.orgs %}
{% assign org = org_hash[1] %}
  <li>
    <a href="https://github.com/{{ org.username }}">
      {{ org.name }}
    </a>
    ({{ org.members | size }} members)
  </li>
{% endfor %}
</ul>

Example: Accessing a specific author

Pages and posts can also access a specific data item. The example below shows how to access a specific item:

_data/people.yml:

dave:
    name: David Smith
    twitter: DavidSilvaSmith

The author can then be specified as a page variable in a post’s frontmatter:

---
title: sample post
author: dave
---

{% assign author = site.data.people[page.author] %}
<a rel="author"
  href="{{ author.twitter }}"
  title="{{ author.name }}">
    {{ author.name }}
</a>

Chapter 2.9 - Assets

Jekyll provides built-in support for Sass and can work with CoffeeScript via a Ruby gem. In order to use them, you must first create a file with the proper extension name (one of .sass, .scss, or .coffee) and start the file with two lines of triple dashes, like this:

---
---

// start content
.my-definition
  font-size: 1.2em

Jekyll treats these files the same as a regular page, in that the output file will be placed in the same directory that it came from. For instance, if you have a file named css/styles.scss in your site’s source folder, Jekyll will process it and put it in your site’s destination folder under css/styles.css.

Sass/SCSS

Jekyll allows you to customize your Sass conversion in certain ways.

Place all your partials in your sass_dir, which defaults to <source>/_sass. Place your main SCSS or Sass files in the place you want them to be in the output file, such as <source>/css. For an example, take a look at this example site using Sass support in Jekyll.

If you are using Sass @import statements, you’ll need to ensure that your sass_dir is set to the base directory that contains your Sass files. You can do that thusly:

sass:
    sass_dir: _sass

The Sass converter will default the sass_dir configuration option to _sass.

You may also specify the output style with the style option in your _config.yml file:

sass:
    style: compressed

These are passed to Sass, so any output style options Sass supports are valid here, too.

Coffeescript

To enable Coffeescript in Jekyll 3.0 and up you must

• Install the jekyll-coffeescript gem
• Ensure that your _config.yml is up-to-date and includes the following:

gems:
 - jekyll-coffeescript

Chapter 3.1 - Templates

Jekyll uses the Liquid templating language to process templates. All of the standard Liquid tags and filters are supported. Jekyll even adds a few handy filters and tags of its own to make common tasks easier.

Filters

Options for the slugify filter

The slugify filter accepts an option, each specifying what to filter. The default is default. They are as follows (with what they filter):

• none: no characters
• raw: spaces
• default: spaces and non-alphanumeric characters
• pretty: spaces and non-alphanumeric characters except for ._~!$&'()+,;=@

Tags

Includes

If you have small page fragments that you wish to include in multiple places on your site, you can use the include tag.

{% include footer.html %}

Jekyll expects all include files to be placed in an _includes directory at the root of your source directory. This will embed the contents of <source>/_includes/footer.html into the calling file.

You can also pass parameters to an include. Omit the quotation marks to send a variable’s value. Liquid curly brackets should not be used here:

{% include footer.html param="value" variable-param=page.variable %}

These parameters are available via Liquid in the include:

{{ include.param }}

Including files relative to another file

You can also choose to include file fragments relative to the current file:

{% include_relative somedir/footer.html %}

You won’t need to place your included content within the _includes directory. Instead, the inclusion is specifically relative to the file where the tag is being used. For example, if _posts/2014-09-03-my-file.markdown uses the include_relative tag, the included file must be within the _posts directory, or one of its subdirectories. You cannot include files in other locations.

All the other capabilities of the include tag are available to the include_relative tag, such as using variables.

Code snippet highlighting

Jekyll has built in support for syntax highlighting of over 60 languages thanks to Rouge. Rouge is the default highlighter in Jekyll 3 and above. To use it in Jekyll 2, set highlighter to rouge and ensure the rouge gem is installed properly.

Alternatively, you can use Pygments to highlight your code snippets. To use Pygments, you must have Python installed on your system, have the pygments.rb gem installed and set highlighter to pygments in your site’s configuration file. Pygments supports over 100 languages

To render a code block with syntax highlighting, surround your code as follows:

{% highlight ruby %}
def foo
  puts 'foo'
end
{% endhighlight %}

The argument to the highlight tag (ruby in the example above) is the language identifier. To find the appropriate identifier to use for the language you want to highlight, look for the “short name” on the Rouge wiki or the Pygments’ Lexers page.

Line numbers

There is a second argument to highlight called linenos that is optional. Including the linenos argument will force the highlighted code to include line numbers. For instance, the following code block would include line numbers next to each line:

{% highlight ruby linenos %}
def foo
  puts 'foo'
end
{% endhighlight %}

Stylesheets for syntax highlighting

In order for the highlighting to show up, you’ll need to include a highlighting stylesheet. For an example stylesheet you can look at syntax.css. These are the same styles as used by GitHub and you are free to use them for your own site. If you use linenos, you might want to include an additional CSS class definition for the .lineno class in syntax.css to distinguish the line numbers from the highlighted code.

Post URL

If you would like to include a link to a post on your site, the post_url tag will generate the correct permalink URL for the post you specify.

{% post_url 2010-07-21-name-of-post %}

If you organize your posts in subdirectories, you need to include subdirectory path to the post:

{% post_url /subdir/2010-07-21-name-of-post %}

There is no need to include the file extension when using the post_url tag.

You can also use this tag to create a link to a post in Markdown as follows:

[Name of Link]({% post_url 2010-07-21-name-of-post %})

Gist

Use the gist tag to easily embed a GitHub Gist onto your site. This works with public or secret gists:

{% gist parkr/931c1c8d465a04042403 %}

You may also optionally specify the filename in the gist to display:

{% gist parkr/931c1c8d465a04042403 jekyll-private-gist.markdown %}

To use the gist tag, you’ll need to add the jekyll-gist gem to your project.

Chapter 3.2 - Permalinks

Jekyll supports a flexible way to build your site’s URLs. You can specify the permalinks for your site through the Configuration or in the YAML Front Matter for each post. You’re free to choose one of the built-in styles to create your links or craft your own. The default style is date.

Permalinks are constructed by creating a template URL where dynamic elements are represented by colon-prefixed keywords. For example, the default date permalink is defined according to the format /:categories/:year/:month/:day/:title.html.

Template variables

Built-in permalink styles

While you can specify a custom permalink style using template variables, Jekyll also provides the following built-in styles for convenience.

Pages and collections

The permalink configuration setting specifies the permalink style used for posts. Pages and collections each have their own default permalink style; the default style for pages is /:path/:basename and the default for collections is /:collection/:path.

These styles are modified to match the suffix style specified in the post permalink setting. For example, a permalink style of pretty, which contains a trailing slash, will update page permalinks to also contain a trailing slash: /:path/:basename/. A permalink style of date, which contains a trailing file extension, will update page permalinks to also contain a file extension: /:path/:basename:output_ext. The same is true for any custom permalink style.

The permalink for an individual page or collection document can always be overridden in the YAML Front Matter for the page or document. Additionally, permalinks for a given collection can be customized in the collections configuration.

Permalink style examples

Given a post named: /2009-04-29-slap-chop.md

Extensionless permalinks

Jekyll supports permalinks that contain neither a trailing slash nor a file extension, but this requires additional support from the web server to properly serve. When using extensionless permalinks, output files written to disk will still have the proper file extension (typically .html), so the web server must be able to map requests without file extensions to these files.

Both GitHub Pages and the Jekyll’s built-in WEBrick server handle these requests properly without any additional work.

Chapter 3.3 - Pagination

With many websites — especially blogs — it’s very common to break the main listing of posts up into smaller lists and display them over multiple pages. Jekyll offers a pagination plugin, so you can automatically generate the appropriate files and folders you need for paginated listings.

For Jekyll 3, include the jekyll-paginate plugin in your Gemfile and in your _config.yml under gems. For Jekyll 2, this is standard.

Enable pagination

To enable pagination for your blog, add a line to the _config.yml file that specifies how many items should be displayed per page:

paginate: 5

The number should be the maximum number of Posts you’d like to be displayed per-page in the generated site.

You may also specify the destination of the pagination pages:

paginate_path: "/blog/page:num/"

This will read in blog/index.html, send it each pagination page in Liquid as paginator and write the output to blog/page:num/, where :num is the pagination page number, starting with 2. If a site has 12 posts and specifies paginate: 5, Jekyll will write blog/index.html with the first 5 posts, blog/page2/index.html with the next 5 posts and blog/page3/index.html with the last 2 posts into the destination directory.

Liquid Attributes Available

The pagination plugin exposes the paginator liquid object with the following attributes:

Render the paginated Posts

The next thing you need to do is to actually display your posts in a list using the paginator variable that will now be available to you. You’ll probably want to do this in one of the main pages of your site. Here’s one example of a simple way of rendering paginated Posts in a HTML file:

---
layout: default
title: My Blog
---

<!-- This loops through the paginated posts -->
{% for post in paginator.posts %}
  <h1><a href="{{ post.url }}">{{ post.title }}</a></h1>
  <p class="author">
    <span class="date">{{ post.date }}</span>
  </p>
  <div class="content">
    {{ post.content }}
  </div>
{% endfor %}

<!-- Pagination links -->
<div class="pagination">
  {% if paginator.previous_page %}
    <a href="{{ paginator.previous_page_path }}" class="previous">Previous</a>
  {% else %}
    <span class="previous">Previous</span>
  {% endif %}
  <span class="page_number ">Page: {{ paginator.page }} of {{ paginator.total_pages }}</span>
  {% if paginator.next_page %}
    <a href="{{ paginator.next_page_path }}" class="next">Next</a>
  {% else %}
    <span class="next ">Next</span>
  {% endif %}
</div>

The following HTML snippet should handle page one, and render a list of each page with links to all but the current page.

{% if paginator.total_pages > 1 %}
<div class="pagination">
  {% if paginator.previous_page %}
    <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">&laquo; Prev</a>
  {% else %}
    <span>&laquo; Prev</span>
  {% endif %}

  {% for page in (1..paginator.total_pages) %}
    {% if page == paginator.page %}
      <em>{{ page }}</em>
    {% elsif page == 1 %}
      <a href="{{ paginator.previous_page_path | prepend: site.baseurl | replace: '//', '/' }}">{{ page }}</a>
    {% else %}
      <a href="{{ site.paginate_path | prepend: site.baseurl | replace: '//', '/' | replace: ':num', page }}">{{ page }}</a>
    {% endif %}
  {% endfor %}

  {% if paginator.next_page %}
    <a href="{{ paginator.next_page_path | prepend: site.baseurl | replace: '//', '/' }}">Next &raquo;</a>
  {% else %}
    <span>Next &raquo;</span>
  {% endif %}
</div>
{% endif %}

Chapter 3.4 - Plugins

Jekyll has a plugin system with hooks that allow you to create custom generated content specific to your site. You can run custom code for your site without having to modify the Jekyll source itself.

Installing a plugin

You have 3 options for installing plugins:

1. In your site source root, make a _plugins directory. Place your plugins here. Any file ending in *.rb inside this directory will be loaded before Jekyll generates your site.

2. In your _config.yml file, add a new array with the key gems and the values of the gem names of the plugins you’d like to use. An example:

    gems: [jekyll-coffeescript, jekyll-watch, jekyll-assets]
    # This will require each of these gems automatically.
   

   Then install your plugins using gem install jekyll-coffeescript jekyll-watch jekyll-assets

3. Add the relevant plugins to a Bundler group in your Gemfile. An example:

    group :jekyll_plugins do
      gem "my-jekyll-plugin"
      gem "another-jekyll-plugin"
    end
   

   Now you need to install all plugins from your Bundler group by running single command bundle install

Chapter 3.5 - Extras

There are a number of (optional) extra features that Jekyll supports that you may want to install, depending on how you plan to use Jekyll.

Math Support

Kramdown comes with optional support for LaTeX to PNG rendering via MathJax within math blocks. See the Kramdown documentation on math blocks and math support for more details. MathJax requires you to include JavaScript or CSS to render the LaTeX, e.g.

<script src="http://cdn.mathjax.org/mathjax/latest/MathJax.js?config=TeX-AMS-MML_HTMLorMML" type="text/javascript"></script>

For more information about getting started, check out this excellent blog post.

Alternative Markdown Processors

See the Markdown section on the configuration page for instructions on how to use and configure alternative Markdown processors, as well as how to create custom processors.

Chapter 4.1 - Troubleshooting

If you ever run into problems installing or using Jekyll, here are a few tips that might be of help. If the problem you’re experiencing isn’t covered below, please check out our other help resources as well.

• Base-URL Problems
• Configuration problems
• Markup Problems

Base-URL Problems

If you are using base-url option like:

jekyll serve --baseurl '/blog'

… then make sure that you access the site at:

http://localhost:4000/blog/index.html

It won’t work to just access:

http://localhost:4000/blog

Configuration problems

The order of precedence for conflicting configuration settings is as follows:

1. Command-line flags
2. Configuration file settings
3. Defaults

That is: defaults are overridden by options specified in _config.yml, and flags specified at the command-line will override all other settings specified elsewhere.

Markup Problems

The various markup engines that Jekyll uses may have some issues. This page will document them to help others who may run into the same problems.

Liquid

The latest version, version 2.0, seems to break the use of {{ in templates. Unlike previous versions, using {{ in 2.0 triggers the following error:

'{{' was not properly terminated with regexp: /\}\}/  (Liquid::SyntaxError)

Excerpts

Since v1.0.0, Jekyll has had automatically-generated post excerpts. Since v1.1.0, Jekyll also passes these excerpts through Liquid, which can cause strange errors where references don’t exist or a tag hasn’t been closed. If you run into these errors, try setting excerpt_separator: "" in your _config.yml, or set it to some nonsense string.

Chapter 5.1 - Plugins

Available Plugins

You can find a few useful plugins at the following locations:

Generators

• ArchiveGenerator by Ilkka Laukkanen: Uses this archive page to generate archives.
• LESS.js Generator by Andy Fowler: Renders LESS.js files during generation.
• Version Reporter by Blake Smith: Creates a version.html file containing the Jekyll version.
• Sitemap.xml Generator by Michael Levin: Generates a sitemap.xml file by traversing all of the available posts and pages.
• Full-text search by Pascal Widdershoven: Adds full-text search to your Jekyll site with a plugin and a bit of JavaScript.
• AliasGenerator by Thomas Mango: Generates redirect pages for posts when an alias is specified in the YAML Front Matter.
• Pageless Redirect Generator by Nick Quinlan: Generates redirects based on files in the Jekyll root, with support for htaccess style redirects.
• RssGenerator by Assaf Gelber: Automatically creates an RSS 2.0 feed from your posts.
• Monthly archive generator by Shigeya Suzuki: Generator and template which renders monthly archive like MovableType style, based on the work by Ilkka Laukkanen and others above.
• Category archive generator by Shigeya Suzuki: Generator and template which renders category archive like MovableType style, based on Monthly archive generator.
• Emoji for Jekyll: Seamlessly enable emoji for all posts and pages.
• Compass integration for Jekyll: Easily integrate Compass and Sass with your Jekyll website.
• Pages Directory by Ben Baker-Smith: Defines a _pages directory for page files which routes its output relative to the project root.
• Page Collections by Jeff Kolesky: Generates collections of pages with functionality that resembles posts.
• Windows 8.1 Live Tile Generation by Matt Sheehan: Generates Internet Explorer 11 config.xml file and Tile Templates for pinning your site to Windows 8.1.
• Typescript Generator by Matt Sheehan: Generate Javascript on build from your Typescript.
• Jekyll::AutolinkEmail by Ivan Tse: Autolink your emails.
• Jekyll::GitMetadata by Ivan Tse: Expose Git metadata for your templates.
• Jekyll Http Basic Auth Plugin: Plugin to manage http basic auth for jekyll generated pages and directories.
• Jekyll Auto Image by Merlos: Gets the first image of a post. Useful to list your posts with images or to add twitter cards to your site.
• Jekyll Portfolio Generator by Shannon Babincsak: Generates project pages and computes related projects out of project data files.
• Jekyll-Umlauts by Arne Gockeln: This generator replaces all german umlauts (äöüß) case sensitive with html.
• Jekyll Flickr Plugin by Lawrence Murray: Generates posts for photos uploaded to a Flickr photostream.
• Jekyll::Paginate::Category: Pagination Generator for Jekyll Category.

Converters

• Textile converter: Convert .textile files into HTML. Also includes the textilize Liquid filter.
• Slim plugin: Slim converter and includes for Jekyll with support for Liquid tags.
• Jade plugin by John Papandriopoulos: Jade converter for Jekyll.
• HAML plugin by Sam Z: HAML converter for Jekyll.
• HAML-Sass Converter by Adam Pearson: Simple HAML-Sass converter for Jekyll. Fork by Sam X.
• Sass SCSS Converter by Mark Wolfe: Sass converter which uses the new CSS compatible syntax, based Sam X’s fork above.
• LESS Converter by Jason Graham: Convert LESS files to CSS.
• LESS Converter by Josh Brown: Simple LESS converter.
• Upcase Converter by Blake Smith: An example Jekyll converter.
• CoffeeScript Converter by phaer: A CoffeeScript to Javascript converter.
• Markdown References by Olov Lassus: Keep all your markdown reference-style link definitions in one _references.md file.
• Stylus Converter: Convert .styl to .css.
• ReStructuredText Converter: Converts ReST documents to HTML with Pygments syntax highlighting.
• Jekyll-pandoc-plugin: Use pandoc for rendering markdown.
• Jekyll-pandoc-multiple-formats by edsl: Use pandoc to generate your site in multiple formats. Supports pandoc’s markdown extensions.
• Transform Layouts: Allows HAML layouts (you need a HAML Converter plugin for this to work).
• Org-mode Converter: Org-mode converter for Jekyll.
• Customized Kramdown Converter: Enable Pygments syntax highlighting for Kramdown-parsed fenced code blocks.
• Bigfootnotes Plugin: Enables big footnotes for Kramdown.
• AsciiDoc Plugin: AsciiDoc convertor for Jekyll using Asciidoctor.
• Lazy Tweet Embedding: Automatically convert tweet urls into twitter cards.
• jekyll-commonmark: Markdown converter that uses libcmark, the reference parser for CommonMark.

Filters

• Truncate HTML by Matt Hall: A Jekyll filter that truncates HTML while preserving markup structure.
• Domain Name Filter by Lawrence Woodman: Filters the input text so that just the domain name is left.
• Summarize Filter by Mathieu Arnold: Remove markup after a <div id="extended"> tag.
• i18n_filter: Liquid filter to use I18n localization.
• Smilify by SaswatPadhi: Convert text emoticons in your content to themeable smiley pics.
• Read in X Minutes by zachleat: Estimates the reading time of a string (for blog post content).
• Jekyll-timeago: Converts a time value to the time ago in words.
• pluralize: Easily combine a number and a word into a grammatically-correct amount like “1 minute” or “2 minutes”.
• reading_time: Count words and estimate reading time for a piece of text, ignoring HTML elements that are unlikely to contain running text.
• Table of Content Generator: Generate the HTML code containing a table of content (TOC), the TOC can be customized in many way, for example you can decide which pages can be without TOC.
• jekyll-toc: A liquid filter plugin for Jekyll which generates a table of contents.
• jekyll-humanize: This is a port of the Django app humanize which adds a “human touch” to data. Each method represents a Fluid type filter that can be used in your Jekyll site templates. Given that Jekyll produces static sites, some of the original methods do not make logical sense to port (e.g. naturaltime).
• Jekyll-Ordinal: Jekyll liquid filter to output a date ordinal such as “st”, “nd”, “rd”, or “th”.
• Deprecated articles keeper by Kazuya Kobayashi: A simple Jekyll filter which monitor how old an article is.
• Jekyll-jalali by Mehdi Sadeghi: A simple Gregorian to Jalali date converter filter.
• Jekyll Thumbnail Filter: Related posts thumbnail filter.
• Jekyll-Smartify: SmartyPants filter. Make "quotes" “curly”
• liquid-md5: Returns an MD5 hash. Helpful for generating Gravatars in templates.
• jekyll-roman: A liquid filter for Jekyll that converts numbers into Roman numerals.
• jekyll-typogrify: A Jekyll plugin that brings the functions of typogruby.
• Jekyll Email Protect: Email protection liquid filter for Jekyll

Tags

• Asset Path Tag by Sam Rayner: Allows organisation of assets into subdirectories by outputting a path for a given file relative to the current post or page.
• Delicious Plugin by Christian Hellsten: Fetches and renders bookmarks from delicious.com.
• Ultraviolet Plugin by Steve Alex: Jekyll tag for the Ultraviolet code highligher.
• Tag Cloud Plugin by Ilkka Laukkanen: Generate a tag cloud that links to tag pages.
• GIT Tag by Alexandre Girard: Add Git activity inside a list.
• MathJax Liquid Tags by Jessy Cowan-Sharp: Simple liquid tags for Jekyll that convert inline math and block equations to the appropriate MathJax script tags.
• Non-JS Gist Tag by Brandon Tilley A Liquid tag that embeds Gists and shows code for non-JavaScript enabled browsers and readers.
• Render Time Tag by Blake Smith: Displays the time a Jekyll page was generated.
• Status.net/OStatus Tag by phaer: Displays the notices in a given status.net/ostatus feed.
• Embed.ly client by Robert Böhnke: Autogenerate embeds from URLs using oEmbed.
• Logarithmic Tag Cloud: Flexible. Logarithmic distribution. Documentation inline.
• oEmbed Tag by Tammo van Lessen: Enables easy content embedding (e.g. from YouTube, Flickr, Slideshare) via oEmbed.
• FlickrSetTag by Thomas Mango: Generates image galleries from Flickr sets.
• Tweet Tag by Scott W. Bradley: Liquid tag for Embedded Tweets using Twitter’s shortcodes.
• Jekyll Twitter Plugin: A Liquid tag plugin that renders Tweets from Twitter API. Currently supports the oEmbed API.
• Jekyll-contentblocks: Lets you use Rails-like content_for tags in your templates, for passing content from your posts up to your layouts.
• Generate YouTube Embed by joelverhagen: Jekyll plugin which allows you to embed a YouTube video in your page with the YouTube ID. Optionally specify width and height dimensions. Like “oEmbed Tag” but just for YouTube.
• Jekyll-beastiepress: FreeBSD utility tags for Jekyll sites.
• Jsonball: Reads json files and produces maps for use in Jekyll files.
• Bibjekyll: Render BibTeX-formatted bibliographies/citations included in posts and pages using bibtex2html.
• Jekyll-citation: Render BibTeX-formatted bibliographies/citations included in posts and pages (pure Ruby).
• Jekyll Dribbble Set Tag: Builds Dribbble image galleries from any user.
• Debbugs: Allows posting links to Debian BTS easily.
• Refheap_tag: Liquid tag that allows embedding pastes from refheap.
• Jekyll-devonly_tag: A block tag for including markup only during development.
• JekyllGalleryTag by redwallhp: Generates thumbnails from a directory of images and displays them in a grid.
• Youku and Tudou Embed: Liquid plugin for embedding Youku and Tudou videos.
• Jekyll-swfobject: Liquid plugin for embedding Adobe Flash files (.swf) using SWFObject.
• Jekyll Picture Tag: Easy responsive images for Jekyll. Based on the proposed <picture> element, polyfilled with Scott Jehl’s Picturefill.
• Jekyll Image Tag: Better images for Jekyll. Save image presets, generate resized images, and add classes, alt text, and other attributes.
• Jekyll Responsive Image: Responsive images for Jekyll. Automatically resizes images, supports all responsive methods (<picture>, srcset, Imager.js, etc), super-flexible configuration.
• Ditaa Tag by matze: Renders ASCII diagram art into PNG images and inserts a figure tag.
• Jekyll Suggested Tweet by David Ensinger: A Liquid tag for Jekyll that allows for the embedding of suggested tweets via Twitter’s Web Intents API.
• Jekyll Date Chart by GSI: Block that renders date line charts based on textile-formatted tables.
• Jekyll Image Encode by GSI: Tag that renders base64 codes of images fetched from the web.
• Jekyll Quick Man by GSI: Tag that renders pretty links to man page sources on the internet.
• jekyll-font-awesome: Quickly and easily add Font Awesome icons to your posts.
• Lychee Gallery Tag by tobru: Include Lychee albums into a post. For an introduction, see Jekyll meets Lychee - A Liquid Tag plugin
• Image Set/Gallery Tag by callmeed: Renders HTML for an image gallery from a folder in your Jekyll site. Just pass it a folder name and class/tag options.
• jekyll_figure: Generate figures and captions with links to the figure in a variety of formats
• Jekyll GitHub Sample Tag: A liquid tag to include a sample of a github repo file in your Jekyll site.
• Jekyll Project Version Tag: A Liquid tag plugin that renders a version identifier for your Jekyll site sourced from the git repository containing your code.
• Piwigo Gallery by Alessandro Lorenzi: Jekyll plugin to generate thumbnails from a Piwigo gallery and display them with a Liquid tag
• mathml.rb by Tom Thorogood: A plugin to convert TeX mathematics into MathML for display.
• webmention_io.rb by Aaron Gustafson: A plugin to enable webmention integration using Webmention.io. Includes an optional JavaScript for updating webmentions automatically between publishes and, if available, in realtime using WebSockets.
• Jekyll 500px Embed by Luke Korth. A Liquid tag plugin that embeds 500px photos.
• inline_highlight: A tag for inline syntax highlighting.
• jekyll-mermaid: Simplify the creation of mermaid diagrams and flowcharts in your posts and pages.
• twa: Twemoji Awesome plugin for Jekyll. Liquid tag allowing you to use twitter emoji in your jekyll pages.
• jekyll-files by Zhi-Wei Cai: Output relative path strings and other info regarding specific assets.
• Fetch remote file content by Dimitri König: Using remote_file_content tag you can fetch the content of a remote file and include it as if you would put the content right into your markdown file yourself. Very useful for including code from github repo’s to always have a current repo version.
• jekyll-asciinema: A tag for embedding asciicasts recorded with asciinema in your Jekyll pages.
• Jekyll-Youtube A Liquid tag that embeds Youtube videos. The default emded markup is responsive but you can also specify your own by using an include/partial.
• Jekyll Flickr Plugin by Lawrence Murray: Embeds Flickr photosets (albums) as a gallery of thumbnails, with lightbox links to larger images.
• jekyll-figure: A liquid tag for Jekyll that generates <figure> elements.

Collections

• Jekyll Plugins by Recursive Design: Plugins to generate Project pages from GitHub readmes, a Category page, and a Sitemap generator.
• Company website and blog plugins by Flatterline, a Ruby on Rails development company: Portfolio/project page generator, team/individual page generator, an author bio liquid tag for use on posts, and a few other smaller plugins.
• Jekyll plugins by Aucor: Plugins for trimming unwanted newlines/whitespace and sorting pages by weight attribute.

Other

• ditaa-ditaa by Tom Thorogood: a drastic revision of jekyll-ditaa that renders diagrams drawn using ASCII art into PNG images.
• Pygments Cache Path by Raimonds Simanovskis: Plugin to cache syntax-highlighted code from Pygments.
• Draft/Publish Plugin by Michael Ivey: Save posts as drafts.
• Growl Notification Generator by Tate Johnson: Send Jekyll notifications to Growl.
• Growl Notification Hook by Tate Johnson: Better alternative to the above, but requires his “hook” fork.
• Related Posts by Lawrence Woodman: Overrides site.related_posts to use categories to assess relationship.
• Tiered Archives by Eli Naeher: Create tiered template variable that allows you to group archives by year and month.
• Jekyll-localization: Jekyll plugin that adds localization features to the rendering engine.
• Jekyll-rendering: Jekyll plugin to provide alternative rendering engines.
• Jekyll-pagination: Jekyll plugin to extend the pagination generator.
• Jekyll-tagging: Jekyll plugin to automatically generate a tag cloud and tag pages.
• Jekyll-scholar: Jekyll extensions for the blogging scholar.
• Jekyll-asset_bundler: Bundles and minifies JavaScript and CSS.
• Jekyll-assets by ixti: Rails-alike assets pipeline (write assets in CoffeeScript, Sass, LESS etc; specify dependencies for automatic bundling using simple declarative comments in assets; minify and compress; use JST templates; cache bust; and many-many more).
• JAPR: Jekyll Asset Pipeline Reborn - Powerful asset pipeline for Jekyll that collects, converts and compresses JavaScript and CSS assets.
• File compressor by mytharcher: Compress HTML and JavaScript files on site build.
• Jekyll-minibundle: Asset bundling and cache busting using external minification tool of your choice. No gem dependencies.
• Singlepage-jekyll by JCB-K: Turns Jekyll into a dynamic one-page website.
• generator-jekyllrb: A generator that wraps Jekyll in Yeoman, a tool collection and workflow for building modern web apps.
• grunt-jekyll: A straightforward Grunt plugin for Jekyll.
• jekyll-postfiles: Add _postfiles directory and {{ postfile }} tag so the files a post refers to will always be right there inside your repo.
• A layout that compresses HTML: GitHub Pages compatible, configurable way to compress HTML files on site build.
• Jekyll CO₂: Generates HTML showing the monthly change in atmospheric CO₂ at the Mauna Loa observatory in Hawaii.
• remote-include: Includes files using remote URLs
• jekyll-minifier: Minifies HTML, XML, CSS, and Javascript both inline and as separate files utilising yui-compressor and htmlcompressor.
• Jekyll views router: Simple router between generator plugins and templates.
• Jekyll Language Plugin: Jekyll 3.0-compatible multi-language plugin for posts, pages and includes.
• Jekyll Deploy: Adds a deploy sub-command to Jekyll.
• Official Contentful Jekyll Plugin: Adds a contentful sub-command to Jekyll to import data from Contentful.

Editors

• sublime-jekyll: A Sublime Text package for Jekyll static sites. This package should help creating Jekyll sites and posts easier by providing access to key template tags and filters, as well as common completions and a current date/datetime command (for dating posts). You can install this package manually via GitHub, or via Package Control.
• vim-jekyll: A vim plugin to generate new posts and run jekyll build all without leaving vim.
• markdown-writer: An Atom package for Jekyll. It can create new posts/drafts, manage tags/categories, insert link/images and add many useful key mappings.
• Wordpress2Jekyll: A Wordpress plugin that allows you to use Wordpress as your editor and (automatically) export content in to Jekyll. WordPress2Jekyll attempts to marry these two systems together in order to make a site that can be easily managed from all devices.

Chapter 5.2 - History

3.1.1 / 2016-01-29

Meta

• Update the Code of Conduct to the latest version (#4402)

Bug Fixes

• Page#dir: ensure it ends in a slash (#4403)
• Add Utils.merged_file_read_opts to unify reading & strip the BOM (#4404)
• Renderer#output_ext: honor folders when looking for ext (#4401)

Development Fixes

• Suppress stdout in liquid profiling test (#4409)

3.1.0 / 2016-01-23

Minor Enhancements

• Use Liquid::Drops instead of Hashes in #to_liquid (#4277)
• Add ‘sample’ Liquid filter Equivalent to Array#sample functionality (#4223)
• Cache parsed include file to save liquid parsing time. (#4120)
• Slightly speed up url sanitization and handle multiples of ///. (#4168)
• Print debug message when a document is skipped from reading (#4180)
• Include tag should accept multiple variables in the include name (#4183)
• Add -o option to serve command which opens server URL (#4144)
• Add CodeClimate platform for better code quality. (#4220)
• General improvements for WEBrick via jekyll serve such as SSL & custom headers (#4224, #4228)
• Add a default charset to content-type on webrick. (#4231)
• Switch PluginManager to use require_with_graceful_fail for better UX (#4233)
• Allow quoted date in front matter defaults (#4184)
• Add a Jekyll doctor warning for URLs that only differ by case (#3171)
• drops: create one base Drop class which can be set as mutable or not (#4285)
• drops: provide #to_h to allow for hash introspection (#4281)
• Shim subcommands with indication of gem possibly required so users know how to use them (#4254)
• Add smartify Liquid filter for SmartyPants (#4323)
• Raise error on empty permalink (#4361)
• Refactor Page#permalink method (#4389)

Bug Fixes

• Pass build options into clean command (#4177)
• Allow users to use .htm and .xhtml (XHTML5.) (#4160)
• Prevent Shell Injection. (#4200)
• Convertible should make layout data accessible via layout instead of page (#4205)
• Avoid using Dir.glob with absolute path to allow special characters in the path (#4150)
• Handle empty config files (#4052)
• Rename [@options](https://github.com/options) so that it does not impact Liquid. (#4173)
• utils/drops: update Drop to support Utils.deep_merge_hashes (#4289)
• Make sure jekyll/drops/drop is loaded first. (#4292)
• Convertible/Page/Renderer: use payload hash accessor & setter syntax for backwards-compatibility (#4311)
• Drop: fix hash setter precendence (#4312)
• utils: has_yaml_header? should accept files with extraneous spaces (#4290)
• Escape html from site.title and page.title in site template (#4307)
• Allow custom file extensions if defined in permalink YAML front matter (#4314)
• Fix deep_merge_hashes! handling of drops and hashes (#4359)
• Page should respect output extension of its permalink (#4373)
• Disable auto-regeneration when running server detached (#4376)
• Drop#[]: only use public_send for keys in the content_methods array (#4388)
• Extract title from filename successfully when no date. (#4195)

Development Fixes

• jekyll-docs should be easily release-able (#4152)
• Allow use of Cucumber 2.1 or greater (#4181)
• Modernize Kramdown for Markdown converter. (#4109)
• Change TestDoctorCommand to JekyllUnitTest… (#4263)
• Create namespaced rake tasks in separate .rake files under lib/tasks (#4282)
• markdown: refactor for greater readability & efficiency (#3771)
• Fix many Rubocop style errors (#4301)
• Fix spelling of “GitHub” in docs and history (#4322)
• Reorganize and cleanup the Gemfile, shorten required depends. (#4318)
• Remove script/rebund. (#4341)
• Implement codeclimate platform (#4340)
• Remove ObectSpace dumping and start using inherited, it’s faster. (#4342)
• Add script/travis so all people can play with Travis-CI images. (#4338)
• Move Cucumber to using RSpec-Expections and furthering JRuby support. (#4343)
• Rearrange Cucumber and add some flair. (#4347)
• Remove old FIXME (#4349)
• Clean up the Gemfile (and keep all the necessary dependencies) (#4350)

Site Enhancements

• Add three plugins to directory (#4163)
• Add upgrading docs from 2.x to 3.x (#4157)
• Add protect_email to the plugins index. (#4169)
• Add jekyll-deploy to list of third-party plugins (#4179)
• Clarify plugin docs (#4154)
• Add Kickster to deployment methods in documentation (#4190)
• Add DavidBurela’s tutorial for Windows to Windows docs page (#4210)
• Change GitHub code block to highlight tag to avoid it overlaps parent div (#4121)
• Update FormKeep link to be something more specific to Jekyll (#4243)
• Remove example Roger Chapman site, as the domain doesn’t exist (#4249)
• Added configuration options for draft_posts to configuration docs (#4251)
• Fix checklist in _assets.md (#4259)
• Add Markdown examples to Pages docs (#4275)
• Add jekyll-paginate-category to list of third-party plugins (#4273)
• Add jekyll-responsive_image to list of third-party plugins (#4286)
• Add jekyll-commonmark to list of third-party plugins (#4299)
• Add documentation for incremental regeneration (#4293)
• Add note about removal of relative permalink support in upgrading docs (#4303)
• Add Pro Tip to use front matter variable to create clean URLs (#4296)
• Fix grammar in the documentation for posts. (#4330)
• Add documentation for smartify Liquid filter (#4333)
• Fixed broken link to blog on using mathjax with jekyll (#4344)
• Documentation: correct reference in Precedence section of Configuration docs (#4355)
• Add @jmcglone’s guide to github-pages doc page (#4364)
• Added the Wordpress2Jekyll Wordpress plugin (#4377)
• Add Contentful Extension to list of third-party plugins (#4390)
• Correct Minor spelling error (#4394)

3.0.2 / 2016-01-20

Bug Fixes

• Document: throw a useful error when an invalid date is given (#4378)

3.0.1 / 2015-11-17

Bug Fixes

• Document: only superdirectories of the collection are categories (#4110)
• Convertible#render_liquid should use render! to cause failure on bad Liquid (#4077)
• Don’t generate .jekyll-metadata in non-incremental build (#4079)
• Set highlighter config val to kramdown.syntax_highlighter (#4090)
• Align hooks implementation with documentation (#4104)
• Fix the deprecation warning in the doctor command (#4114)
• Fix case in :title and add :slug which is downcased (#4100)

Development Fixes

• Fix test warnings when doing rake {test,spec} or script/test (#4078)

Site Enhancements

• Update normalize.css to v3.0.3. (#4085)
• Update Font Awesome to v4.4.0. (#4086)
• Adds a note about installing the jekyll-gist gem to make gist tag work (#4101)
• Align hooks documentation with implementation (#4104)
• Add Jekyll Flickr Plugin to the list of third party plugins (#4111)
• Remove link to now-deleted blog post (#4125)
• Update the liquid syntax in the pagination docs (#4130)
• Add jekyll-language-plugin to plugins.md (#4134)
• Updated to reflect feedback in #4129 (#4137)
• Clarify assets.md based on feedback of #4129 (#4142)
• Re-correct the liquid syntax in the pagination docs (#4140)

3.0.0 / 2015-10-26

Major Enhancements

• Liquid profiler (i.e. know how fast or slow your templates render) (#3762)
• Incremental regeneration (#3116)
• Add Hooks: a new kind of plugin (#3553)
• Upgrade to Liquid 3.0.0 (#3002)
• site.posts is now a Collection instead of an Array (#4055)
• Add basic support for JRuby (commit: 0f4477)
• Drop support for Ruby 1.9.3. (#3235)
• Support Ruby v2.2 (#3234)
• Support RDiscount 2 (#2767)
• Remove most runtime deps (#3323)
• Move to Rouge as default highlighter (#3323)
• Mimic GitHub Pages .html extension stripping behavior in WEBrick (#3452)
• Always include file extension on output files (#3490)
• Improved permalinks for pages and collections (#3538)
• Sunset (i.e. remove) Maruku (#3655)
• Remove support for relative permalinks (#3679)
• Iterate over site.collections as an array instead of a hash. (#3670)
• Adapt StaticFile for collections, config defaults (#3823)
• Add a Code of Conduct for the Jekyll project (#3925)
• Added permalink time variables (#3990)
• Add --incremental flag to enable incremental regen (disabled by default) (#4059)

Minor Enhancements

• Deprecate access to Document#data properties and Collection#docs methods (#4058)
• Sort static files just once, and call site_payload once for all collections (#3204)
• Separate jekyll docs and optimize external gem handling (#3241)
• Improve Site#getConverterImpl and call it Site#find_converter_instance (#3240)
• Use relative path for path Liquid variable in Documents for consistency (#2908)
• Generalize Utils#slugify for any scripts (#3047)
• Added basic microdata to post template in site template (#3189)
• Store log messages in an array of messages. (#3244)
• Allow collection documents to override output property in front matter (#3172)
• Keep file modification times between builds for static files (#3220)
• Only downcase mixed-case categories for the URL (#2571)
• Added per post excerpt_separator functionality (#3274)
• Allow collections YAML to end with three dots (#3134)
• Add mode parameter to slugify Liquid filter (#2918)
• Perf: Markdown#matches should avoid regexp (#3321)
• Perf: Use frozen regular expressions for Utils#slugify (#3321)
• Split off Textile support into jekyll-textile-converter (#3319)
• Improve the navigation menu alignment in the site template on small screens (#3331)
• Show the regeneration time after the initial generation (#3378)
• Site template: Switch default font to Helvetica Neue (#3376)
• Make the include tag a teensy bit faster. (#3391)
• Add pkill -f jekyll to ways to kill. (#3397)
• Site template: collapsed, variable-driven font declaration (#3360)
• Site template: Don’t always show the scrollbar in code blocks (#3419)
• Site template: Remove undefined text class from p element (#3440)
• Site template: Optimize text rendering for legibility (#3382)
• Add draft? method to identify if Post is a Draft & expose to Liquid (#3456)
• Write regeneration metadata even on full rebuild (#3464)
• Perf: Use String#end_with?("/") instead of regexp when checking paths (#3516)
• Docs: document ‘ordinal’ built-in permalink style (#3532)
• Upgrade liquid-c to 3.x (#3531)
• Use consistent syntax for deprecation warning (#3535)
• Added build –destination and –source flags (#3418)
• Site template: remove unused page.meta attribute (#3537)
• Improve the error message when sorting null objects (#3520)
• Added liquid-md5 plugin (#3598)
• Documentation: RR replaced with RSpec Mocks (#3600)
• Documentation: Fix subpath. (#3599)
• Create ‘tmp’ dir for test_tags if it doesn’t exist (#3609)
• Extract reading of data from Site to reduce responsibilities. (#3545)
• Removed the word ‘Jekyll’ a few times from the comments (#3617)
• bin/jekyll: with no args, exit with exit code 1 (#3619)
• Incremental build if destination file missing (#3614)
• Static files mtime liquid should return a Time obj (#3596)
• Use Jekyll::Posts for both LSI indexing and lookup. (#3629)
• Add charset=utf-8 for HTML and XML pages in WEBrick (#3649)
• Set log level to debug when verbose flag is set (#3665)
• Added a mention on the Gemfile to complete the instructions (#3671)
• Perf: Cache Document#to_liquid and invalidate where necessary (#3693)
• Perf: Jekyll::Cleaner#existing_files: Call keep_file_regex and keep_dirs only once, not once per iteration (#3696)
• Omit jekyll/jekyll-help from list of resources. (#3698)
• Add basic jekyll doctor test to detect fsnotify (OSX) anomalies. (#3704)
• Added talk.jekyllrb.com to “Have questions?” (#3694)
• Performance: Sort files only once (#3707)
• Performance: Marshal metadata (#3706)
• Upgrade highlight wrapper from div to figure (#3779)
• Upgrade mime-types to ~> 2.6 (#3795)
• Update windows.md with Ruby version info (#3818)
• Make the directory for includes configurable (#3782)
• Rename directory configurations to match *_dir convention for consistency (#3782)
• Internal: trigger hooks by owner symbol (#3871)
• Update MIME types from mime-db (#3933)
• Add header to site template _config.yml for clarity & direction (#3997)
• Site template: add timezone offset to post date frontmatter (#4001)
• Make a constant for the regex to find hidden files (#4032)
• Site template: refactor github & twitter icons into includes (#4049)
• Site template: add background to Kramdown Rouge-ified backtick code blocks (#4053)

Bug Fixes

• post_url: fix access deprecation warning & fix deprecation msg (#4060)
• Perform jekyll-paginate deprecation warning correctly. (#3580)
• Make permalink parsing consistent with pages (#3014)
• time()pre-filter method should accept a Date object (#3299)
• Remove unneeded end tag for link in site template (#3236)
• Kramdown: Use enable_coderay key instead of use_coderay (#3237)
• Unescape Document output path (#2924)
• Fix nav items alignment when on multiple rows (#3264)
• Highlight: Only Strip Newlines/Carriage Returns, not Spaces (#3278)
• Find variables in front matter defaults by searching with relative file path. (#2774)
• Allow variables (e.g :categories) in YAML front matter permalinks (#3320)
• Handle nil URL placeholders in permalinks (#3325)
• Template: Fix nav items alignment when in “burger” mode (#3329)
• Template: Remove !important from nav SCSS introduced in #3329 (#3375)
• The :title URL placeholder for collections should be the filename slug. (#3383)
• Trim the generate time diff to just 3 places past the decimal place (#3415)
• The highlight tag should only clip the newlines before and after the entire block, not in between (#3401)
• highlight: fix problem with linenos and rouge. (#3436)
• Site#read_data_file: read CSV’s with proper file encoding (#3455)
• Ignore .jekyll-metadata in site template (#3496)
• Template: Point documentation link to the documentation pages (#3502)
• Removed the trailing slash from the example /blog baseurl comment (#3485)
• Clear the regenerator cache every time we process (#3592)
• Readd (bring back) minitest-profile (#3628)
• Add WOFF2 font MIME type to Jekyll server MIME types (#3647)
• Be smarter about extracting the extname in StaticFile (#3632)
• Process metadata for all dependencies (#3608)
• Show error message if the YAML front matter on a page/post is invalid. (#3643)
• Upgrade redcarpet to 3.2 (Security fix: OSVDB-120415) (#3652)
• Create #mock_expects that goes directly to RSpec Mocks. (#3658)
• Open .jekyll-metadata in binary mode to read binary Marshal data (#3713)
• Incremental regeneration: handle deleted, renamed, and moved dependencies (#3717)
• Fix typo on line 19 of pagination.md (#3760)
• Fix it so that ‘blog.html’ matches ‘blog.html’ (#3732)
• Remove occasionally-problematic ensure in LiquidRenderer (#3811)
• Fixed an unclear code comment in site template SCSS (#3837)
• Fix reading of binary metadata file (#3845)
• Remove var collision with site template header menu iteration variable (#3838)
• Change non-existent hl_linenos to hl_lines to allow passthrough in safe mode (#3787)
• Add missing flag to disable the watcher (#3820)
• Update CI guide to include more direct explanations of the flow (#3891)
• Set future to false in the default config (#3892)
• filters: where should compare stringified versions of input & comparator (#3935)
• Read build options for jekyll clean command (#3828)
• Fix #3970: Use Gem::Version to compare versions, not >.
• Abort if no subcommand. Fixes confusing message. (#3992)
• Whole-post excerpts should match the post content (#4004)
• Change default font weight to 400 to fix bold/strong text issues (#4050)
• Document: Only auto-generate the excerpt if it’s not overridden (#4062)
• Utils: deep_merge_hashes should also merge default_proc (45f69bb)
• Defaults: compare paths in applies_path? as Strings to avoid confusion (7b81f00)

Development Fixes

• Remove loader.rb and “modernize” script/test. (#3574)
• Improve the grammar in the documentation (#3233)
• Update the LICENSE text to match the MIT license exactly (#3253)
• Update rake task site:publish to fix minor bugs. (#3254)
• Switch to shields.io for the README badges. (#3255)
• Use FileList instead of Dir.glob in site:publish rake task (#3261)
• Fix test script to be platform-independent (#3279)
• Instead of symlinking /tmp, create and symlink a local tmp in the tests (#3258)
• Fix some spacing (#3312)
• Fix comment typo in lib/jekyll/frontmatter_defaults.rb (#3322)
• Move all regenerate? checking to Regenerator (#3326)
• Factor out a read_data_file call to keep things clean (#3380)
• Proof the site with CircleCI. (#3427)
• Update LICENSE to 2015. (#3477)
• Upgrade tests to use Minitest (#3492)
• Remove trailing whitespace (#3497)
• Use fixture_site for Document tests (#3511)
• Remove adapters deprecation warning (#3529)
• Minor fixes to url.rb to follow GitHub style guide (#3544)
• Minor changes to resolve deprecation warnings (#3547)
• Convert remaining textile test documents to markdown (#3528)
• Migrate the tests to use rspec-mocks (#3552)
• Remove activesupport (#3612)
• Added tests for Jekyll:StaticFile (#3633)
• Force minitest version to 5.5.1 (#3657)
• Update the way cucumber accesses Minitest assertions (#3678)
• Add script/rubyprof to generate cachegrind callgraphs (#3692)
• Upgrade cucumber to 2.x (#3795)
• Update Kramdown. (#3853)
• Updated the scripts shebang for portability (#3858)
• Update JRuby testing to 9K (3ab386f)
• Organize dependencies into dev and test groups. (#3852)
• Contributing.md should refer to script/cucumber (#3894)
• Update contributing documentation to reflect workflow updates (#3895)
• Add script to vendor mime types (#3933)
• Ignore .bundle dir in SimpleCov (#4033)

Site Enhancements

• Add ‘info’ labels to certain notes in collections docs (#3601)
• Remove extra spaces, make the last sentence less awkward in permalink docs (#3603)
• Update the permalinks documentation to reflect the updates for 3.0 (#3556)
• Add blog post announcing Jekyll Help (#3523)
• Add Jekyll Talk to Help page on site (#3518)
• Change Ajax pagination resource link to use HTTPS (#3570)
• Fixing the default host on docs (#3229)
• Add jekyll-thumbnail-filter to list of third-party plugins (#2790)
• Add link to ‘Adding Ajax pagination to Jekyll’ to Resources page (#3186)
• Add a Resources link to tutorial on building dynamic navbars (#3185)
• Semantic structure improvements to the post and page layouts (#3251)
• Add new AsciiDoc plugin to list of third-party plugins. (#3277)
• Specify that all transformable collection documents must contain YAML front matter (#3271)
• Assorted accessibility fixes (#3256)
• Update configuration docs to mention keep_files for destination (#3288, #3296)
• Break when we successfully generate nav link to save CPU cycles. (#3291)
• Update usage docs to mention keep_files and a warning about destination cleaning (#3295)
• Add logic to automatically generate the next_section and prev_section navigation items (#3292)
• Some small fixes for the Plugins TOC. (#3306)
• Added versioning comment to configuration file (#3314)
• Add jekyll-minifier to list of third-party plugins (#3333)
• Add blog post about the Jekyll meet-up (#3332)
• Use highlight Liquid tag instead of the four-space tabs for code (#3336)
• 3.0.0.beta1 release post (#3346)
• Add twa to the list of third-party plugins (#3384)
• Remove extra spaces (#3388)
• Fix small grammar errors on a couple pages (#3396)
• Fix typo on Templates docs page (#3420)
• s/three/four for plugin type list (#3424)
• Release jekyllrb.com as a locally-compiled site. (#3426)
• Add a jekyllrb.com/help page which elucidates places from which to get help (#3428)
• Remove extraneous dash on Plugins doc page which caused a formatting error (#3431)
• Fix broken link to Jordan Thornquest’s website. (#3438)
• Change the link to an extension (#3457)
• Fix Twitter link on the help page (#3466)
• Fix wording in code snippet highlighting section (#3475)
• Add a / to paginate_path in the Pagination documentation (#3479)
• Add a link on all the docs pages to “Improve this page”. (#3510)
• Add jekyll-auto-image generator to the list of third-party plugins (#3489)
• Replace link to the proposed picture element spec (#3530)
• Add frontmatter date formatting information (#3469)
• Improve consistency and clarity of plugins options note (#3546)
• Add permalink warning to pagination docs (#3551)
• Fix grammar in Collections docs API stability warning (#3560)
• Restructure excerpt_separator documentation for clarity (#3550)
• Fix accidental line break in collections docs (#3585)
• Add information about the .jekyll-metadata file (#3597)
• Document addition of variable parameters to an include (#3581)
• Add jekyll-files to the list of third-party plugins. (#3586)
• Define the install step in the CI example .travis.yml (#3622)
• Expand collections documentation. (#3638)
• Add the “warning” note label to excluding vendor in the CI docs page (#3623)
• Upgrade pieces of the Ugrading guide for Jekyll 3 (#3607)
• Showing how to access specific data items (#3468)
• Clarify pagination works from within HTML files (#3467)
• Add note to excerpt_separator documentation that it can be set globally (#3667)
• Fix some names on Troubleshooting page (#3683)
• Add remote_file_content tag plugin to list of third-party plugins (#3691)
• Update the Redcarpet version on the Configuration page. (#3743)
• Update the link in the welcome post to point to Jekyll Talk (#3745)
• Update link for navbars with data attributes tutorial (#3728)
• Add jekyll-asciinema to list of third-party plugins (#3750)
• Update pagination example to be agnostic to first pagination dir (#3763)
• Detailed instructions for rsync deployment method (#3848)
• Add Jekyll Portfolio Generator to list of plugins (#3883)
• Add site.html_files to variables docs (#3880)
• Add Static Publisher tool to list of deployment methods (#3865)
• Fix a few typos. (#3897)
• Add jekyll-youtube to the list of third-party plugins (#3931)
• Add Views Router plugin (#3950)
• Update install docs (Core dependencies, Windows reqs, etc) (#3769)
• Use Jekyll Feed for jekyllrb.com (#3736)
• Add jekyll-umlauts to plugins.md ($3966)
• Troubleshooting: fix broken link, add other mac-specific info (#3968)
• Add a new site for learning purposes (#3917)
• Added documentation for Jekyll environment variables (#3989)
• Fix broken configuration documentation page (#3994)
• Add troubleshooting docs for installing on El Capitan (#3999)
• Add Lazy Tweet Embedding to the list of third-party plugins (#4015)
• Add installation instructions for 2 of 3 options for plugins (#4013)
• Add alternative jekyll gem installation instructions (#4018)
• Fix a few typos and formatting problems. (#4022)
• Fix pretty permalink example (#4029)
• Note that _config.yml is not reloaded during regeneration (#4034)
• Apply code block figure syntax to blocks in CONTRIBUTING (#4046)
• Add jekyll-smartify to the list of third-party plugins (#3572)

2.5.3 / 2014-12-22

Bug Fixes

• When checking a Markdown extname, include position of the . (#3147)
• Fix jsonify Liquid filter handling of boolean values (#3154)
• Add comma to value of viewport meta tag (#3170)
• Set the link type for the RSS feed to application/rss+xml (#3176)
• Refactor #as_liquid (#3158)

Development Fixes

• Exclude built-in bundles from being added to coverage report (#3180)

Site Enhancements

• Add [@alfredxing](https://github.com/alfredxing) to the [@jekyll](https://github.com/jekyll)/core team. :tada: (#3218)
• Document the -q option for the build and serve commands (#3149)
• Fix some minor typos/flow fixes in documentation website content (#3165)
• Add keep_files to configuration documentation (#3162)
• Repeat warning about cleaning of the destination directory (#3161)
• Add jekyll-500px-embed to list of third-party plugins (#3163)
• Simplified platform detection in Gemfile example for Windows (#3177)
• Add the jekyll-jalali plugin added to the list of third-party plugins. (#3198)
• Add Table of Contents to Troubleshooting page (#3196)
• Add inline_highlight plugin to list of third-party plugins (#3212)
• Add jekyll-mermaid plugin to list of third-party plugins (#3222)

2.5.2 / 2014-11-17

Minor Enhancements

• post_url should match post.name instead of slugs and dates (#3058)

Bug Fixes

• Fix bundle require for :jekyll_plugins (#3119)
• Remove duplicate regexp phrase: ^\A (#3089)
• Remove duplicate Conversion error: message in Convertible (#3088)
• Print full conversion error message in Renderer#convert (#3090)

Site Enhancements

• Change variable names in Google Analytics script (#3093)
• Mention CSV files in the docs for data files (#3101)
• Add trailing slash to paginate_path example. (#3091)
• Get rid of noifniof (excerpt_separator) (#3094)
• Sass improvements, around nesting mostly. (#3123)
• Add webmentions.io plugin to the list of third-party plugins (#3127)
• Add Sass mixins and use them. (#2904)
• Slightly compress jekyll-sticker.jpg. (#3133)
• Update gridism and separate out related but custom styles. (#3132)
• Add remote-include plugin to list of third-party plugins (#3136)

2.5.1 / 2014-11-09

Bug Fixes

• Fix path sanitation bug related to Windows drive names (#3077)

Development Fixes

• Add development time dependencies on minitest and test-unit to gemspec for cygwin (#3064)
• Use Travis’s built-in caching. (#3075)

2.5.0 / 2014-11-06

Minor Enhancements

• Require gems in :jekyll_plugins Gemfile group unless JEKYLL_NO_BUNDLER_REQUIRE is specified in the environment. (#2865)
• Centralize path sanitation in the Site object (#2882)
• Allow placeholders in permalinks (#3031)
• Allow users to specify the log level via JEKYLL_LOG_LEVEL. (#3067)
• Fancy Indexing with WEBrick (#3018)
• Allow Enumerables to be used with where filter. (#2986)
• Meta descriptions in the site template now use page.excerpt if it’s available (#2964)
• Change indentation in head.html of site template to 2 spaces from 4 (#2973)
• Use a $content-width variable instead of a fixed value in the site template CSS (#2972)
• Strip newlines in site template <meta> description. (#2982)
• Add link to atom feed in head of site template files (#2996)
• Performance optimizations (#2994)
• Use Hash#each_key instead of Hash#keys.each to speed up iteration over hash keys. (#3017)
• Further minor performance enhancements. (#3022)
• Add ‘b’ and ‘s’ aliases for build and serve, respectively (#3065)

Bug Fixes

• Fix Rouge’s RedCarpet plugin interface integration (#2951)
• Remove --watch from the site template blog post since it defaults to watching in in 2.4.0 (#2922)
• Fix code for media query mixin in site template (#2946)
• Allow post URL’s to have .htm extensions (#2925)
• Utils.slugify: Don’t create new objects when gsubbing (#2997)
• The jsonify filter should deep-convert to Liquid when given an Array. (#3032)
• Apply jsonify filter to Hashes deeply and effectively (#3063)
• Use 127.0.0.1 as default host instead of 0.0.0.0 (#3053)
• In the case that a Gemfile does not exist, ensure Jekyll doesn’t fail on requiring the Gemfile group (#3066)

Development Fixes

• Fix a typo in the doc block for Jekyll::URL.escape_path (#3052)
• Add integration test for jekyll new --blank in TestUnit (#2913)
• Add unit test for jekyll new --force logic (#2929)
• Update outdated comment for Convertible#transform (#2957)
• Add Hakiri badge to README. (#2953)
• Add some simple benchmarking tools. (#2993)

Site Enhancements

• NOKOGIRI_USE_SYSTEM_LIBRARIES=true decreases installation time. (#3040)
• Add FormKeep to resources as Jekyll form backend (#3010)
• Fixing a mistake in the name of the new Liquid tag (#2969)
• Update Font Awesome to v4.2.0. (#2898)
• Fix link to #2895 in 2.4.0 release post. (#2899)
• Add Big Footnotes for Kramdown plugin to list of third-party plugins (#2916)
• Remove warning regarding GHP use of singular types for front matter defaults (#2919)
• Fix quote character typo in site documentation for templates (#2917)
• Point Liquid links to Liquid’s GitHub wiki (#2887)
• Add HTTP Basic Auth (.htaccess) plugin to list of third-party plugins (#2931)
• (Minor) Grammar & _config.yml filename fixes (#2911)
• Added mathml.rb to the list of third-party plugins. (#2937)
• Add --force_polling to the list of configuration options (#2943)
• Escape unicode characters in site CSS (#2906)
• Add note about using the github-pages gem via pages.github.com/versions.json (#2939)
• Update usage documentation to reflect 2.4 auto-enabling of --watch. (#2954)
• Add --skip-initial-build to configuration docs (#2949)
• Fix a minor typo in Templates docs page (#2959)
• Add a ditaa-ditaa plugin under Other section on the Plugins page (#2967)
• Add build/serve -V option to configuration documentation (#2948)
• Add ‘Jekyll Twitter Plugin’ to list of third-party plugins (#2979)
• Docs: Update normalize.css to v3.0.2. (#2981)
• Fix typo in Continuous Integration documentation (#2984)
• Clarify behavior of :categories in permalinks (#3011)

2.4.0 / 2014-09-09

Minor Enhancements

• Support a new relative_include tag (#2870)
• Auto-enable watch on ‘serve’ (#2858)
• Render Liquid in CoffeeScript files (#2830)
• Array Liquid filters: push, pop, unshift, shift (#2895)
• Add :title to collection URL template fillers (#2864)
• Add support for CSV files in the _data directory (#2761)
• Add the name variable to collection permalinks (#2799)
• Add inspect liquid filter. (#2867)
• Add a slugify Liquid filter (#2880)

Bug Fixes

• Use Jekyll.sanitized_path when adding static files to Collections (#2849)
• Fix encoding of main.scss in site template (#2771)
• Fix orientation bugs in default site template (#2862)

Development Fixes

• Update simplecov gem to 0.9 (#2748)
• Remove docs/ dir (#2768)
• add class << self idiom to New command (#2817)
• Allow Travis to ‘parallelize’ our tests (#2859)
• Fix test for Liquid rendering in Sass (#2856)
• Fixing “vertycal” typo in site template’s _base.scss (#2889)

Site Enhancements

• Document the name variable for collection permalinks (#2829)
• Adds info about installing jekyll in current dir (#2839)
• Remove deprecated jekyll-projectlist plugin from list of third-party plugins (#2742)
• Remove tag plugins that are built in to Jekyll (#2751)
• Add markdown-writer package for Atom Editor to list of third-party plugins (#2763)
• Fix typo in site documentation for collections (#2764)
• Fix minor typo on plugins docs page (#2765)
• Replace markdown with HTML in sass_dir note on assets page (#2791)
• Fixed “bellow” typo in datafiles docs (#2879)
• Fix code/markdown issue in documentation for variables (#2877)
• Remove Good Include third-party plugin from plugins page (#2881)
• Add some more docs on include_relative (#2884)

2.3.0 / 2014-08-10

Minor Enhancements

• Allow Convertibles to be converted by >= 1 converters (#2704)
• Allow Sass files to be rendered in Liquid, but never place them in layouts. (#2733)
• Add jekyll help command (#2707)
• Use .scss for site_template styles. (#2667)
• Don’t require the scope key in front matter defaults (#2659)
• No longer set permalink: pretty in the _config.yml for the site template (#2680)
• Rework site template to utilize Sass (#2687)
• Notify the user when auto-regeneration is disabled. (#2696)
• Allow partial variables in include tag filename argument (#2693)
• Move instances of Time.parse into a Utils method (#2682)
• Ignore subfolders in the _posts folder (#2705) REVERTS (#2633)
• Front Matter default types should always be pluralized (#2732)
• Read in static files into collection.files as StaticFiles (#2737)
• Add sassify and scssify Liquid filters (#2739)
• Replace classifier gem with classifier-reborn (#2721)

Bug Fixes

• Use only the last extname when multiple converters exist (#2722)
• Call #to_liquid before calling #to_json in jsonify filter (#2729)
• Use non padded config in strftime to avoid parse string twice (#2673)
• Replace deprecated Ruby methods with undeprecated ones (#2664)
• Catch errors when parsing Post date front matter value & produce nice error message (#2649)
• Allow static files in Collections (#2615)
• Fixed typo in Deprecator#gracefully_require error message (#2694)
• Remove preemptive loading of the ‘classifier’ gem. (#2697)
• Use case-insensitive checking for the file extensions when loading config files (#2718)
• When Reading Documents, Respect encoding Option (#2720)
• Refactor based on jekyll-watch clean-up. (#2716)
• Document#to_s should produce just the content of the document (#2731)

Development Fixes

• Only include lib files in the gem (#2671)
• Fix git diff command in proof script (#2672)
• Make default rake task a multitask so tests run in parallel (#2735)

Site Enhancements

• Use Sass and a Docs Collection (#2651)
• Add latest_version.txt file to the site (#2740)
• Be more ambiguous about page.content. But more transparent. (#2522)
• Streamlining front matter wording (instead of front-matter/frontmatter) (#2674)
• Add note that source directory cannot be modified in GitHub Pages (#2669)
• Fix links from #2669 to be actual HTML. Whoops. (#2679)
• Add link to jekyll-slim in list of third-party plugins (#2689)
• Add Barry Clark’s Smashing Magazine tutorial to resources page (#2688)
• Reorganize and update default configuration settings (#2456)
• Fixing indentation in the configuration docs about Redcarpet exts (#2717)
• Use null in YAML instead of nil in default config list (#2719)
• Fix typo in Continuous Integration docs (#2708)

2.2.0 / 2014-07-29

Minor Enhancements

• Throw a warning if the specified layout does not exist (#2620)
• Whitelist Pygments options in safe mode (#2642)

Bug Fixes

• Remove unnecessary Jekyll::Tags::IncludeTag#blank? method (#2625)
• Categories in the path are ignored (#2633)

Development Fixes

• Refactoring Errors & Requires of Third-Party stuff (#2591)
• Add further tests for categories (#2584)
• Proof site with html-proofer on change (#2605)
• Fix up bug in #2605 which caused proofing the site not to function (#2608)
• Use bundle exec in script/proof (#2610)

Site Enhancements

• Update Kramdown urls (#2588)
• Add Jekyll::AutolinkEmail and Jekyll::GitMetadata to the list of third-party plugins (#2596)
• Fix a bunch of broken links in the site (#2601)
• Replace dead links with working links (#2611)
• Add jekyll-hook to deployment methods (#2617)
• Added kramdown-with-pygments plugin to the list of third-party plugins (#2623)
• Update outdated “Extras” page and remove duplicate documentation (#2622)
• Add co2 plugin to list of third-party plugins (#2639)
• Attempt to clarify the way Sass imports happen (#2642)

2.1.1 / 2014-07-01

Bug Fixes

• Patch read vulnerabilities for data & confirm none for layouts (#2563)
• Update Maruku dependency to allow use of the latest version (#2576)
• Remove conditional assignment from document URL to prevent stale urls (#2575)

Site Enhancements

• Add vertical margin to highlight to separate code blocks (#2558)
• Add html_pages to Variables docs (#2567)
• Fixed broken link to Permalinks page (#2572)
• Update link to Windows installation guide (#2578)

2.1.0 / 2014-06-28

Minor Enhancements

• Bump to the latest Liquid version, 2.6.1 (#2495)
• Add support for JSON files in the _data directory (#2369)
• Allow subclasses to override EXCERPT_ATTRIBUTES_FOR_LIQUID (#2408)
• Add Jekyll.env and jekyll.environment (the Liquid var) (#2417)
• Use _config.yaml or _config.yml (.yml takes precedence) (#2406)
• Override collection url template (#2418)
• Allow subdirectories in _data (#2395)
• Extract Pagination Generator into gem: jekyll-paginate (#2455)
• Utilize date_to_rfc822 filter in site template (#2437)
• Add categories, last build datetime, and generator to site template feed (#2438)
• Configurable, replaceable Logger-compliant logger (#2444)
• Extract gist tag into a separate gem (#2469)
• Add collection attribute to Document#to_liquid to access the document’s collection label. (#2436)
• Upgrade listen to 2.7.6 <= x < 3.0.0 (#2492)
• Allow configuration of different Twitter and GitHub usernames in site template (#2485)
• Bump Pygments to v0.6.0 (#2504)
• Front matter defaults for documents in collections (#2419)
• Include files with a url which ends in / in the site.html_pages list (#2524)
• Make highlight tag use language- prefix in CSS class (#2511)
• Lookup item property via item#to_liquid before #data or #[] in filters (#2493)
• Skip initial build of site on serve with flag (#2477)
• Add support for hl_lines in highlight tag (#2532)
• Spike out --watch flag into a separate gem (#2550)

Bug Fixes

• Liquid sort filter should sort even if one of the values is nil (#2345)
• Remove padding on pre code in the site template CSS (#2383)
• Set log_level earlier to silence info level configuration output (#2393)
• Only list pages which have title in site template (#2411)
• Accept Numeric values for dates, not Number values (#2377)
• Prevent code from overflowing container in site template (#2429)
• Encode URLs in UTF-8 when escaping and unescaping (#2420)
• No Layouts or Liquid for Asset Files (#2431)
• Allow front matter defaults to set post categories (#2373)
• Fix command in subcommand deprecation warning (#2457)
• Keep all parent directories of files/dirs in keep_files (#2458)
• When using RedCarpet and Rouge without Rouge installed, fixed erroneous error which stated that redcarpet was missing, not rouge. (#2464)
• Ignore all directories and files that merit it on auto-generation (#2459)
• Before copying file, explicitly remove the old one (#2535)
• Merge file system categories with categories from YAML. (#2531)
• Deep merge front matter defaults (#2490)
• Ensure exclude and include arrays are arrays of strings (#2542)
• Allow collections to have dots in their filenames (#2552)
• Collections shouldn’t try to read in directories as files (#2552)
• Be quiet very quickly. (#2520)

Development Fixes

• Test Ruby 2.1.2 instead of 2.1.1 (#2374)
• Add test for sorting UTF-8 characters (#2384)
• Use https for GitHub links in documentation (#2470)
• Remove coverage reporting with Coveralls (#2494)
• Fix a bit of missing TomDoc to Jekyll::Commands::Build#build (#2554)

Site Enhancements

• Set timezone to America/Los_Angeles (#2394)
• Improve JavaScript in anchor_links.html (#2368)
• Remove note on Quickstart page about default markdown converter (#2387)
• Remove broken link in extras.md to a Maruku fork (#2401)
• Update Font Awesome to v4.1.0. (#2410)
• Fix broken link on Installation page to Templates page (#2421)
• Prevent table from extending parent width in permalink style table (#2424)
• Add collections to info about pagination support (#2389)
• Add jekyll_github_sample plugin to list of third-party plugins (#2463)
• Clarify documentation around front matter defaults and add details about defaults for collections. (#2439)
• Add Jekyll Project Version Tag to list of third-party plugins (#2468)
• Use https for GitHub links across whole site (#2470)
• Add StickerMule + Jekyll post (#2476)
• Add Jekyll Asset Pipeline Reborn to list of third-party plugins (#2479)
• Add link to jekyll-compress-html to list of third-party plugins (#2514)
• Add Piwigo Gallery to list of third-party plugins (#2526)
• Set show_drafts to false in default configuration listing (#2536)
• Provide an updated link for Windows installation instructions (#2544)
• Remove url from configuration docs (#2547)
• Documentation for Continuous Integration for your Jekyll Site (#2432)

2.0.3 / 2014-05-08

Bug Fixes

• Properly prefix links in site template with URL or baseurl depending upon need. (#2319)
• Update gist tag comments and error message to require username (#2326)
• Fix permalink setting in site template (#2331)
• Don’t fail if any of the path objects are nil (#2325)
• Instantiate all descendants for converters and generators, not just direct subclasses (#2334)
• Replace all instances of site.name with site.title in site template (#2324)
• Jekyll::Filters#time now accepts UNIX timestamps in string or number form (#2339)
• Use item_property for where filter so it doesn’t break on collections (#2359)
• Rescue errors thrown so --watch doesn’t fail (#2364)

Site Enhancements

• Add missing “as” to assets docs page (#2337)
• Update docs to reflect new baseurl default (#2341)
• Add links to headers who have an ID. (#2342)
• Use symbol instead of HTML number in upgrading.md (#2351)
• Fix link to front matter defaults docs (#2353)
• Fix for History.markdown in order to fix history page in docs (#2363)

2.0.2 / 2014-05-07

Bug Fixes

• Correct use of url and baseurl in the site template. (#2317)
• Default baseurl to "" (#2317)

Site Enhancements

• Correct docs for the gist plugin so it always includes the username. (#2314)
• Clarify new (defaults, where filter) features in docs (#2316)

2.0.1 / 2014-05-06

Bug Fixes

• Require kramdown gem instead of maruku gem

2.0.0 / 2014-05-06

Major Enhancements

• Add “Collections” feature (#2199)
• Add gem-based plugin whitelist to safe mode (#1657)
• Replace the commander command line parser with a more robust solution for our needs called mercenary (#1706)
• Remove support for Ruby 1.8.x (#1780)
• Move to jekyll/jekyll from mojombo/jekyll (#1817)
• Allow custom markdown processors (#1872)
• Provide support for the Rouge syntax highlighter (#1859)
• Provide support for Sass (#1932)
• Provide a 300% improvement when generating sites that use Post#next or Post#previous (#1983)
• Provide support for CoffeeScript (#1991)
• Replace Maruku with Kramdown as Default Markdown Processor (#1988)
• Expose site.static_files to Liquid (#2075)
• Complete redesign of the template site generated by jekyll new (#2050)
• Update Listen from 1.x to 2.x (#2097)
• Front matter defaults (#2205)
• Deprecate relative_permalinks configuration option (default to false) (#2307)
• Exclude files based on prefix as well as fnmatch? (#2303)

Minor Enhancements

• Move the EntryFilter class into the Jekyll module to avoid polluting the global namespace (#1800)
• Add group_by Liquid filter create lists of items grouped by a common property’s value (#1788)
• Add support for Maruku’s fenced_code_blocks option (#1799)
• Update Redcarpet dependency to ~> 3.0 (#1815)
• Automatically sort all pages by name (#1848)
• Better error message when time is not parseable (#1847)
• Allow include tag variable arguments to use filters (#1841)
• post_url tag should raise ArgumentError for invalid name (#1825)
• Bump dependency mercenary to ~> 0.2.0 (#1879)
• Bump dependency safe_yaml to ~> 1.0 (#1886)
• Allow sorting of content by custom properties (#1849)
• Add --quiet flag to silence output during build and serve (#1898)
• Add a where filter to filter arrays based on a key/value pair (#1875)
• Route 404 errors to a custom 404 page in development (#1899)
• Excludes are now relative to the site source (#1916)
• Bring MIME Types file for jekyll serve to complete parity with GH Pages servers (#1993)
• Adding Breakpoint to make new site template more responsive (#2038)
• Default to using the UTF-8 encoding when reading files. (#2031)
• Update Redcarpet dependency to ~> 3.1 (#2044)
• Remove support for Ruby 1.9.2 (#2045)
• Add .mkdown as valid Markdown extension (#2048)
• Add index.xml to the list of WEBrick directory index files (#2041)
• Make the layouts config key relative to CWD or to source (#2058)
• Update Kramdown to ~> 1.3 (#1894)
• Remove unnecessary references to self (#2090)
• Update to Mercenary v0.3.x (#2085)
• Ship Sass support as a separate gem (#2098)
• Extract core extensions into a Utils module (#2112)
• Refactor CLI & Commands For Greater Happiness (#2143)
• Provide useful error when Pygments returns nil and error out (#2148)
• Add support for unpublished drafts (#2164)
• Add force_polling option to the serve command (#2165)
• Clean up the <head> in the site template (#2186)
• Permit YAML blocks to end with three dots to better conform with the YAML spec (#2110)
• Use File.exist? instead of deprecated File.exists? (#2214)
• Require newline after start of YAML Front Matter header (#2211)
• Add the ability for pages to be marked as published: false (#1492)
• Add Jekyll::LiquidExtensions with .lookup_variable method for easy looking up of variable values in a Liquid context. (#2253)
• Remove literal lang name from class (#2292)
• Return utf-8 encoding in header for webrick error page response (#2289)
• Make template site easier to customize (#2268)
• Add two-digit year to permalink template option (#2301)
• Add site.documents to Liquid payload (list of all docs) (#2295)
• Take into account missing values in the Liquid sort filter (#2299)

Bug Fixes

• Don’t allow nil entries when loading posts (#1796)
• Remove the scrollbar that’s always displayed in new sites generated from the site template (#1805)
• Add #path to required methods in Jekyll::Convertible (#1866)
• Default Maruku fenced code blocks to ON for 2.0.0-dev (#1831)
• Change short opts for host and port for jekyll docs to be consistent with other subcommands (#1877)
• Fix typos (#1910)
• Lock Maruku at 0.7.0 to prevent bugs caused by Maruku 0.7.1 (#1958)
• Fixes full path leak to source directory when using include tag (#1951)
• Don’t generate pages that aren’t being published (#1931)
• Use SafeYAML.load to avoid conflicts with other projects (#1982)
• Relative posts should never fail to build (#1976)
• Remove executable bits of non executable files (#2056)
• #path for a draft is now _drafts instead of _posts (#2042)
• Patch a couple show-stopping security vulnerabilities (#1946)
• Sanitize paths uniformly, in a Windows-friendly way (#2065, #2109)
• Update gem build steps to work correctly on Windows (#2118)
• Remove obsolete normalize_options method call from bin/jekyll (#2121).
• Remove + characters from Pygments lexer names when adding as a CSS class (#994)
• Remove some code that caused Ruby interpreter warnings (#2178)
• Only strip the drive name if it begins the string (#2175)
• Remove default post with invalid date from site template (#2200)
• Fix Post#url and Page#url escape (#1568)
• Strip newlines from the {% highlight %} block content (#1823)
• Load in rouge only when it’s been requested as the highlighter (#2189)
• Convert input to string before XML escaping (xml_escape liquid filter) (#2244)
• Modify configuration key for Collections and reset properly. (#2238)
• Avoid duplicated output using highlight tag (#2264)
• Only use Jekyll.logger for output (#2307)
• Close the file descriptor in has_yaml_header? (#2310)
• Add output to Document liquid output hash (#2309)

Development Fixes

• Add a link to the site in the README.md file (#1795)
• Add in History and site changes from v1-stable branch (#1836)
• Testing additions on the Excerpt class (#1893)
• Fix the highlight tag feature (#1859)
• Test Jekyll under Ruby 2.1.0 (#1900)
• Add script/cibuild for fun and profit (#1912)
• Use Forwardable for delegation between Excerpt and Post (#1927)
• Rename read_things to read_content (#1928)
• Add script/branding script for ASCII art lovin’ (#1936)
• Update the README to reflect the repo move (#1943)
• Add the project vision to the README (#1935)
• Speed up Travis CI builds by using Rebund (#1985)
• Use Yarp as a Gem proxy for Travis CI (#1984)
• Remove Yarp as a Gem proxy for Travis CI (#2004)
• Move the reading of layouts into its own class (#2020)
• Test Sass import (#2009)
• Switch Maruku and Kramdown in lists of Runtime vs. Development dependencies (#2049)
• Clean up the gemspec for the project (#2095)
• Add Japanese translation of README and CONTRIBUTING docs. (#2081)
• Re-align the tables in Cucumber (#2108)
• Trim trailing spaces and convert tabs to spaces (#2122)
• Fix the failing Travis scenarios due to Cucumber issues (#2155)
• Wrap bundle install in travis_retry to retry when RubyGems fails (#2160)
• Refactor tags and categories (#1639)
• Extract plugin management into its own class (#2197)
• Add missing tests for Command (#2216)
• Update rr link in CONTRIBUTING doc (#2247)
• Streamline Cucumber execution of jekyll subcommands (#2258)
• Refactor Commands::Serve. (#2269)
• Refactor highlight tag (#2154)
• Update Util hash functions with latest from Rails (#2273)
• Workaround for Travis bug (#2290)

Site Enhancements

• Document Kramdown’s GFM parser option (#1791)
• Move CSS to includes & update normalize.css to v2.1.3 (#1787)
• Minify CSS only in production (#1803)
• Fix broken link to installation of Ruby on Mountain Lion blog post on Troubleshooting docs page (#1797)
• Fix issues with 1.4.1 release blog post (#1804)
• Add note about deploying to OpenShift (#1812)
• Collect all Windows-related docs onto one page (#1818)
• Fixed typo in datafiles doc page (#1854)
• Clarify how to access site in docs (#1864)
• Add closing <code> tag to context.registers[:site] note (#1867)
• Fix link to @mojombo’s site source (#1897)
• Add paginate: nil to default configuration in docs (#1896)
• Add link to our License in the site footer (#1889)
• Add a charset note in “Writing Posts” doc page (#1902)
• Disallow selection of path and prompt in bash examples
• Add jekyll-compass to the plugin list (#1923)
• Add note in Posts docs about stripping <p> tags from excerpt (#1933)
• Add additional info about the new exclude behavior (#1938)
• Linkify ‘awesome contributors’ to point to the contributors graph on GitHub (#1940)
• Update docs/sites.md link to GitHub Training materials (#1949)
• Update master with the release info from 1.4.3 (#1947)
• Define docs nav in datafile (#1953)
• Clarify the docs around the naming convention for posts (#1971)
• Add missing next and previous docs for post layouts and templates (#1970)
• Add note to Writing posts page about how to strip html from excerpt (#1962)
• Add jekyll-humanize plugin to plugin list (#1998)
• Add jekyll-font-awesome plugin to plugin list (#1999)
• Add sublime-jekyll to list of Editor plugins (#2001)
• Add vim-jekyll to the list of Editor plugins (#2005)
• Fix non-semantic nesting of p tags in news_item layout (#2013)
• Document destination folder cleaning (#2016)
• Updated instructions for NearlyFreeSpeech.NET installation (#2015)
• Update link to rack-jekyll on “Deployment Methods” page (#2047)
• Fix typo in /docs/configuration (#2073)
• Fix count in docs for site.static_files (#2077)
• Update configuration docs to indicate utf-8 is the default for 2.0.0 and ASCII for 1.9.3 (#2074)
• Add info about unreleased feature to the site (#2061)
• Add whitespace to liquid example in GitHub Pages docs (#2084)
• Clarify the way Sass and CoffeeScript files are read in and output (#2067)
• Add lyche gallery tag plugin link to list of plugins (#2094)
• Add Jekyll Pages Directory plugin to list of plugins (#2096)
• Update Configuration docs page with new markdown extension (#2102)
• Add jekyll-image-set to the list of third-party plugins (#2105)
• Losslessly compress images (#2128)
• Update normalize.css to 3.0.0 (#2126)
• Update modernizr to v2.7.1 (#2129)
• Add jekyll-ordinal to list of third-party plugins (#2150)
• Add jekyll_figure to list of third-party plugins (#2158)
• Clarify the documentation for safe mode (#2163)
• Some HTML tidying (#2130)
• Remove modernizr and use html5shiv.js directly for IE less than v9 (#2131)
• Remove unused images (#2187)
• Use array_to_sentence_string filter when outputting news item categories (#2191)
• Add link to Help repo in primary navigation bar (#2177)
• Switch to using an ico file for the shortcut icon (#2193)
• Use numbers to specify font weights and only bring in font weights used (#2185)
• Add a link to the list of all tz database time zones (#1824)
• Clean-up and improve documentation feed.xml (#2192)
• Remove duplicate entry in list of third-party plugins (#2206)
• Reduce the whitespace in the favicon. (#2213)
• Add jekyll-page-collections to list of third-party plugins (#2215)
• Add a cross-reference about post_url (#2243)
• Add jekyll-live-tiles to list of third-party plugins (#2250)
• Fixed broken link to GitHub training material site source (#2257)
• Update link to help repo, now called jekyll-help (#2277)
• Fix capitalization of ‘Jekyll’ on Deployment Methods page (#2291)
• Include plugins by sonnym in list of third-party plugins (#2297)
• Add deprecated articles keeper filter to list of third-party plugins (#2300)
• Simplify and improve our CSS. (#2127)
• Use black text color for the mobile navbar (#2306)
• Use the built in date filter and site.time for the copyright year. (#2305)
• Update html5shiv to v3.7.2 (#2304)
• Add 2.0.0 release post (#2298)
• Add docs for custom markdown processors (#2298)
• Add docs for where and group_by Liquid filters (#2298)
• Remove notes in docs for unreleased features (#2309)

1.5.1 / 2014-03-27

Bug Fixes

• Only strip the drive name if it begins the string (#2176)

1.5.0 / 2014-03-24

Minor Enhancements

• Loosen safe_yaml dependency to ~> 1.0 (#2167)
• Bump safe_yaml dependency to ~> 1.0.0 (#1942)

Bug Fixes

• Fix issue where filesystem traversal restriction broke Windows (#2167)
• Lock maruku at 0.7.0 (#2167)

Development Fixes

• Lock cucumber at 1.3.11 (#2167)

1.4.3 / 2014-01-13

Bug Fixes

• Patch show-stopping security vulnerabilities (#1944)

1.4.2 / 2013-12-16

Bug Fixes

• Turn on Maruku fenced code blocks by default (#1830)

1.4.1 / 2013-12-09

Bug Fixes

• Don’t allow nil entries when loading posts (#1796)

1.4.0 / 2013-12-07

Major Enhancements

• Add support for TOML config files (#1765)

Minor Enhancements

• Sort plugins as a way to establish a load order (#1682)
• Update Maruku to 0.7.0 (#1775)

Bug Fixes

• Add a space between two words in a Pagination warning message (#1769)
• Upgrade toml gem to v0.1.0 to maintain compat with Ruby 1.8.7 (#1778)

Development Fixes

• Remove some whitespace in the code (#1755)
• Remove some duplication in the reading of posts and drafts (#1779)

Site Enhancements

• Fixed case of a word in the Jekyll v1.3.0 release post (#1762)
• Fixed the mime type for the favicon (#1772)

1.3.1 / 2013-11-26

Minor Enhancements

• Add a --prefix option to passthrough for the importers (#1669)
• Push the paginator plugin lower in the plugin priority order so other plugins run before it (#1759)

Bug Fixes

• Fix the include tag when ran in a loop (#1726)
• Fix errors when using --watch on 1.8.7 (#1730)
• Specify where the include is called from if an included file is missing (#1746)

Development Fixes

• Extract Site#filter_entries into its own object (#1697)
• Enable Travis’ bundle caching (#1734)
• Remove trailing whitespace in some files (#1736)
• Fix a duplicate test name (#1754)

Site Enhancements

• Update link to example Rakefile to point to specific commit (#1741)
• Fix drafts docs to indicate that draft time is based on file modification time, not Time.now (#1695)
• Add jekyll-monthly-archive-plugin and jekyll-category-archive-plugin to list of third-party plugins (#1693)
• Add jekyll-asset-path-plugin to list of third-party plugins (#1670)
• Add emoji-for-jekyll to list of third-part plugins (#1708)
• Fix previous section link on plugins page to point to pagination page (#1707)
• Add org-mode converter plugin to third-party plugins (#1711)
• Point “Blog migrations” page to http://import.jekyllrb.com (#1732)
• Add docs for post_url when posts are in subdirectories (#1718)
• Update the docs to point to example.com (#1448)

1.3.0 / 2013-11-04

Major Enhancements

• Add support for adding data as YAML files under a site’s _data directory (#1003)
• Allow variables to be used with include tags (#1495)
• Allow using gems for plugin management (#1557)

Minor Enhancements

• Decrease the specificity in the site template CSS (#1574)
• Add encoding configuration option (#1449)
• Provide better error handling for Jekyll’s custom Liquid tags (#1514)
• If an included file causes a Liquid error, add the path to the include file that caused the error to the error message (#1596)
• If a layout causes a Liquid error, change the error message so that we know it comes from the layout (#1601)
• Update Kramdown dependency to ~> 1.2 (#1610)
• Update safe_yaml dependency to ~> 0.9.7 (#1602)
• Allow layouts to be in subfolders like includes (#1622)
• Switch to listen for site watching while serving (#1589)
• Add a json liquid filter to be used in sites (#1651)
• Point people to the migration docs when the jekyll-import gem is missing (#1662)

Bug Fixes

• Fix up matching against source and destination when the two locations are similar (#1556)
• Fix the missing pathname require in certain cases (#1255)
• Use + instead of Array#concat when building Post attribute list (#1571)
• Print server address when launching a server (#1586)
• Downgrade to Maruku ~> 0.6.0 in order to avoid changes in rendering (#1598)
• Fix error with failing include tag when variable was file name (#1613)
• Downcase lexers before passing them to pygments (#1615)
• Capitalize the short verbose switch because it conflicts with the built-in Commander switch (#1660)
• Fix compatibility with 1.8.x (#1665)
• Fix an error with the new file watching code due to library version incompatibilities (#1687)

Development Fixes

• Add coverage reporting with Coveralls (#1539)
• Refactor the Liquid include tag (#1490)
• Update launchy dependency to ~> 2.3 (#1608)
• Update rr dependency to ~> 1.1 (#1604)
• Update cucumber dependency to ~> 1.3 (#1607)
• Update coveralls dependency to ~> 0.7.0 (#1606)
• Update rake dependency to ~> 10.1 (#1603)
• Clean up site.rb comments to be more concise/uniform (#1616)
• Use the master branch for the build badge in the readme (#1636)
• Refactor Site#render (#1638)
• Remove duplication in command line options (#1637)
• Add tests for all the coderay options (#1543)
• Improve some of the Cucumber test code (#1493)
• Improve comparisons of timestamps by ignoring the seconds (#1582)

Site Enhancements

• Fix params for JekyllImport::WordPress.process arguments (#1554)
• Add jekyll-suggested-tweet to list of third-party plugins (#1555)
• Link to Liquid’s docs for tags and filters (#1553)
• Add note about installing Xcode on the Mac in the Installation docs (#1561)
• Simplify/generalize pagination docs (#1577)
• Add documentation for the new data sources feature (#1503)
• Add more information on how to create generators (#1590, #1592)
• Improve the instructions for mimicking GitHub Flavored Markdown (#1614)
• Add jekyll-import warning note of missing dependencies (#1626)
• Fix grammar in the Usage section (#1635)
• Add documentation for the use of gems as plugins (#1656)
• Document the existence of a few additional plugins (#1405)
• Document that the date_to_string always returns a two digit day (#1663)
• Fix navigation in the “Working with Drafts” page (#1667)
• Fix an error with the data documentation (#1691)

1.2.1 / 2013-09-14

Minor Enhancements

• Print better messages for detached server. Mute output on detach. (#1518)
• Disable reverse lookup when running jekyll serve (#1363)
• Upgrade RedCarpet dependency to ~> 2.3.0 (#1515)
• Upgrade to Liquid >= 2.5.2, < 2.6 (#1536)

Bug Fixes

• Fix file discrepancy in gemspec (#1522)
• Force rendering of Include tag (#1525)

Development Fixes

• Add a rake task to generate a new release post (#1404)
• Mute LSI output in tests (#1531)
• Update contributor documentation (#1537)

Site Enhancements

• Fix a couple of validation errors on the site (#1511)
• Make navigation menus reusable (#1507)
• Fix link to History page from Release v1.2.0 notes post.
• Fix markup in History file for command line options (#1512)
• Expand 1.2 release post title to 1.2.0 (#1516)

1.2.0 / 2013-09-06

Major Enhancements

• Disable automatically-generated excerpts when excerpt_separator is "". (#1386)
• Add checking for URL conflicts when running jekyll doctor (#1389)

Minor Enhancements

• Catch and fix invalid paginate values (#1390)
• Remove superfluous div.container from the default html template for jekyll new (#1315)
• Add -D short-form switch for the drafts option (#1394)
• Update the links in the site template for Twitter and GitHub (#1400)
• Update dummy email address to example.com domain (#1408)
• Update normalize.css to v2.1.2 and minify; add rake task to update normalize.css with greater ease. (#1430)
• Add the ability to detach the server ran by jekyll serve from it’s controlling terminal (#1443)
• Improve permalink generation for URLs with special characters (#944)
• Expose the current Jekyll version to posts and pages via a new jekyll.version variable (#1481)

Bug Fixes

• Markdown extension matching matches only exact matches (#1382)
• Fixed NoMethodError when message passed to Stevenson#message is nil (#1388)
• Use binary mode when writing file (#1364)
• Fix ‘undefined method encoding for “mailto”’ errors w/ Ruby 1.8 and Kramdown > 0.14.0 (#1397)
• Do not force the permalink to be a dir if it ends on .html (#963)
• When a Liquid Exception is caught, show the full path rel. to site source (#1415)
• Properly read in the config options when serving the docs locally (#1444)
• Fixed --layouts option for build and serve commands (#1458)
• Remove kramdown as a runtime dependency since it’s optional (#1498)
• Provide proper error handling for invalid file names in the include tag (#1494)

Development Fixes

• Remove redundant argument to Jekyll::Commands::New#scaffold_post_content (#1356)
• Add new dependencies to the README (#1360)
• Fix link to contributing page in README (#1424)
• Update TomDoc in Pager#initialize to match params (#1441)
• Refactor Site#cleanup into Jekyll::Site::Cleaner class (#1429)
• Several other small minor refactorings (#1341)
• Ignore _site in jekyllrb.com deploy (#1480)
• Add Gem version and dependency badge to README (#1497)

Site Enhancements

• Add info about new releases (#1353)
• Update plugin list with jekyll-rss plugin (#1354)
• Update the site list page with Ruby’s official site (#1358)
• Add jekyll-ditaa to list of third-party plugins (#1370)
• Add postfiles to list of third-party plugins (#1373)
• For internal links, use full path including trailing / (#1411)
• Use curly apostrophes in the docs (#1419)
• Update the docs for Redcarpet in Jekyll (#1418)
• Add pluralize and reading_time filters to docs (#1439)
• Fix markup for the Kramdown options (#1445)
• Fix typos in the History file (#1454)
• Add trailing slash to site’s post URL (#1462)
• Clarify that --config will take multiple files (#1474)
• Fix docs/templates.md private gist example (#1477)
• Use site.repository for Jekyll’s GitHub URL (#1463)
• Add jekyll-pageless-redirects to list of third-party plugins (#1486)
• Clarify that date_to_xmlschema returns an ISO 8601 string (#1488)
• Add jekyll-good-include to list of third-party plugins (#1491)
• XML escape the blog post title in our feed (#1501)
• Add jekyll-toc-generator to list of third-party plugins (#1506)

1.1.2 / 2013-07-25

Bug Fixes

• Require Liquid 2.5.1 (#1349)

1.1.1 / 2013-07-24

Minor Enhancements

• Remove superfluous table selector from main.css in jekyll new template (#1328)
• Abort with non-zero exit codes (#1338)

Bug Fixes

• Fix up the rendering of excerpts (#1339)

Site Enhancements

• Add Jekyll Image Tag to the plugins list (#1306)
• Remove erroneous statement that site.pages are sorted alphabetically.
• Add info about the _drafts directory to the directory structure docs (#1320)
• Improve the layout of the plugin listing by organizing it into categories (#1310)
• Add generator-jekyllrb and grunt-jekyll to plugins page (#1330)
• Mention Kramdown as option for markdown parser on Extras page (#1318)
• Update Quick-Start page to include reminder that all requirements must be installed (#1327)
• Change filename in include example to an HTML file so as not to indicate that Jekyll will automatically convert them. (#1303)
• Add an RSS feed for commits to Jekyll (#1343)

1.1.0 / 2013-07-14

Major Enhancements

• Add docs subcommand to read Jekyll’s docs when offline. (#1046)
• Support passing parameters to templates in include tag (#1204)
• Add support for Liquid tags to post excerpts (#1302)

Minor Enhancements

• Search the hierarchy of pagination path up to site root to determine template page for pagination. (#1198)
• Add the ability to generate a new Jekyll site without a template (#1171)
• Use redcarpet as the default markdown engine in newly generated sites (#1245, #1247)
• Add redcarpet as a runtime dependency so jekyll build works out-of-the-box for new sites. (#1247)
• In the generated site, remove files that will be replaced by a directory (#1118)
• Fail loudly if a user-specified configuration file doesn’t exist (#1098)
• Allow for all options for Kramdown HTML Converter (#1201)

Bug Fixes

• Fix pagination in subdirectories. (#1198)
• Fix an issue with directories and permalinks that have a plus sign (+) in them (#1215)
• Provide better error reporting when generating sites (#1253)
• Latest posts first in non-LSI related_posts (#1271)

Development Fixes

• Merge the theme and layout Cucumber steps into one step (#1151)
• Restrict activesupport dependency to pre-4.0.0 to maintain compatibility with <= 1.9.2
• Include/exclude deprecation handling simplification (#1284)
• Convert README to Markdown. (#1267)
• Refactor Jekyll::Site (#1144)

Site Enhancements

• Add “News” section for release notes, along with an RSS feed (#1093, #1285, #1286)
• Add “History” page.
• Restructured docs sections to include “Meta” section.
• Add message to “Templates” page that specifies that Python must be installed in order to use Pygments. (#1182)
• Update link to the official Maruku repo (#1175)
• Add documentation about paginate_path to “Templates” page in docs (#1129)
• Give the quick-start guide its own page (#1191)
• Update ProTip on Installation page in docs to point to all the info about Pygments and the ‘highlight’ tag. (#1196)
• Run site/img through ImageOptim (thanks @qrush!) (#1208)
• Added Jade Converter to site/docs/plugins (#1210)
• Fix location of docs pages in Contributing pages (#1214)
• Add ReadInXMinutes plugin to the plugin list (#1222)
• Remove plugins from the plugin list that have equivalents in Jekyll proper (#1223)
• Add jekyll-assets to the plugin list (#1225)
• Add jekyll-pandoc-mulitple-formats to the plugin list (#1229)
• Remove dead link to “Using Git to maintain your blog” (#1227)
• Tidy up the third-party plugins listing (#1228)
• Update contributor information (#1192)
• Update URL of article about Blogger migration (#1242)
• Specify that RedCarpet is the default for new Jekyll sites on Quickstart page (#1247)
• Added site.pages to Variables page in docs (#1251)
• Add Youku and Tudou Embed link on Plugins page. (#1250)
• Add note that gist tag supports private gists. (#1248)
• Add jekyll-timeago to list of third-party plugins. (#1260)
• Add jekyll-swfobject to list of third-party plugins. (#1263)
• Add jekyll-picture-tag to list of third-party plugins. (#1280)
• Update the GitHub Pages documentation regarding relative URLs (#1291)
• Update the S3 deployment documentation (#1294)
• Add suggestion for Xcode CLT install to troubleshooting page in docs (#1296)
• Add ‘Working with drafts’ page to docs (#1289)
• Add information about time zones to the documentation for a page’s date (#1304)

1.0.3 / 2013-06-07

Minor Enhancements

• Add support to gist tag for private gists. (#1189)
• Fail loudly when Maruku errors out (#1190)
• Move the building of related posts into their own class (#1057)
• Removed trailing spaces in several places throughout the code (#1116)
• Add a --force option to jekyll new (#1115)
• Convert IDs in the site template to classes (#1170)

Bug Fixes

• Fix typo in Stevenson constant “ERROR”. (#1166)
• Rename Jekyll::Logger to Jekyll::Stevenson to fix inheritance issue (#1106)
• Exit with a non-zero exit code when dealing with a Liquid error (#1121)
• Make the exclude and include options backwards compatible with versions of Jekyll prior to 1.0 (#1114)
• Fix pagination on Windows (#1063)
• Fix the application of Pygments’ Generic Output style to Go code (#1156)

Site Enhancements

• Add a Pro Tip to docs about front matter variables being optional (#1147)
• Add changelog to site as History page in /docs/ (#1065)
• Add note to Upgrading page about new config options in 1.0.x (#1146)
• Documentation for date_to_rfc822 and uri_escape (#1142)
• Documentation highlight boxes shouldn’t show scrollbars if not necessary (#1123)
• Add link to jekyll-minibundle in the doc’s plugins list (#1035)
• Quick patch for importers documentation
• Fix prefix for WordpressDotCom importer in docs (#1107)
• Add jekyll-contentblocks plugin to docs (#1068)
• Make code bits in notes look more natural, more readable (#1089)
• Fix logic for relative_permalinks instructions on Upgrading page (#1101)
• Add docs for post excerpt (#1072)
• Add docs for gist tag (#1072)
• Add docs indicating that Pygments does not need to be installed separately (#1099, #1119)
• Update the migrator docs to be current (#1136)
• Add the Jekyll Gallery Plugin to the plugin list (#1143)

Development Fixes

• Use Jekyll.logger instead of Jekyll::Stevenson to log things (#1149)
• Fix pesky Cucumber infinite loop (#1139)
• Do not write posts with timezones in Cucumber tests (#1124)
• Use ISO formatted dates in Cucumber features (#1150)

1.0.2 / 2013-05-12

Major Enhancements

• Add jekyll doctor command to check site for any known compatibility problems (#1081)
• Backwards-compatibilize relative permalinks (#1081)

Minor Enhancements

• Add a data-lang="<lang>" attribute to Redcarpet code blocks (#1066)
• Deprecate old config server_port, match to port if port isn’t set (#1084)
• Update pygments.rb version to 0.5.0 (#1061)
• Update Kramdown version to 1.0.2 (#1067)

Bug Fixes

• Fix issue when categories are numbers (#1078)
• Catching that Redcarpet gem isn’t installed (#1059)

Site Enhancements

• Add documentation about relative_permalinks (#1081)
• Remove pygments-installation instructions, as pygments.rb is bundled with it (#1079)
• Move pages to be Pages for realz (#985)
• Updated links to Liquid documentation (#1073)

1.0.1 / 2013-05-08

Minor Enhancements

• Do not force use of toc_token when using generate_tok in RDiscount (#1048)
• Add newer language- class name prefix to code blocks (#1037)
• Commander error message now preferred over process abort with incorrect args (#1040)

Bug Fixes

• Make Redcarpet respect the pygments configuration option (#1053)
• Fix the index build with LSI (#1045)
• Don’t print deprecation warning when no arguments are specified. (#1041)
• Add missing </div> to site template used by new subcommand, fixed typos in code (#1032)

Site Enhancements

• Changed https to http in the GitHub Pages link (#1051)
• Remove CSS cruft, fix typos, fix HTML errors (#1028)
• Removing manual install of Pip and Distribute (#1025)
• Updated URL for Markdown references plugin (#1022)

Development Fixes

• Markdownify history file (#1027)
• Update links on README to point to new jekyllrb.com (#1018)

1.0.0 / 2013-05-06

Major Enhancements

• Add jekyll new subcommand: generate a Jekyll scaffold (#764)
• Refactored Jekyll commands into subcommands: build, serve, and migrate. (#690)
• Removed importers/migrators from main project, migrated to jekyll-import sub-gem (#793)
• Added ability to render drafts in _drafts folder via command line (#833)
• Add ordinal date permalink style (/:categories/:year/:y_day/:title.html) (#928)

Minor Enhancements

• Site template HTML5-ified (#964)
• Use post’s directory path when matching for the post_url tag (#998)
• Loosen dependency on Pygments so it’s only required when it’s needed (#1015)
• Parse strings into Time objects for date-related Liquid filters (#1014)
• Tell the user if there is no subcommand specified (#1008)
• Freak out if the destination of jekyll new exists and is non-empty (#981)
• Add timezone configuration option for compilation (#957)
• Add deprecation messages for pre-1.0 CLI options (#959)
• Refactor and colorize logging (#959)
• Refactor Markdown parsing (#955)
• Added application/vnd.apple.pkpass to mime.types served by WEBrick (#907)
• Move template site to default markdown renderer (#961)
• Expose new attribute to Liquid via page: page.path (#951)
• Accept multiple config files from command line (#945)
• Add page variable to liquid custom tags and blocks (#413)
• Add paginator.previous_page_path and paginator.next_page_path (#942)
• Backwards compatibility for ‘auto’ (#821, #934)
• Added date_to_rfc822 used on RSS feeds (#892)
• Upgrade version of pygments.rb to 0.4.2 (#927)
• Added short month (e.g. “Sep”) to permalink style options for posts (#890)
• Expose site.baseurl to Liquid templates (#869)
• Adds excerpt attribute to posts which contains first paragraph of content (#837)
• Accept custom configuration file via CLI (#863)
• Load in GitHub Pages MIME Types on jekyll serve (#847, #871)
• Improve debugability of error message for a malformed highlight tag (#785)
• Allow symlinked files in unsafe mode (#824)
• Add ‘gist’ Liquid tag to core (#822, #861)
• New format of Jekyll output (#795)
• Reinstate --limit_posts and --future switches (#788)
• Remove ambiguity from command descriptions (#815)
• Fix SafeYAML Warnings (#807)
• Relaxed Kramdown version to 0.14 (#808)
• Aliased jekyll server to jekyll serve. (#792)
• Updated gem versions for Kramdown, Rake, Shoulda, Cucumber, and RedCarpet. (#744)
• Refactored Jekyll subcommands into Jekyll::Commands submodule, which now contains them (#768)
• Rescue from import errors in Wordpress.com migrator (#671)
• Massively accelerate LSI performance (#664)
• Truncate post slugs when importing from Tumblr (#496)
• Add glob support to include, exclude option (#743)
• Layout of Page or Post defaults to ‘page’ or ‘post’, respectively (#580) REPEALED by (#977)
• “Keep files” feature (#685)
• Output full path & name for files that don’t parse (#745)
• Add source and destination directory protection (#535)
• Better YAML error message (#718)
• Bug Fixes
• Paginate in subdirectories properly (#1016)
• Ensure post and page URLs have a leading slash (#992)
• Catch all exceptions, not just StandardError descendents (#1007)
• Bullet-proof limit_posts option (#1004)
• Read in YAML as UTF-8 to accept non-ASCII chars (#836)
• Fix the CLI option --plugins to actually accept dirs and files (#993)
• Allow ‘excerpt’ in YAML front matter to override the extracted excerpt (#946)
• Fix cascade problem with site.baseurl, site.port and site.host. (#935)
• Filter out directories with valid post names (#875)
• Fix symlinked static files not being correctly built in unsafe mode (#909)
• Fix integration with directory_watcher 1.4.x (#916)
• Accepting strings as arguments to jekyll-import command (#910)
• Force usage of older directory_watcher gem as 1.5 is broken (#883)
• Ensure all Post categories are downcase (#842, #872)
• Force encoding of the rdiscount TOC to UTF8 to avoid conversion errors (#555)
• Patch for multibyte URI problem with jekyll serve (#723)
• Order plugin execution by priority (#864)
• Fixed Page#dir and Page#url for edge cases (#536)
• Fix broken post_url with posts with a time in their YAML front matter (#831)
• Look for plugins under the source directory (#654)
• Tumblr Migrator: finds _posts dir correctly, fixes truncation of long post names (#775)
• Force Categories to be Strings (#767)
• Safe YAML plugin to prevent vulnerability (#777)
• Add SVG support to Jekyll/WEBrick. (#407, #406)
• Prevent custom destination from causing continuous regen on watch (#528, #820, #862)

Site Enhancements

• Responsify (#860)
• Fix spelling, punctuation and phrasal errors (#989)
• Update quickstart instructions with new command (#966)
• Add docs for page.excerpt (#956)
• Add docs for page.path (#951)
• Clean up site docs to prepare for 1.0 release (#918)
• Bring site into master branch with better preview/deploy (#709)
• Redesigned site (#583)

Development Fixes

• Exclude Cucumber 1.2.4, which causes tests to fail in 1.9.2 (#938)
• Added “features:html” rake task for debugging purposes, cleaned up Cucumber profiles (#832)
• Explicitly require HTTPS rubygems source in Gemfile (#826)
• Changed Ruby version for development to 1.9.3-p374 from p362 (#801)
• Including a link to the GitHub Ruby style guide in CONTRIBUTING.md (#806)
• Added script/bootstrap (#776)
• Running Simplecov under 2 conditions: ENV(COVERAGE)=true and with Ruby version of greater than 1.9 (#771)
• Switch to Simplecov for coverage report (#765)

0.12.1 / 2013-02-19

Minor Enhancements

• Update Kramdown version to 0.14.1 (#744)
• Test Enhancements
• Update Rake version to 10.0.3 (#744)
• Update Shoulda version to 3.3.2 (#744)
• Update Redcarpet version to 2.2.2 (#744)

0.12.0 / 2012-12-22

Minor Enhancements

• Add ability to explicitly specify included files (#261)
• Add --default-mimetype option (#279)
• Allow setting of RedCloth options (#284)
• Add post_url Liquid tag for internal post linking (#369)
• Allow multiple plugin dirs to be specified (#438)
• Inline TOC token support for RDiscount (#333)
• Add the option to specify the paginated url format (#342)
• Swap out albino for pygments.rb (#569)
• Support Redcarpet 2 and fenced code blocks (#619)
• Better reporting of Liquid errors (#624)
• Bug Fixes
• Allow some special characters in highlight names
• URL escape category names in URL generation (#360)
• Fix error with limit_posts (#442)
• Properly select dotfile during directory scan (#363, #431, #377)
• Allow setting of Kramdown smart_quotes (#482)
• Ensure front matter is at start of file (#562)

0.11.2 / 2011-12-27

• Bug Fixes
• Fix gemspec

0.11.1 / 2011-12-27

• Bug Fixes
• Fix extra blank line in highlight blocks (#409)
• Update dependencies

0.11.0 / 2011-07-10

Major Enhancements

• Add command line importer functionality (#253)
• Add Redcarpet Markdown support (#318)
• Make markdown/textile extensions configurable (#312)
• Add markdownify filter

Minor Enhancements

• Switch to Albino gem
• Bundler support
• Use English library to avoid hoops (#292)
• Add Posterous importer (#254)
• Fixes for Wordpress importer (#274, #252, #271)
• Better error message for invalid post date (#291)
• Print formatted fatal exceptions to stdout on build failure
• Add Tumblr importer (#323)
• Add Enki importer (#320)
• Bug Fixes
• Secure additional path exploits

0.10.0 / 2010-12-16

• Bug Fixes
• Add --no-server option.

0.9.0 / 2010-12-15

Minor Enhancements

• Use OptionParser’s [no-] functionality for better boolean parsing.
• Add Drupal migrator (#245)
• Complain about YAML and Liquid errors (#249)
• Remove orphaned files during regeneration (#247)
• Add Marley migrator (#28)

0.8.0 / 2010-11-22

Minor Enhancements

• Add wordpress.com importer (#207)
• Add --limit-posts cli option (#212)
• Add uri_escape filter (#234)
• Add --base-url cli option (#235)
• Improve MT migrator (#238)
• Add kramdown support (#239)
• Bug Fixes
• Fixed filename basename generation (#208)
• Set mode to UTF8 on Sequel connections (#237)
• Prevent _includes dir from being a symlink

0.7.0 / 2010-08-24

Minor Enhancements

• Add support for rdiscount extensions (#173)
• Bug Fixes
• Highlight should not be able to render local files
• The site configuration may not always provide a ‘time’ setting (#184)

0.6.2 / 2010-06-25

• Bug Fixes
• Fix Rakefile ‘release’ task (tag pushing was missing origin)
• Ensure that RedCloth is loaded when textilize filter is used (#183)
• Expand source, destination, and plugin paths (#180)
• Fix page.url to include full relative path (#181)

0.6.1 / 2010-06-24

• Bug Fixes
• Fix Markdown Pygments prefix and suffix (#178)

0.6.0 / 2010-06-23

Major Enhancements

• Proper plugin system (#19, #100)
• Add safe mode so unsafe converters/generators can be added
• Maruku is now the only processor dependency installed by default. Other processors will be lazy-loaded when necessary (and prompt the user to install them when necessary) (#57)

Minor Enhancements

• Inclusion/exclusion of future dated posts (#59)
• Generation for a specific time (#59)
• Allocate site.time on render not per site_payload invocation (#59)
• Pages now present in the site payload and can be used through the site.pages and site.html_pages variables
• Generate phase added to site#process and pagination is now a generator
• Switch to RakeGem for build/test process
• Only regenerate static files when they have changed (#142)
• Allow arbitrary options to Pygments (#31)
• Allow URL to be set via command line option (#147)
• Bug Fixes
• Render highlighted code for non markdown/textile pages (#116)
• Fix highlighting on Ruby 1.9 (#65)
• Fix extension munging when pretty permalinks are enabled (#64)
• Stop sorting categories (#33)
• Preserve generated attributes over front matter (#119)
• Fix source directory binding using Dir.pwd (#75)

0.5.7 / 2010-01-12

Minor Enhancements

• Allow overriding of post date in the front matter (#62, #38)
• Bug Fixes
• Categories isn’t always an array (#73)
• Empty tags causes error in read_posts (#84)
• Fix pagination to adhere to read/render/write paradigm
• Test Enhancement
• Cucumber features no longer use site.posts.first where a better alternative is available

0.5.6 / 2010-01-08

• Bug Fixes
• Require redcloth >= 4.2.1 in tests (#92)
• Don’t break on triple dashes in yaml front matter (#93)

Minor Enhancements

• Allow .mkd as markdown extension
• Use $stdout/err instead of constants (#99)
• Properly wrap code blocks (#91)
• Add javascript mime type for webrick (#98)

0.5.5 / 2010-01-08

• Bug Fixes
• Fix pagination % 0 bug (#78)
• Ensure all posts are processed first (#71) ## NOTE
• After this point I will no longer be giving credit in the history; that is what the commit log is for.

0.5.4 / 2009-08-23

• Bug Fixes
• Do not allow symlinks (security vulnerability)

0.5.3 / 2009-07-14

• Bug Fixes
• Solving the permalink bug where non-html files wouldn’t work (@jeffrydegrande)

0.5.2 / 2009-06-24

• Enhancements
• Added –paginate option to the executable along with a paginator object for the payload (@calavera)
• Upgraded RedCloth to 4.2.1, which makes <notextile> tags work once again.
• Configuration options set in config.yml are now available through the site payload (@vilcans)
• Posts can now have an empty YAML front matter or none at all (@ bahuvrihi)
• Bug Fixes
• Fixing Ruby 1.9 issue that requires #to_s on the err object (@Chrononaut)
• Fixes for pagination and ordering posts on the same day (@ujh)
• Made pages respect permalinks style and permalinks in yml front matter (@eugenebolshakov)
• Index.html file should always have index.html permalink (@eugenebolshakov)
• Added trailing slash to pretty permalink style so Apache is happy (@eugenebolshakov)
• Bad markdown processor in config fails sooner and with better message (@ gcnovus)
• Allow CRLFs in yaml front matter (@juretta)
• Added Date#xmlschema for Ruby versions < 1.9

0.5.1 / 2009-05-06

Major Enhancements

• Next/previous posts in site payload (@pantulis, @tomo)
• Permalink templating system
• Moved most of the README out to the GitHub wiki
• Exclude option in configuration so specified files won’t be brought over with generated site (@duritong)
• Bug Fixes
• Making sure config.yaml references are all gone, using only config.yml
• Fixed syntax highlighting breaking for UTF-8 code (@henrik)
• Worked around RDiscount bug that prevents Markdown from getting parsed after highlight (@henrik)
• CGI escaped post titles (@Chrononaut)

0.5.0 / 2009-04-07

Minor Enhancements

• Ability to set post categories via YAML (@qrush)
• Ability to set prevent a post from publishing via YAML (@qrush)
• Add textilize filter (@willcodeforfoo)
• Add ‘pretty’ permalink style for wordpress-like urls (@dysinger)
• Made it possible to enter categories from YAML as an array (@Chrononaut)
• Ignore Emacs autosave files (@Chrononaut)
• Bug Fixes
• Use block syntax of popen4 to ensure that subprocesses are properly disposed (@jqr)
• Close open4 streams to prevent zombies (@rtomayko)
• Only query required fields from the WP Database (@ariejan)
• Prevent _posts from being copied to the destination directory (@bdimcheff)
• Refactors
• Factored the filtering code into a method (@Chrononaut)
• Fix tests and convert to Shoulda (@qrush, @technicalpickles)
• Add Cucumber acceptance test suite (@qrush, @technicalpickles)

0.4.1

Minor Enhancements

• Changed date format on wordpress converter (zeropadding) (@dysinger)
• Bug Fixes
• Add Jekyll binary as executable to gemspec (@dysinger)

0.4.0 / 2009-02-03

Major Enhancements

• Switch to Jeweler for packaging tasks

Minor Enhancements

• Type importer (@codeslinger)
• site.topics accessor (@baz)
• Add array_to_sentence_string filter (@mchung)
• Add a converter for textpattern (@PerfectlyNormal)
• Add a working Mephisto / MySQL converter (@ivey)
• Allowing .htaccess files to be copied over into the generated site (@briandoll)
• Add option to not put file date in permalink URL (@mreid)
• Add line number capabilities to highlight blocks (@jcon)
• Bug Fixes
• Fix permalink behavior (@cavalle)
• Fixed an issue with pygments, markdown, and newlines (@zpinter)
• Ampersands need to be escaped (@pufuwozu, @ap)
• Test and fix the site.categories hash (@zzot)
• Fix site payload available to files (@matrix9180)

0.3.0 / 2008-12-24

Major Enhancements

• Added --server option to start a simple WEBrick server on destination directory (@johnreilly and @mchung)

Minor Enhancements

• Added post categories based on directories containing _posts (@mreid)
• Added post topics based on directories underneath _posts
• Added new date filter that shows the full month name (@mreid)
• Merge Post’s YAML front matter into its to_liquid payload (@remi)
• Restrict includes to regular files underneath _includes
• Bug Fixes
• Change YAML delimiter matcher so as to not chew up 2nd level markdown headers (@mreid)
• Fix bug that meant page data (such as the date) was not available in templates (@mreid)
• Properly reject directories in _layouts

0.2.1 / 2008-12-15

• Major Changes
• Use Maruku (pure Ruby) for Markdown by default (@mreid)
• Allow use of RDiscount with --rdiscount flag

Minor Enhancements

• Don’t load directory_watcher unless it’s needed (@pjhyett)

0.2.0 / 2008-12-14

• Major Changes
• related_posts is now found in site.related_posts

0.1.6 / 2008-12-13

• Major Features
• Include files in _includes with {% include x.textile %}

0.1.5 / 2008-12-12

Major Enhancements

• Code highlighting with Pygments if --pygments is specified
• Disable true LSI by default, enable with --lsi

Minor Enhancements

• Output informative message if RDiscount is not available (@JackDanger)
• Bug Fixes
• Prevent Jekyll from picking up the output directory as a source (@JackDanger)
• Skip related_posts when there is only one post (@JackDanger)

0.1.4 / 2008-12-08

• Bug Fixes
• DATA does not work properly with rubygems

0.1.3 / 2008-12-06

• Major Features
• Markdown support (@vanpelt)
• Mephisto and CSV converters (@vanpelt)
• Code hilighting (@vanpelt)
• Autobuild
• Bug Fixes
• Accept both \r\n and \n in YAML header (@vanpelt)

0.1.2 / 2008-11-22

• Major Features
• Add a real “related posts” implementation using Classifier
• Command Line Changes
• Allow cli to be called with 0, 1, or 2 args intuiting dir paths if they are omitted

0.1.1 / 2008-11-22

• Minor Additions
• Posts now support introspectional data e.g. {{ page.url }}

0.1.0 / 2008-11-05

• First release
• Converts posts written in Textile
• Converts regular site pages
• Simple copy of binary files

0.0.0 / 2008-10-19

• Birthday!