An opinionated guide to common Jekyll design patterns and anti-patterns.
Shell Ruby
Switch branches/tags
Nothing to show
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Failed to load latest commit information.
.github
_docs
docs
script
.gitignore
.remarkignore
.remarkrc
.rubocop.yml
.travis.yml
CONTRIBUTING.md
Gemfile
LICENSE.md
README.md
_config.yml
index.md
package-lock.json
package.json

README.md

Jekyll style guide

Build Status

Introduction

What is this thing?

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

Current status

This document is an early draft intended to collect feedback. Once a 1.0 is reached, it'd be cool to create a Jekyll site to display the rules and/or a Jekyll linter to enforce site-wide styles.