index.md

Jekyll style guide

{{ site.description }} {: .lead }

Why write this?

Jekyll's incredibly flexible, but in some instances, the lack of common conventions make things harder for users.

For one, there are many common design patterns that are still relatively unknown to new users (e.g., using permalink: /about/ in about.md, rather than creating /about/index.md).

For another, when writing a plugin or theme intended to be used across sites, should it look for site.title or site.name? site.description or site.tagline? Moar options, moar problems.

This style guide aims to make it easier to create awesome Jekyll sites by codifying and surfacing Jekyll best practices.

Guides

{% for doc in site.docs %}
• {{ doc.title }}
{% endfor %}

Want to contribute?

This style guide is intended to be a collaborative resource for the Jekyll community. Please help improve it.

See the contributing instructions for more information.