https://github.com/benbalter/jekyll-style-guide

An opinionated guide to common Jekyll design patterns and anti-patterns.
https://github.com/benbalter/jekyll-style-guide

jekyll style-guide

Last synced: about 2 months ago
JSON representation

An opinionated guide to common Jekyll design patterns and anti-patterns.

• Host: GitHub
• URL: https://github.com/benbalter/jekyll-style-guide
• Owner: benbalter
• License: cc0-1.0
• Created: 2016-02-13T23:36:47.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2023-01-12T08:23:34.000Z (over 1 year ago)
• Last Synced: 2024-04-15T00:15:28.614Z (5 months ago)
• Topics: jekyll, style-guide
• Language: Shell
• Homepage: http://ben.balter.com/jekyll-style-guide/
• Size: 135 KB
• Stars: 66
• Watchers: 9
• Forks: 18
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • Funding: .github/funding.yml
  • License: LICENSE.md
  • Code of conduct: docs/CODE_OF_CONDUCT.md
  • Codeowners: .github/CODEOWNERS
  • Security: docs/SECURITY.md

Awesome Lists containing this project

README

        
# Jekyll style guide

[![Build Status](https://travis-ci.org/benbalter/jekyll-style-guide.svg?branch=master)](https://travis-ci.org/benbalter/jekyll-style-guide)

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