jekyll-rtd-theme 2.0.2 → 2.0.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 9f4f4168adf2ae575fe0c262155ebb5449ce2a2d69c5c9be9c811287ab0527d6
-  data.tar.gz: 7d70ba9d589a881660140fda943b585ae9f77b392f2bdb1720adfe40bee375b4
+  metadata.gz: c1d81c4e4bca30f30060d2ff431ec4bd788637fe6e4194838a06e8fb1554859a
+  data.tar.gz: e83a3adaaabd7968459adffe41e74c4264d9695e61134855456384fb7807f231
 SHA512:
-  metadata.gz: 467ea12e4724b57506b3389b08bbeec30721572cb2c5ab00b7211c906a5deffa2674b34fb69778e8b156b8ead4d928f433466b82f0d3248df4900e7387e09f60
-  data.tar.gz: b4a165867d9e4090b97a1443194204fcde0551a069477cfad57cca4140e1816a11e26969595b8c912943da63340ce59a502d783a966ea741e97ab8033c105dc8
+  metadata.gz: 2a83835f2e9a9a729cbb0afc39495208a66903597156586356471419dbfe537b969f381ca6a980ac8ca752ccdf4ac2aaf516bcb15667b5c84643522ead8483e7
+  data.tar.gz: 35cbfe025b744d57243941837d2732667fad23e79da865cc5003fb4c0472a35d7aaac0a5974a7697b78ac761ca550b47de3fc0036dc148bc9a0507cd31081657

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!
@@ -38,12 +38,11 @@ readme_index:
   with_frontmatter: true
 
 ## optional settings ##
+direction: # default: auto, syntax: [ltr|rtl]
+
 meta:
   key1: value1
   key2: value2
-  .
-  .
-  .
 
 google:
   gtag:
@@ -68,6 +67,8 @@ translate:
   warning:
   # 404
   not_found:
+  # copyright
+  revision:
   # search
   searching:
   search:
@@ -83,7 +84,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/_breadcrumbs.liquid

@@ -1,7 +1,7 @@
 <div class="navigation-top d-flex flex-justify-between">
     <ul class="breadcrumb" role="navigation" aria-label="breadcrumbs navigation">
         <li class="breadcrumb-item">
-            <a class="no-underline" href="{{ site.baseurl }}/">
+            <a class="no-underline" href="{{ site.baseurl }}/" title="{{ docs.source.path }}">
                 <i class="fa fa-home"></i>
             </a>
         </li>

data/_includes/class/_footer.liquid

@@ -24,18 +24,20 @@
 
 <div class="copyright text-center text-gray" role="contentinfo">
     <i class="fa fa-copyright"></i>
-    {%- assign created_time = rest_created_at | date: "%Y" -%}
-    {%- assign updated_time = rest_updated_at | date: "%Y" -%}
-    {%- if created_time == updated_time -%}
-        {{ created_time }},
-    {%- else -%}
-        {{ created_time }}-{{ updated_time }},
-    {%- endif %}
+    <span class="time">
+        {%- assign created_time = rest_created_at | date: "%Y" -%}
+        {%- assign updated_time = rest_updated_at | date: "%Y" -%}
+        {%- if created_time == updated_time -%}
+            {{- created_time -}},
+        {%- else -%}
+            {{- created_time }}-{{ updated_time -}},
+        {%- endif -%}
+    </span>
     <a class="text-gray" href="{{ docs.owner_url }}" target="_blank">
-        {{ author }}
+        {{- author -}}
     </a>
     {{ __.revision | default: "Revision" }}
     <a class="text-gray" href="{{ docs.repository_url }}/commit/{{ docs.build_revision }}" title="{{ docs.build_revision }}" target="_blank">
-        {{ docs.build_revision | slice: 0, 7 }}
+        {{- docs.build_revision | slice: 0, 7 -}}
     </a>
 </div>

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

@@ -14,7 +14,20 @@
 {%- endif -%}
 
 {% comment %} theme {% endcomment %}
-<link rel="stylesheet" href="{{ cdn }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
+<link rel="stylesheet" href="{{ base }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
 
