Create your own project

1. Click this button.
   • 
2. Go to repo Settings and enable as a GitHub Pages site.
3. Go to the environment tab to check the status of the build and then get the URL of your GitHub Pages site.

Choose a theme

Built-in

It is easy to use one of standard themes available of GitHub Pages by setting the theme value in your config.

There are about 10 and are listed among gems here:

• https://pages.github.com/versions/

You can also switch between themes with a preview, by switching themes within repo Settings

Custom

If you want to use another theme on a GH Pages site, you must use the Remote Theme plugin and point to a GitHub repo.

See this project, which uses that approach and explains it.

• https://github.com/MichaelCurrin/jekyll-theme-quickstart/tree/gh-pages

Or you must use another CI flow like GitHub Actions or Netlify. Then you can put any theme in your config file under theme, as long as you also cover it in Gemfile.

Set up locally

This project is not intended to be run locally with a dev server.

See this project, which has instructions and a Gemfile which are suited for local development.

Related projects

• Jekyll GH Actions Quickstart
  • Similar in approach and structure as this project, but with GH Actions added.
• Jekyll Blog Demo
  • Starter for a static website or blog - built with Jekyll, a minimal theme and GH Pages.

Resources

Learn more about Jekyll and GH Pages.

• Jekyll resources in my Dev Resources site.
• Jekyll docs homepage.
• Jekyll quickstart page in the Jekyll docs.
• Jekyll themes docs.
• Jekyll directory structure docs.
• GitHub Pages homepage docs.