jekyll-gh-actions-quickstart

jekyll-gh-actions-quickstart

Starter template for a Jekyll 4 site - deployed with GH Actions and GH Pages ๐Ÿงช ๐ŸŽฌ ๐Ÿš€

Jekyll GH Actions Quickstart ๐Ÿงช ๐ŸŽฌ ๐Ÿš€

Starter template for a Jekyll 4 site - deployed with GH Actions and GH Pages

=2.6-blue?logo=ruby&logoColor=white title="Made with Ruby" loading="lazy" />

Preview

Sample screenshot

About

This project uses GitHub Actions to build a site with Jekyll 4 and make the output available to serve as static output with GitHub Pages.

If you are unfamiliar with any of those tools, see the GitHub Actions tutorial on the Jekyll docs. That tutorial links back to this repo.

Highlights of the repo:

  • main.yml - workflow config for GH Actions.
  • Gemfile - specifies Jekyll 4 and other custom gems.

For a theme, just-the-docs is installed in the Gemfile and configured in the config file, but you can easily swap that for another theme.

Follow the instructions on the Create your own page of the demo site. That explains how to a copy of this template and set up and run it.

Documentation

License

Released under MIT by @MichaelCurrin.