An opinionated guide to common Jekyll design patterns and anti-patterns.
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
For another, when writing a plugin or theme intended to be used across sites, should it look for
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.
- The config file
- Information architecture
- Layouts and includes
- Liquid syntax
- The GitHub repository
- Syntax highlighting
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.