To use the Primer theme:
-
Add the following to your site's
_config.yml
:remote_theme: pages-themes/[email protected] plugins: - jekyll-remote-theme # add this line to the plugins list if you already have one
Primer will respect the following variables, if set in your site's _config.yml
:
title: [The title of your site]
description: [A short description of your site's purpose]
google_analytics: [Your Google Analytics tracking ID]
If you'd like to add your own custom styles:
-
Create a file called
/assets/css/style.scss
in your site -
Add the following content to the top of the file, exactly as shown:
--- --- @import '{{ site.theme }}';
-
Add any custom CSS (or Sass, including imports) you'd like immediately after the
@import
line
If you'd like to preview the theme locally (for example, in the process of proposing a change):
- Clone down the theme's repository (
git clone https://github.com/pages-themes/primer
) cd
into the theme's directory- Run
script/bootstrap
to install the necessary dependencies - Run
bundle exec jekyll serve
to start the preview server - Visit
localhost:4000
in your browser to preview the theme