jekyll-theme-primer 0.5.1 → 0.6.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
-SHA1:
-  metadata.gz: 448373e50ebfb04d622fc646ba208e08acefea85
-  data.tar.gz: 9298e2f6345b4304eda5180684e7df6551b50c6b
+SHA256:
+  metadata.gz: ca90b72e4871f1eb4d6b242f7b2b694598cdf3c03c1f14747e44be00c6798dc4
+  data.tar.gz: 5c513719e585c9befb96c9991fd412c7425bb4cb6e20d3bfffae896e85df2a1c
 SHA512:
-  metadata.gz: 94caaa10609f72c37136a187663c3dcbbb25edd689976e0215fe3e7ff051116e5f4d8d4eed493c54e0b78eb2a02b98b261b667246c87eb9cb40d38c9ef9d8e38
-  data.tar.gz: b00459b4c4aa783d6e22bc46e592fb153c5f40cf52bb3b75880abee38d056fb7e20750fd42768fee3acd628529933ca54cac2988f051db36d9f955e67718fea1
+  metadata.gz: ac0788b1abac6c78db45dcc2cadfd942ca02d6ff0808e3768c517dc9bd27c01a6c87bfaf665094c38c051ffa64edd4b73971f68ba063a1c6d135b1d85468a231
+  data.tar.gz: 68e1d761e48c3b7d70ebf209b115cf6aa46d852c0509d7b92a84c2275103d58a63b22167caa2b538c3a69b2db6b5bfe1ab84223b35ca872fea5c930e14370025

data/LICENSE.md

@@ -1,6 +1,6 @@
 The MIT License (MIT)
 
-Copyright (c) 2016 Ben Balter
+Copyright (c) 2016-2017 GitHub, Inc.
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,9 +1,11 @@
 # The Primer theme
 
