Install Jekyll and host site
Jekyll Deployed on Github & Cloudflare
About Jekyll
Jekyll is a static site generator that transforms your plain text into beautiful static web sites and blogs.It can be use for a documentation site, a blog, an event site, or really any web site you like. It’s fast, secure, easy, and open source.It’s also the same site generator I use to maintain my open source documentation.Today, we’ll be installing and configuring Jekyll using the Chirpy theme.We configure the site, create some pages with markdown, automatically build it with a GitHub action and even host it for FREE on GitHub pages.If you don’t want to host in the cloud, I show how to host it on your own server or even in Docker.Thanks to Techno Tim
Jekyll Install Local based on Chirpy
- Sign in to GitHub and navigate to the Starter.
- Click the Use this template button and then select Create a new repository.
- Name the new repository
username.github.ioreplacingusernamewith your lowercase GitHub username.
Setting up the Environment
- Install Docker Engine
- for ubuntu
1
2
3
4
sudo apt update && sudo apt upgrade -y
curl -fsSL https://get.docker.com -o get-docker.sh
sudo sh get-docker.sh
sudo usermod -aG docker $USER
- Install vs code and dev container extention
- clone the repo locally
1
git clone git@<YOUR-USER-NAME>/<YOUR-REPO-NAME>.git
**
change directory to your repository
1
2
ls
cd <YOUR-USER-NAME>.github.io
open directory in vs-code open it in a container via VS Code.
1
code .
open the config. yml file and change the following parameters
1
2
3
4
5
6
7
8
9
10
11
12
name: 'config.yml'
tagline: "name of site goes here"
description: "this is my homelab blog"
url: https://username.github.io
timezone: America/New_York
theme_mode: [light | dark]
github: your_username
twitter: your_username
avartar:
- local: path to file
- remote: link to avatar
open the Gemfile file and add
1
gem 'jekyll-compose', group: [:jekyll_plugins]
launch your terminal and run bundle to complile the package
1
bundle
when bundle is done compliling the package there should be a link to lost locally. lauch your browser and open
http://127.0.0.1:4000
creating a post
to create a post locate the _posts directory.create a new markkdown file in the format of YYYY-MM-DAY-name-of-post.md
1
touch 2025-07-11-hello-build.md
Every post must begin with the beginner block as shown below
1
2
3
4
5
6
---
title: TITTLE
date: YYYY-MM-DAY
categories: [blog docs]
tags: [blog jekyll setup ] # tag names should always be lower case
---
happy writing. heres a finished product of my first blog form reference
1
Referenece