-{% comment %} icon {% endcomment %}
-<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">
+{%- if custom_scss.size > 0 -%}
+    <style>{{ custom_scss | scssify | strip_newlines }}</style>
+{%- endif -%}
+
+{% comment %} favicon icon {% endcomment %}
+<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/assets/images/favicon.svg">
+{% comment %} alternate {% endcomment %}
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-16x16.png" sizes="16x16">
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-32x32.png" sizes="32x32">
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-96x96.png" sizes="96x96">
+{% comment %} safari {% endcomment %}
+<link rel="mask-icon" href="{{ site.baseurl }}/assets/images/favicon.svg" color="#2980b9">
+
+{% comment %} apple-touch-icon {% endcomment %}
+<link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/images/apple-touch-icon-300x300.jpg">

data/_includes/node/metadata.liquid

@@ -10,7 +10,7 @@
     <meta name="{{ meta.first }}" content="{{ meta.last }}">
 {% endfor -%}
 
-{% comment %} https://ogp.me {% endcomment %}
+{% comment %} Open Graph {% endcomment %}
 <meta property="og:title" content="{{ title }}">
 <meta property="og:description" content="{{ description }}">
 <meta property="og:locale" content="{{ lang }}">
@@ -19,3 +19,11 @@
 <meta property="article:author" content="{{ author }}">
 <meta property="article:published_time" content="{{ schema_date }}">
 <meta property="article:modified_time" content="{{ schema_modi }}">
+
+{% comment %} Twitter Card {% endcomment %}
+<meta name="twitter:title" content="{{ title }}">
+<meta name="twitter:description" content="{{ description }}">
+<meta name="twitter:card" content="summary">
+<meta name="twitter:site" content="@{{ author }}">
+<meta name="twitter:url" content="{{ schema_surl }}">
+<meta name="twitter:creator" content="@jekyll-rtd-theme v{{ version }}">

data/_includes/node/script.extension.liquid

@@ -3,7 +3,7 @@
     {%- if site.mermaid.custom -%}
         <script src="{{ site.mermaid.custom }}"></script>
     {%- else -%}
-        <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
+        <script src="{{ base }}/assets/js/mermaid.min.js"></script>
     {%- endif %}
     <script>
         mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});

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' }}",
@@ -11,5 +10,10 @@
         }
     };
 </script>
-<script src="{{ cdn }}/assets/js/jquery.min.js"></script>
-<script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>
+<script src="{{ base }}/assets/js/jquery.min.js"></script>
+
+{%- if custom_script.size > 0 -%}
+    <script>{{ custom_script }}</script>
+{%- endif -%}
+
+<script src="{{ base }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/reset/content.liquid

@@ -0,0 +1,6 @@
+{%- assign content = content
+    | replace: "’", "'"
+    | replace: "“", '"'
+    | replace: "”", '"'
+    | replace: "<script", '<script async'
+    | 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,32 @@
+{%- 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 direction = site.direction | default: "auto" -%}
+{%- 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 base = site.baseurl -%}
+{%- else -%}
+    {%- assign base = "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.7" -%}

data/_includes/shortcodes/danger.liquid

@@ -1,9 +1,9 @@
-<div class="admonition danger mb-3">
+<div class="toasts danger mb-4">
     <div class="title px-2 py-1">
-        <i class="fa fa-exclamation-circle"></i>
+        <i class="fa fa-exclamation-triangle"></i>
         {{ __.danger | default: "Danger" }}
     </div>
-    <div class="content p-2">
+    <div class="content px-2 py-3">
         {{ codes | markdownify | strip_newlines -}}
     </div>
 </div>

data/_includes/shortcodes/mermaid.liquid

@@ -1 +1 @@
-<div class="mermaid overflow-x-auto">{{ codes }}</div>
+<div class="mermaid overflow-x-auto p-3 mb-4" data-lang="{{ codes | split: ' ' | first }}">{{ codes }}</div>

data/_includes/shortcodes/note.liquid

@@ -1,9 +1,9 @@
-<div class="admonition note mb-3">
+<div class="toasts note mb-4">
     <div class="title px-2 py-1">
-        <i class="fa fa-exclamation-circle"></i>
+        <i class="fa fa-info-circle"></i>
         {{ __.note | default: "Note" }}
     </div>
-    <div class="content p-2">
+    <div class="content px-2 py-3">
         {{ codes | markdownify | strip_newlines -}}
     </div>
 </div>