A Jekyll theme for GitHub Pages based on GitHub's Primer styles.
MIT License
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.
Add the following to your site's _config.yml
:
remote_theme: marella/jekyll-theme-github
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
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]
If you'd like to preview the theme locally (for example, in the process of proposing a change):
git clone https://github.com/marella/jekyll-theme-github
)cd
into the theme's directorynpm install
to install the necessary dependenciesnpm run build
to compile the sass files and other assetsnpm start
to start the preview serverlocalhost:4000
in your browser to preview the theme