Knowledgbase

Hello from GitHub Pages + Jekyll

View the Project on GitHub e2xperimental/software-cheatsheet

2 May 2026

Build a simple Jekyll site on GitHub Pages (web-only)

by

Setup a Github Pages + Jekyll site

1) Create the special repository

  1. Sign in to GitHub → top-right + → New repository.
  2. Name it exactly YOURUSERNAME.github.io (replace with your GitHub username). Turn on Add README → Create repository.

2) Turn on GitHub Pages

  1. In your repo, go to Settings → Pages (left sidebar under “Code and automation”).
  2. Under Build and deployment → Source, choose Deploy from a branch.
  3. Under Branch, choose main and /(root), then Save.
  4. After a minute or two, visit https://YOURUSERNAME.github.io. (It can take up to ~10 minutes for first publish.)

3) Add minimal Jekyll files (still on the website)

  1. Back on the Code tab, click Add file → Create new file.
  2. Create a file named _config.yml with this content, then Commit changes:
theme: jekyll-theme-minimal
title: My Site
description: Hello from GitHub Pages + Jekyll

That theme: line tells Pages to build the site with Jekyll and apply one of GitHub’s built-in themes. You can swap jekyll-theme-minimal for any supported theme later.

  1. Create another new file named index.md:
---
layout: default
title: Home
---
# Welcome
This page was built with **Jekyll** on **GitHub Pages** — no terminal!

Commit, then refresh your site URL. (Small publishes may also take a few minutes.)

Frontmatter

https://jekyllrb.com/docs/front-matter/

Liquid

https://jekyllrb.com/docs/liquid/

Commenting code in index.md and _config.yml

YAML (like _config.yml)

Use the # symbol.

# This is a comment
key: value  # inline comment
# Another comment

You can use YAML front matter comments, at the top of Markdown files.

---
# This comment is in the YAML front matter
title: My Post
---

Markdown (.md)

Use <!-- --> HTML comment syntax

<!-- This is a comment and won't appear when rendered -->

Some content here

<!-- 
  Multi-line comment
  Still won't appear
-->
tags: