jekyll-rtd-theme 2.0.2 → 2.0.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f4f4168adf2ae575fe0c262155ebb5449ce2a2d69c5c9be9c811287ab0527d6
-  data.tar.gz: 7d70ba9d589a881660140fda943b585ae9f77b392f2bdb1720adfe40bee375b4
+  metadata.gz: 71e0be728a36e78ef8a38db4242292a0981347013258726fb82074c3d38fdc0d
+  data.tar.gz: e41c8381aa8cf0af5780449b0567f222d3a8959a00c5a73aa51daf028f99e1c7
 SHA512:
-  metadata.gz: 467ea12e4724b57506b3389b08bbeec30721572cb2c5ab00b7211c906a5deffa2674b34fb69778e8b156b8ead4d928f433466b82f0d3248df4900e7387e09f60
-  data.tar.gz: b4a165867d9e4090b97a1443194204fcde0551a069477cfad57cca4140e1816a11e26969595b8c912943da63340ce59a502d783a966ea741e97ab8033c105dc8
+  metadata.gz: ed35e6eff3b3b0ab73924527a16f52adea7f7ba95845f51e43def520b8136d3bc9c88594921a7b0b93875c75a0aa9c1b69efb3bba18e431ca344aac1c5574726
+  data.tar.gz: 40b26d3027d9f8f379a284cc3025c51c4740346921439aec81d4d87df114b633db7644badf7cc7ef2f90bb307aa52beb326495175ef797a0804da6ad78b0ce07

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 RunDocs
+Copyright (c) 2020 RunDocs & contributors
 
 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,6 +1,6 @@
 # jekyll-rtd-theme
 
-![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)
+![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=v2)
 ![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)
 
 Opinionated github flavored standard document theme for open source projects, with few options, but everything!
@@ -41,9 +41,6 @@ readme_index:
 meta:
   key1: value1
   key2: value2
-  .
-  .
-  .
 
 google:
   gtag:
