This page is not available in every language. Missing translations are disabled in the language selector.

Quick reference

Jekyll on GitHub Pages Cheatsheet

Quick reference guide for using Jekyll with GitHub Pages, covering directory structures, configuration, frontmatter, Liquid tags, and deployment.

· Published

Quick reference for configuring and publishing Jekyll static websites with GitHub Pages.

Directory Structure

.
├── _config.yml       # Site configuration
├── _includes/        # Reusable template snippets
├── _layouts/         # Base page layouts
├── _posts/           # Blog posts (YYYY-MM-DD-title.md)
├── _sass/            # SASS / SCSS style partials
├── assets/           # Images, compiled styles, JS
└── index.md          # Homepage content

Configuration (_config.yml)

title: My Documentation
description: Quick reference cheatsheets
baseurl: "/my-repo"
url: "https://username.github.io"

# GitHub Pages dependencies
plugins:
  - jekyll-feed
  - jekyll-seo-tag
  - jekyll-sitemap

markdown: kramdown
theme: minima

Frontmatter Header

---
layout: post
title: "Getting Started with Jekyll"
date: 2026-10-25 12:00:00 +0000
categories: [development, tools]
tags: [jekyll, static-site]
---

Liquid Template Helpers

Output and Variables

{{ site.title }}
{{ page.title }}
{{ content }}

Conditionals and Loops

{% if page.comments %}
  {% include comments.html %}
{% endif %}

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

Local Testing

# Install dependencies
bundle install

# Run local development server with live reload
bundle exec jekyll serve --livereload
```\n

Related topics