jekyll-blueprint

A blueprint for a Jekyll project, to be build on Github Actions and deployed to Github Pages per peaceiris/actions-gh-pages.

Since the site is build on Github Actions, you're not limited to plugins which Github allows via their pages gem.

Get up and running

• Fork this repo
• make sets up the dependencies and starts Jekyll's server
• change/build theme, add content, customize, etc.
• inside _config.yml, change baseurl to your repository-name
• commit changes + push
• setup GITHUB_TOKEN
• deploy again
• Surf to https://yourusername.github.io/repository-name/

Using your own domain

After you've setup the DNS of your domain, add a cname to .github/workflows/gh-pages.yml inside the deploy action.

In _config.yml, adjust url and basepath accordingly.

Using another theme

Find a theme

• https://jamstackthemes.dev/ssg/jekyll/
• https://jekyllthemes.io/
• https://jekyll-themes.com/
• ... somewhere on the internet

Add a theme to your Gemfile

If it's published as a gem:

gem 'the_theme_to_use'

If it's in a github repository:

gem 'the_theme_to_use', github: 'username/the_theme_to_use'

Tell Jekyll to use the theme

Inside _config.yml, change theme: value to the_theme_to_use.