-[![Build Status](https://travis-ci.org/pages-themes/jekyll-theme-primer.svg?branch=master)](https://travis-ci.org/pages-themes/jekyll-theme-primer) [![Gem Version](https://badge.fury.io/rb/jekyll-theme-primer.svg)](https://badge.fury.io/rb/jekyll-theme-primer)
+[![.github/workflows/ci.yaml](https://github.com/pages-themes/primer/actions/workflows/ci.yaml/badge.svg)](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).*
 
+![Thumbnail of Primer](thumbnail.png)
+
 ## Usage
 
 To use the Primer theme:
@@ -11,7 +13,9 @@ To use the Primer theme:
 1. Add the following to your site's `_config.yml`:
 
     ```yml
-    theme: jekyll-theme-primer
+    remote_theme: pages-themes/primer@v0.2.0
+    plugins:
+    - jekyll-remote-theme # add this line to the plugins list if you already have one
     ```
 
 2. Optionally, if you'd like to preview your site on your computer, add the following to your site's `Gemfile`:
@@ -20,8 +24,6 @@ To use the Primer theme:
     gem "github-pages", group: :jekyll_plugins
     ```
 
-
-
 ## Customizing
 
 ### Configuration variables
@@ -36,7 +38,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]
+show_downloads: ["true" or "false" (unquoted) to indicate whether to provide a download URL]
 google_analytics: [Your Google Analytics tracking ID]
 ```
 
@@ -44,7 +46,7 @@ google_analytics: [Your Google Analytics tracking ID]
 
 If you'd like to add your own custom styles:
 
-1. Create a file called `/assets/css/style.css` in your site
+1. Create a file called `/assets/css/style.scss` in your site
 2. Add the following content to the top of the file, exactly as shown:
     ```scss
     ---
@@ -54,18 +56,42 @@ 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:
 
-1. [Copy the original template](https://github.com/pages-themes/primer/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
-2. Create a file called `/_layouts/default.html` in your site
-3. Paste the default layout content copied in the first step
-4. Customize the layout as you'd like
+1. For some changes such as a custom `favicon`, you can add custom files in your local `_includes` folder. The files [provided with the theme](https://github.com/pages-themes/primer/tree/master/_includes) provide a starting point and are included by the [original layout template](https://github.com/pages-themes/primer/blob/master/_layouts/default.html).
+2. For more extensive changes, [copy the original template](https://github.com/pages-themes/primer/blob/master/_layouts/default.html) from the theme's repository<br />(*Pro-tip: click "raw" to make copying easier*)
+3. Create a file called `/_layouts/default.html` in your site
+4. Paste the default layout content copied in the first step
+5. Customize the layout as you'd like
+
+### Customizing Google Analytics code
+
+Google has released several iterations to their Google Analytics code over the years since this theme was first created. If you would like to take advantage of the latest code, paste it into `_includes/head-custom-google-analytics.html` in your Jekyll site.
+
+### 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/pagse-themes/primer/issues) for a list of proposed features (and known issues).
+See the [open issues](https://github.com/pages-themes/primer/issues) for a list of proposed features (and known issues).
 
 ## Project philosophy
 
@@ -73,7 +99,7 @@ The Primer theme is intended to make it quick and easy for GitHub Pages users to
 
 ## Contributing
 
-Interested in contributing to Primer? We'd love your help. Primer is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](CONTRIBUTING.md) for instructions on how to contribute.
+Interested in contributing to Primer? We'd love your help. Primer is an open source project, built one contribution at a time by users like you. See [the CONTRIBUTING file](docs/CONTRIBUTING.md) for instructions on how to contribute.
 
 ### Previewing the theme locally
 
@@ -87,4 +113,4 @@ If you'd like to preview the theme locally (for example, in the process of propo
 
 ### Running tests
 
-The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` one before the test script will work.
+The theme contains a minimal test suite, to ensure a site with the theme would build successfully. To run the tests, simply run `script/cibuild`. You'll need to run `script/bootstrap` once before the test script will work.

data/_includes/head-custom-google-analytics.html

@@ -0,0 +1,10 @@
+{% if site.google_analytics %}
+  <script>
+    (function(i,s,o,g,r,a,m){i['GoogleAnalyticsObject']=r;i[r]=i[r]||function(){
+    (i[r].q=i[r].q||[]).push(arguments)},i[r].l=1*new Date();a=s.createElement(o),
+            m=s.getElementsByTagName(o)[0];a.async=1;a.src=g;m.parentNode.insertBefore(a,m)
+        })(window,document,'script','//www.google-analytics.com/analytics.js','ga');
+    ga('create', '{{ site.google_analytics }}', 'auto');
+    ga('send', 'pageview');
+  </script>
+{% endif %}

data/_includes/head-custom.html

@@ -0,0 +1,9 @@
+<!-- start custom head snippets, customize with your own _includes/head-custom.html file -->
+
+<!-- Setup Google Analytics -->
+{% include head-custom-google-analytics.html %}
+
+<!-- You can set your favicon here -->
+<!-- link rel="shortcut icon" type="image/x-icon" href="{{ '/favicon.ico' | relative_url }}" -->
+
+<!-- end custom head snippets -->

data/_layouts/default.html

@@ -1,27 +1,29 @@
 <!DOCTYPE html>
-<html lang="en">
+<html lang="{{ site.lang | default: "en-US" }}">
   <head>
     <meta charset="UTF-8">
+    <meta http-equiv="X-UA-Compatible" content="IE=edge">
     <meta name="viewport" content="width=device-width, initial-scale=1">
 
 {% seo %}
-    <link href="{{ '/assets/css/style.css?v=' | append: site.github.build_revision | relative_url }}" rel="stylesheet">
+    <link rel="stylesheet" href="{{ "/assets/css/style.css?v=" | append: site.github.build_revision | relative_url }}">
+    {% include head-custom.html %}
   </head>
   <body>
     <div class="container-lg px-3 my-5 markdown-body">
       {% if site.title and site.title != page.title %}
-        <h1><a href="{{ "/" | absolute_url }}">{{ site.title }}</a></h1>
+      <h1><a href="{{ "/" | absolute_url }}">{{ site.title }}</a></h1>
       {% endif %}
 
       {{ content }}
 
       {% if site.github.private != true and site.github.license %}
       <div class="footer border-top border-gray-light mt-5 pt-3 text-right text-gray">
-        This site is open source. <a href="{{ site.github.repository_url }}/edit/{{ site.github.source.branch }}{{ site.github.source.path }}/{{ page.path }}">Help improve this page</a>.
+        This site is open source. {% github_edit_link "Improve this page" %}.
       </div>
       {% endif %}
     </div>
-    <script src="{{ "assets/javascript/anchor-js/anchor.min.js" | relative_url }}"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/anchor-js/4.1.0/anchor.min.js" integrity="sha256-lZaRhKri35AyJSypXXs4o6OPFTbTmUoltBbDCbdzegg=" crossorigin="anonymous"></script>
     <script>anchors.add();</script>
   </body>
 </html>

data/_layouts/home.html

@@ -0,0 +1,4 @@
+---
+layout: default
+---
+{{ content }}

data/_layouts/page.html

@@ -0,0 +1,4 @@
+---
+layout: default
+---
+{{ content }}

data/_layouts/post.html

@@ -0,0 +1,4 @@
+---
+layout: default
+---
+{{ content }}

data/_sass/primer-base/lib/base.scss

@@ -64,4 +64,21 @@ th {
 
 button {
   cursor: pointer;
+  // Remove border radius added by Chroma macOS
+  border-radius: 0;
+}
+
+// increase the selector specificity for [hidden]
+// so that it always overrides utility classes (.d-block, etc.)
+[hidden][hidden] {
+  display: none !important;
+}
+
+details {
+  summary { cursor: pointer; }
+
+  &:not([open]) {
+    // Set details content hidden by default for browsers that don't do this
+    > *:not(summary) { display: none !important; }
+  }
 }

data/_sass/primer-base/lib/normalize.scss

@@ -82,20 +82,18 @@ progress {
 
 template, /* 1 */
 [hidden] {
-  display: none;
+  display: none !important;
 }
 
 /* Links
    ========================================================================== */
 
 /**
- * 1. Remove the gray background on active links in IE 10.
- * 2. Remove gaps in links underline in iOS 8+ and Safari 8+.
+ * Remove the gray background on active links in IE 10.
  */
 
 a {
   background-color: transparent; /* 1 */
-  -webkit-text-decoration-skip: objects; /* 2 */
 }
 
 /**

data/_sass/primer-layout/lib/grid-offset.scss

@@ -1,30 +1,19 @@
 // Optional offset options to work with grid.scss
 
 // Offset Columns
-.offset-1 { margin-left: (1 / 12 * 100%); }
-.offset-2 { margin-left: (2 / 12 * 100%); }
-.offset-3 { margin-left: (3 / 12 * 100%); }
-.offset-4 { margin-left: (4 / 12 * 100%); }
-.offset-5 { margin-left: (5 / 12 * 100%); }
-.offset-6 { margin-left: (6 / 12 * 100%); }
-.offset-7 { margin-left: (7 / 12 * 100%); }
-.offset-8 { margin-left: (8 / 12 * 100%); }
-.offset-9 { margin-left: (9 / 12 * 100%); }
-.offset-10 { margin-left: (10 / 12 * 100%); }
-.offset-11 { margin-left: (11 / 12 * 100%); }
 
-@each $breakpoint in map-keys($breakpoints) {
+@each $breakpoint, $variant in $responsive-variants {
   @include breakpoint($breakpoint) {
-    .offset-#{$breakpoint}-1 { margin-left: (1 / 12 * 100%); }
-    .offset-#{$breakpoint}-2 { margin-left: (2 / 12 * 100%); }
-    .offset-#{$breakpoint}-3 { margin-left: (3 / 12 * 100%); }
-    .offset-#{$breakpoint}-4 { margin-left: (4 / 12 * 100%); }
-    .offset-#{$breakpoint}-5 { margin-left: (5 / 12 * 100%); }
-    .offset-#{$breakpoint}-6 { margin-left: (6 / 12 * 100%); }
-    .offset-#{$breakpoint}-7 { margin-left: (7 / 12 * 100%); }
-    .offset-#{$breakpoint}-8 { margin-left: (8 / 12 * 100%); }
-    .offset-#{$breakpoint}-9 { margin-left: (9 / 12 * 100%); }
-    .offset-#{$breakpoint}-10 { margin-left: (10 / 12 * 100%); }
-    .offset-#{$breakpoint}-11 { margin-left: (11 / 12 * 100%); }
+    .offset#{$variant}-1 { margin-left: (1 / 12 * 100%) !important; }
+    .offset#{$variant}-2 { margin-left: (2 / 12 * 100%) !important; }
+    .offset#{$variant}-3 { margin-left: (3 / 12 * 100%) !important; }
+    .offset#{$variant}-4 { margin-left: (4 / 12 * 100%) !important; }
+    .offset#{$variant}-5 { margin-left: (5 / 12 * 100%) !important; }
+    .offset#{$variant}-6 { margin-left: (6 / 12 * 100%) !important; }
+    .offset#{$variant}-7 { margin-left: (7 / 12 * 100%) !important; }
+    .offset#{$variant}-8 { margin-left: (8 / 12 * 100%) !important; }
+    .offset#{$variant}-9 { margin-left: (9 / 12 * 100%) !important; }
+    .offset#{$variant}-10 { margin-left: (10 / 12 * 100%) !important; }
+    .offset#{$variant}-11 { margin-left: (11 / 12 * 100%) !important; }
   }
 }

data/_sass/primer-markdown/lib/code.scss

@@ -3,19 +3,11 @@
   // Inline code snippets
   code,
   tt {
-    padding: 0;
-    padding-top: 0.2em;
-    padding-bottom: 0.2em;
+    padding: 0.2em 0.4em;
     margin: 0;
     font-size: 85%;
     background-color: rgba($black, 0.05);
-    border-radius: 3px; // don't add padding, gives scrollbars
-
-    &::before,
-    &::after {
-      letter-spacing: -0.2em; // this creates padding
-      content: "\00a0";
-    }
+    border-radius: $border-radius;
 
     br { display: none; }
   }
@@ -53,7 +45,7 @@
     font-size: 85%;
     line-height: 1.45;
     background-color: $gray-100;
-    border-radius: 3px;
+    border-radius: $border-radius;
   }
 
   pre code,
@@ -67,10 +59,5 @@
     word-wrap: normal;
     background-color: transparent;
     border: 0;
-
-    &::before,
-    &::after {
-      content: normal;
-    }
   }
 }

data/_sass/primer-markdown/lib/lists.scss

@@ -45,12 +45,16 @@
     margin-bottom: 0;
   }
 
+  li {
+    word-wrap: break-all;
+  }
+
   li > p {
     margin-top: $spacer-3;
   }
 
   li + li {
-    margin-top: 0.25em;
+    margin-top: $em-spacer-3;
   }
 
   dl {

data/_sass/primer-markdown/lib/markdown-body.scss

@@ -69,7 +69,7 @@
   }
 
   hr {
-    height: 0.25em;
+    height: $em-spacer-3;
     padding: 0;
     margin: $spacer-4 0;
     background-color: $gray-200;

data/_sass/primer-support/lib/mixins/buttons.scss

@@ -18,12 +18,13 @@
     &.hover {
       background-color: darken($bg2, 3%);
       background-image: linear-gradient(-180deg, darken($bg, 3%) 0%, darken($bg2, 3%) 90%);
-      background-position: 0 -0.5em;
+      background-position: 0 -$em-spacer-5;
       border-color: rgba($black, 0.35);
     }
 
     &:active,
-    &.selected {
+    &.selected,
+    [open] > & {
       background-color: darken(desaturate($bg, 10%), 6%);
       background-image: none;
       border-color: rgba($black, 0.35); // repeat to avoid shift on click-drag off of button
@@ -42,19 +43,20 @@
   } @else {
     &:focus,
     &.focus {
-      box-shadow: 0 0 0 0.2em rgba($bg, 0.3);
+      box-shadow: 0 0 0 0.2em rgba($bg, 0.4);
     }
 
     &:hover,
     &.hover {
       background-color: darken($bg2, 2%);
       background-image: linear-gradient(-180deg, darken($bg, 2%) 0%, darken($bg2, 2%) 90%);
-      background-position: 0 -0.5em;
+      background-position: 0 -$em-spacer-5;
       border-color: $black-fade-50;
     }
 
     &:active,
-    &.selected {
+    &.selected,
+    [open] > & {
       background-color: darken(mix($bg, $bg2, 50%), 7%);
       background-image: none;
       border-color: $black-fade-50; // repeat to avoid shift on click-drag off of button
@@ -84,7 +86,7 @@
   background-image: linear-gradient(-180deg, $bg 0%, $bg2 90%);
 
   &:focus {
-    box-shadow: 0 0 0 0.2em rgba($color, 0.3);
+    box-shadow: 0 0 0 0.2em rgba($color, 0.4);
   }
 
   &:hover {
@@ -99,7 +101,8 @@
   }
 
   &:active,
-  &.selected {
+  &.selected,
+  [open] > & {
     color: $text-white;
     background-color: darken($color, 5%);
     background-image: none;
@@ -129,7 +132,8 @@
 
   &:hover,
   &:active,
-  &.selected {
+  &.selected,
+  [open] > & {
     color: $bg-color;
     background-color: $text-color;
     background-image: none;
@@ -143,7 +147,7 @@
 
   &:focus {
     border-color: $text-color;
-    box-shadow: 0 0 0 0.2em rgba($text-color, 0.3);
+    box-shadow: 0 0 0 0.2em rgba($text-color, 0.4);
   }
 
   &:disabled,