A Jekyll theme for GitHub Pages based on GitHub's Primer styles. You can preview the theme to see what it looks like, or even use it today.

Usage

1. Add the following to your site's _config.yml:

   remote_theme: marella/jekyll-theme-github
   

2. Optionally, if you'd like to preview your site on your computer, add the following to your site's Gemfile:

   gem "github-pages", group: :jekyll_plugins
   

Configuration

The following variables will be used, if set in your site's _config.yml:

title: [The title of your site]
color: [The color of your site's header]
google_analytics: [Your Google Analytics tracking ID]

Development

If you'd like to preview the theme locally (for example, in the process of proposing a change):

1. Clone the theme's repository (git clone https://github.com/marella/jekyll-theme-github)
2. cd into the theme's directory
3. Run npm install to install the necessary dependencies
4. Run npm run build to compile the sass files and other assets
5. Run npm start to start the preview server
6. Visit localhost:4000 in your browser to preview the theme