Install Dependencies

1
2

	sudo apt update
	sudo apt install ruby-full build-essential zlib1g-dev git

To avoid installing RubyGems packages as the root user:

If you are using “bash” (usually the default for most)

1
2
3
4

echo '# Install Ruby Gems to ~/gems' >> ~/.bashrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.bashrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.bashrc
source ~/.bashrc

If you are using zsh (you know if you are)

1
2
3
4

echo '# Install Ruby Gems to ~/gems' >> ~/.zshrc
echo 'export GEM_HOME="$HOME/gems"' >> ~/.zshrc
echo 'export PATH="$HOME/gems/bin:$PATH"' >> ~/.zshrc
source ~/.zshrc

Install Jekyll bundler

1

gem install jekyll bundler

Creating a site based on Chirpy Starter

Visit https://github.com/cotes2020/jekyll-theme-chirpy#quick-start

After creating a site based on the template, clone your repo

1

git clone git@<YOUR-USER-NAME>/<YOUR-REPO-NAME>.git

then install your dependencies

1
2

cd repo-name
bundle

After making changes to your site, commit and push then up to git

1
2
3

git add .
git commit -m "made some changes"
git push

Jekyll Commands

serving your site

1

bundle exec jekyll s

Building your site in production mode

1

JEKYLL_ENV=production bundle exec jekyll b

This will output the production site to _site

Building Site in CI

This site already works with GitHub actions, just push it up and check the actions Tab.,

For GitLab you can see the pipeline I built for my own docs site here

Building with Docker

Create a Dockerfile with the following

1
2

FROM nginx:stable-alpine
COPY \_site /usr/share/nginx/html

Build site in production mode

1

JEKYLL_ENV=production bundle exec jekyll b

Then build your image:

1

docker build .

Creating a Post

Naming Conventions

Jekyll uses a naming convention for pages and posts

Create a file in _posts with the format

YEAR-MONTH-DAY-title.md

For example:

2022-05-23-homelab-docs.md 2022-05-34-hardware-specs.md

    Jekyll can delay posts which have the date/time set for a point in the future determined by the “front matter” section at the top of your post file. Check the date & time as well as time zone if you don’t see a post appear shortly after re-build.

Local Linking of Files

Image from asset:

1
2

... which is shown in the screenshot below:
![A screenshot](/assets/screenshot.jpg)

Linking to a file

1

... you can [download the PDF](/assets/diagram.pdf) here.

See more post formatting rules on the Jekyll site

Markdown Examples

If you need some help with markdown, check out the markdown cheat sheet

I have lots of examples in my documentation site repo. Just click on the Raw button to see the code behind the page.

For more neat syntax for the Chirpy theme check their demo page on making posts https://chirpy.cotes.page/posts/write-a-new-post/