diff --git a/README.md b/README.md index 2496b1e8..18341118 100644 --- a/README.md +++ b/README.md @@ -1,12 +1,12 @@ # The Primer theme -[![Build Status](https://travis-ci.org/pages-themes/primer.svg?branch=master)](https://travis-ci.org/pages-themes/primer) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-primer.svg)](https://badge.fury.io/rb/jekyll-theme-primer) +[Build Status](https://github.com/pages-themes/primer/actions/workflows/ci.yaml) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-primer.svg)](https://badge.fury.io/rb/jekyll-theme-primer) *Primer is a Jekyll theme for GitHub Pages. You can [preview the theme to see what it looks like](http://pages-themes.github.io/primer), or even [use it today](#usage).* -## Usage +![Thumbnail of Primer](thumbnail.png) -> **_NOTE:_** Primer is now the default theme for GitHub Pages, but you can still specify the theme you're using as below. +## Usage To use the Primer theme: @@ -22,8 +22,6 @@ To use the Primer theme: gem "github-pages", group: :jekyll_plugins ``` - - ## Customizing ### Configuration variables @@ -38,6 +36,7 @@ description: [A short description of your site's purpose] Additionally, you may choose to set the following optional variables: ```yml +show_downloads: ["true" or "false" to indicate whether to provide a download URL] google_analytics: [Your Google Analytics tracking ID] ``` @@ -55,6 +54,8 @@ If you'd like to add your own custom styles: ``` 3. Add any custom CSS (or Sass, including imports) you'd like immediately after the `@import` line +*Note: If you'd like to change the theme's Sass variables, you must set new values before the `@import` line in your stylesheet.* + ### Layouts If you'd like to change the theme's HTML layout: @@ -64,6 +65,23 @@ If you'd like to change the theme's HTML layout: 3. Paste the default layout content copied in the first step 4. Customize the layout as you'd like +### Overriding GitHub-generated URLs + +Templates often rely on URLs supplied by GitHub such as links to your repository or links to download your project. If you'd like to override one or more default URLs: + +1. Look at [the template source](https://github.com/pages-themes/primer/blob/master/_layouts/default.html) to determine the name of the variable. It will be in the form of `{{ site.github.zip_url }}`. +2. Specify the URL that you'd like the template to use in your site's `_config.yml`. For example, if the variable was `site.github.url`, you'd add the following: + ```yml + github: + zip_url: http://example.com/download.zip + another_url: another value + ``` +3. When your site is built, Jekyll will use the URL you specified, rather than the default one provided by GitHub. + +*Note: You must remove the `site.` prefix, and each variable name (after the `github.`) should be indent with two space below `github:`.* + +For more information, see [the Jekyll variables documentation](https://jekyllrb.com/docs/variables/). + ## Roadmap See the [open issues](https://github.com/pages-themes/primer/issues) for a list of proposed features (and known issues).