@@ -83,7 +80,7 @@ plugins:
   - jekyll-mentions
 ```
 
-## Waiting
+## Writing
 
 Document writing specifications, please refer to [rundocs.io](https://rundocs.io) for details
 

data/_includes/assets/sw.caches.js

@@ -1,11 +1,11 @@
 self.addEventListener("activate", function (event) {
-  let cacheWhitelist = ["rundocs-{{ version }}"];
+  const current = ["rundocs-{{ version }}"];
 
   event.waitUntil(
     caches.keys().then(function (keyList) {
       return Promise.all(
         keyList.map(function (key) {
-          if (cacheWhitelist.indexOf(key) === -1) {
+          if (current.indexOf(key) === -1) {
             return caches.delete(key);
           }
         })
@@ -15,11 +15,7 @@ self.addEventListener("activate", function (event) {
 });
 
 self.addEventListener("fetch", function (e) {
-  if (
-    /^https:\/\/cdn\.jsdelivr\.net\/gh\/rundocs\/jekyll-rtd-theme@.+/.exec(
-      e.request.url
-    )
-  ) {
+  if (e.request.url.match("rundocs/jekyll-rtd-theme@{{ version }}")) {
     e.respondWith(
       caches.match(e.request).then(function (resp) {
         if (resp !== undefined) {

data/_includes/class/_toctree.liquid

@@ -10,9 +10,9 @@
         <li class="toc level-{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
             <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
                 {%- if item.sort -%}
-                    {{ item.sort }}. {{ item.title | default: item.url }}
+                    {{ item.sort }}. {{ item.title | default: item.name }}
                 {%- else -%}
-                    {{ item.title | default: item.url }}
+                    {{ item.title | default: item.name }}
                 {%- endif -%}
             </a>
         </li>

data/_includes/extend/list.liquid

@@ -9,7 +9,7 @@
 {% include reset/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
 
 {%- for item in workdir_files %}
-{% include reset/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
+{% include reset/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}

data/_includes/extend/toctree.liquid

@@ -25,9 +25,9 @@
         <li class="toc level-{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
             <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
                 {%- if item.sort -%}
-                    {{ item.sort }}. {{ item.title | default: item.url }}
+                    {{ item.sort }}. {{ item.title | default: item.name }}
                 {%- else -%}
-                    {{ item.title | default: item.url }}
+                    {{ item.title | default: item.name }}
                 {%- endif -%}
             </a>
         </li>

data/_includes/list.liquid

@@ -2,7 +2,7 @@
 {%- include reset/workdir.liquid workdir=page.dir -%}
 
 {%- for item in workdir_files %}
-- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
+- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- if include.all -%}

data/_includes/node/links.liquid

@@ -16,5 +16,9 @@
 {% comment %} theme {% endcomment %}
 <link rel="stylesheet" href="{{ cdn }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
 
+{%- if custom_scss.size > 0 -%}
+    <style>{{ custom_scss | scssify | strip_newlines }}</style>
+{%- endif -%}
+
 {% comment %} icon {% endcomment %}
 <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">

data/_includes/node/script.liquid

@@ -1,8 +1,7 @@
 <script>
     window.ui = {
+        collect: new URL("{{ collect }}?v={{ version }}&lang={{ lang }}"),
         title: "{{ site.title }}",
-        lang: "{{ lang }}",
-        version: "{{ version }}",
         baseurl: "{{ site.baseurl }}",
         i18n: {
             search_results: "{{ __.search_results | default: 'Search Results' }}",
@@ -12,4 +11,9 @@
     };
 </script>
 <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+
+{%- if custom_script.size > 0 -%}
+    <script>{{ custom_script }}</script>
+{%- endif -%}
+
 <script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/reset/content.liquid

@@ -0,0 +1,5 @@
+{%- assign content = content
+    | replace: "’", "'"
+    | replace: "“", '"'
+    | replace: "”", '"'
+    | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}

data/_includes/reset/defaults.liquid

@@ -1,69 +1,11 @@
 {%- include reset/site_pages.liquid -%}
 {%- include reset/i18n.liquid -%}
+{%- include reset/version.liquid -%}
 
-{%- comment %} variables {% endcomment -%}
-{%- assign version = "2.0.2" -%}
-{%- assign docs = site.github -%}
-{%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
+{%- include reset/variables.liquid -%}
 
-{%- assign rest_created_at = rest.created_at | default: site.time -%}
-{%- assign rest_updated_at = rest.updated_at | default: site.time -%}
+{%- include reset/content.liquid -%}
 
-{%- assign lang = site.lang | default: "en" -%}
-{%- assign author = docs.owner.name | default: docs.owner_name -%}
-
-{%- comment %} schema {% endcomment -%}
-{%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
-{%- assign schema_modi = site.time | date_to_xmlschema -%}
-{%- assign schema_surl = page.url  | absolute_url | xml_escape -%}
-
-{%- comment %} title {% endcomment -%}
-{%- case page.url -%}
-    {%- when "/" -%}
-        {%- assign title = site.title | append: " · " | append: site.description | truncate: 110 -%}
-    {%- when "/search.html" -%}
-        {%- assign title = __.search  | default: "Search" | append: " · " | append: site.title | truncate: 110 -%}
-    {%- when "/404.html" -%}
-        {%- assign title = "404"      | append: " · " | append: site.title | truncate: 110 -%}
-    {%- else -%}
-        {%- assign title = page.title | default: page.url | append: " · " | append: site.title | truncate: 110 -%}
-{%- endcase -%}
-
-{%- comment %} description {% endcomment -%}
-{%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-
-{% comment %} debug {% endcomment %}
-{%- if site.debug -%}
-    {%- assign cdn = site.baseurl -%}
-{%- else -%}
-    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
-{%- endif -%}
-
-{% comment %} content {% endcomment %}
-{%- assign content = content
-    | replace: "’", "'"
-    | replace: "“", '"'
-    | replace: "”", '"'
-    | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}
-
-
-{% comment %} prev and next {% endcomment %}
-{%- assign workdir_files = site_files | where_exp: "item", "item.dir == page.dir" -%}
-
-{%- assign index = 0 -%}
-{%- for item in workdir_files %}
-    {%- if item.url == page.url %}
-        {%- assign index = forloop.index -%}
-    {%- endif %}
-{%- endfor -%}
-
-{%- for item in workdir_files -%}
-    {%- assign index_prev = index | minus: 1 -%}
-    {%- assign index_next = index | plus: 1 -%}
-    {%- if forloop.index == index_prev -%}
-        {%- assign prev = item -%}
-    {%- endif %}
-    {%- if forloop.index == index_next -%}
-        {%- assign next = item -%}
-    {%- endif %}
-{%- endfor -%}
+{%- include reset/navigation.liquid -%}
+{%- include reset/title.liquid -%}
+{%- include reset/description.liquid -%}

data/_includes/reset/description.liquid

@@ -0,0 +1,6 @@
+{%- assign description = content
+    | strip_html
+    | split: " "
+    | join: " "
+    | escape
+    | truncate: 150 -%}

data/_includes/reset/navigation.liquid

@@ -0,0 +1,20 @@
+{%- include reset/workdir.liquid workdir=page.dir -%}
+
+{% comment %} prev and next {% endcomment %}
+{%- assign index = 0 -%}
+{%- for item in workdir_files %}
+    {%- if item.url == page.url %}
+        {%- assign index = forloop.index -%}
+    {%- endif %}
+{%- endfor -%}
+
+{%- for item in workdir_files -%}
+    {%- assign index_prev = index | minus: 1 -%}
+    {%- assign index_next = index | plus: 1 -%}
+    {%- if forloop.index == index_prev -%}
+        {%- assign prev = item -%}
+    {%- endif %}
+    {%- if forloop.index == index_next -%}
+        {%- assign next = item -%}
+    {%- endif %}
+{%- endfor -%}

data/_includes/reset/title.liquid

@@ -0,0 +1,18 @@
+{%- case page.url -%}
+    {%- when "/" -%}
+        {%- assign title = site.title
+            | append: " · "
+            | append: site.description | truncate: 110 -%}
+    {%- when "/search.html" -%}
+        {%- assign title = __.search | default: "Search"
+            | append: " · "
+            | append: site.title | truncate: 110 -%}
+    {%- when "/404.html" -%}
+        {%- assign title = "404"
+            | append: " · "
+            | append: site.title | truncate: 110 -%}
+    {%- else -%}
+        {%- assign title = page.title | default: page.name
+            | append: " · "
+            | append: site.title | truncate: 110 -%}
+{%- endcase -%}

data/_includes/reset/variables.liquid

@@ -0,0 +1,31 @@
+{%- comment %} variables {% endcomment -%}
+{%- assign collect = "https://rundocs-analytics.glitch.me/collect" -%}
+{%- assign docs = site.github -%}
+{%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
+
+{%- assign rest_created_at = rest.created_at | default: site.time -%}
+{%- assign rest_updated_at = rest.updated_at | default: site.time -%}
+
+{%- assign lang = site.lang | default: "en" -%}
+{%- assign author = docs.owner.name | default: docs.owner_name -%}
+
+{%- comment %} schema {% endcomment -%}
+{%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
+{%- assign schema_modi = site.time | date_to_xmlschema -%}
+{%- assign schema_surl = page.url  | absolute_url | xml_escape -%}
+
+{% comment %} debug {% endcomment %}
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
+
+{% comment %} custom {% endcomment %}
+{%- capture custom_scss -%}
+    {%- include assets/custom.scss -%} {{- site.scss -}}
+{%- endcapture -%}
+
+{%- capture custom_script -%}
+    {%- include assets/custom.js -%} {{- site.script -}}
+{%- endcapture -%}

data/_includes/reset/version.liquid

@@ -0,0 +1 @@
+{%- assign version = "2.0.3" -%}

data/_layouts/default.liquid

@@ -11,7 +11,6 @@ layout: plugins/compress
 
         {%- include node/title.liquid -%}
         {%- include node/links.liquid -%}
-
         {%- include node/script.schema.liquid -%}
 
         {%- include extra/head.html -%}
@@ -22,8 +21,8 @@ layout: plugins/compress
         {%- include class/addons-wrap.liquid  -%}
 
         {%- include node/script.liquid -%}
-        {%- include node/custom.liquid -%}
         {%- include node/script.extension.liquid -%}
+
         {%- include extra/footer.html -%}
     </body>
 </html>

data/_layouts/plugins/extension.liquid

@@ -15,9 +15,8 @@
                     {%- assign custom = content_block | replace_first: '><code class="language-', "" | replace_first: '">', "<temp/>" | split: "<temp/>" -%}
                     {%- assign lang   = custom.first -%}
                     {%- assign codes  = custom.last | split: "</code>" | first -%}
-                    {%- assign others = custom.last | split: "</code>" | last  -%}
                     {%- if shortcodes contains lang -%}
-                        {%- include shortcodes/{{ lang }}.liquid -%} {{- others -}}
+                        {%- include shortcodes/{{ lang }}.liquid -%} {{- pre_blocks.last -}}
                     {%- else -%}
                         <pre{{ pre_blocks.first }}</pre> {{ pre_blocks.last }}
                     {%- endif -%}

data/_sass/@primer/forms/form-control.scss

@@ -46,9 +46,12 @@ label {
     background-color: #f3f4f6; // custom gray
   }
 
-  // Ensures inputs don't zoom on mobile but are body-font size on desktop
-  @include breakpoint(md) {
-    font-size: $body-font-size;
+  // Ensures inputs don't zoom on mobile iPhone but are body-font size on iPad
+  @supports (-webkit-touch-callout: none) {
+    font-size: $h4-size;
+    @include breakpoint(md) {
+      font-size: $body-font-size;
+    }
   }
 }
 

data/_sass/@primer/markdown/lists.scss

@@ -46,6 +46,7 @@
   }
 
   li {
+    // TODO@16.0.0: Remove this. See https://github.com/primer/css/pull/1137.
     word-wrap: break-all;
   }
 

data/_sass/@primer/support/variables/misc.scss

@@ -9,6 +9,7 @@ $border: $border-width $border-color $border-style !default;
 // Border Radius
 $border-radius-1: 4px !default;
 $border-radius-2: 6px !default;
+$border-radius-3: 8px !default;
 $border-radius: $border-radius-2 !default;
 
 // Box shadow

data/_sass/@primer/utilities/borders.scss

@@ -72,6 +72,9 @@
     .rounded#{$variant}-2 {
       border-radius: $border-radius-2 !important;
     }
+    .rounded#{$variant}-3 {
+      border-radius: $border-radius-3 !important;
+    }
 
     @each $edge, $corners in $edges {
       .rounded#{$variant}-#{$edge}-0 {
@@ -82,19 +85,19 @@
 
       .rounded#{$variant}-#{$edge}-1 {
         @each $corner in $corners {
-          border-#{$corner}-radius: $border-radius / 2 !important;
+          border-#{$corner}-radius: $border-radius-1 !important;
         }
       }
 
       .rounded#{$variant}-#{$edge}-2 {
         @each $corner in $corners {
-          border-#{$corner}-radius: $border-radius !important;
+          border-#{$corner}-radius: $border-radius-2 !important;
         }
       }
 
       .rounded#{$variant}-#{$edge}-3 {
         @each $corner in $corners {
-          border-#{$corner}-radius: $border-radius * 2 !important;
+          border-#{$corner}-radius: $border-radius-3 !important;
         }
       }
     }

data/_sass/@primer/utilities/flexbox.scss

@@ -23,6 +23,9 @@
     .flex#{$variant}-nowrap {
       flex-wrap: nowrap !important;
     }
+    .flex#{$variant}-wrap-reverse {
+      flex-wrap: wrap-reverse !important;
+    }
 
     .flex#{$variant}-justify-start {
       justify-content: flex-start !important;

data/_sass/@primer/utilities/layout.scss

@@ -1,7 +1,7 @@
 // Layout
 // stylelint-disable block-opening-brace-space-after, block-opening-brace-space-before, comment-empty-line-before
 
-// Loop through the breakpoint values
+/* Position */
 @each $breakpoint, $variant in $responsive-variants {
   @include breakpoint($breakpoint) {
     @each $position in $responsive-positions {
@@ -12,21 +12,34 @@
   }
 }
 
-/* Set top 0 */
-.top-0 {
-  top: 0 !important;
-}
-/* Set right 0 */
-.right-0 {
-  right: 0 !important;
-}
-/* Set bottom 0 */
-.bottom-0 {
-  bottom: 0 !important;
-}
-/* Set left 0 */
-.left-0 {
-  left: 0 !important;
+/* Final position */
+@each $breakpoint, $variant in $responsive-variants {
+  @include breakpoint($breakpoint) {
+    .top#{$variant}-0 {
+      top: 0 !important;
+    }
+    .right#{$variant}-0 {
+      right: 0 !important;
+    }
+    .bottom#{$variant}-0 {
+      bottom: 0 !important;
+    }
+    .left#{$variant}-0 {
+      left: 0 !important;
+    }
+    .top#{$variant}-auto {
+      top: auto !important;
+    }
+    .right#{$variant}-auto {
+      right: auto !important;
+    }
+    .bottom#{$variant}-auto {
+      bottom: auto !important;
+    }
+    .left#{$variant}-auto {
+      left: auto !important;
+    }
+  }
 }
 
 /* Vertical align middle */
@@ -55,15 +68,19 @@
 }
 
 // Overflow utilities
-@each $overflow in (visible, hidden, auto, scroll) {
-  .overflow-#{$overflow} {
-    overflow: $overflow !important;
-  }
-  .overflow-x-#{$overflow} {
-    overflow-x: $overflow !important;
-  }
-  .overflow-y-#{$overflow} {
-    overflow-y: $overflow !important;
+@each $breakpoint, $variant in $responsive-variants {
+  @include breakpoint($breakpoint) {
+    @each $overflow in (visible, hidden, auto, scroll) {
+      .overflow#{$variant}-#{$overflow} {
+        overflow: $overflow !important;
+      }
+      .overflow#{$variant}-x-#{$overflow} {
+        overflow-x: $overflow !important;
+      }
+      .overflow#{$variant}-y-#{$overflow} {
+        overflow-y: $overflow !important;
+      }
+    }
   }
 }