jekyll-rtd-theme 1.1.4 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a52d768800e6af7ea1d5c4c35a91cee56046bade55174bcc0eb4d31e9ed676
-  data.tar.gz: 3d005a4cb29f27c512492cccfcdc9da428303af00df3f2ba5a7f3bc3a22e5c07
+  metadata.gz: 0fe2af4a55863950ce67d80e629b1b91e87a7381598baf0a39e66d8d577e48b3
+  data.tar.gz: d7735dedfcf430ab8cbb1d6f4708aa2ae036d4faff449cc8af18b9e4b5d3e4f2
 SHA512:
-  metadata.gz: 022acda52128c5ced54cb84635fd067ff26ed77c99a8bc4e50762ba40d3769104d739e82ad08f56958b802f8eed716407c7d1e094cdcec75c7e3c264791cf0a8
-  data.tar.gz: 68f91d2be6fb03d1c00b2d29c84acd297c4539478a6b1622fbf69dee85a71b91d8ea1326d98e1687b6676621bba2027e2e858602bb24f8333eaaa0a6bc7815c5
+  metadata.gz: cd1194ed2522bb51043228ca16f92cc44fb79eb4cb5e12806a6f655b2d04a264cc57efa0382ade4e08887dd6729e8ff0f3e23e9979a173b5abe20935f7662067
+  data.tar.gz: ef92a03c1da2d455219a4f65f3a89d352ecbc4379fe3e24882f14381bb6e5c8d53687a60c0b90370476f63f2761ef6b80622f9fd805601c95409f181a967752a

data/_includes/addons/analytics.liquid

@@ -6,3 +6,13 @@
         </a>
     </dd>
 </dl>
+
+<script>
+    $(document).ready(function() {
+        let analytics = new URL("https://rundocs-analytics.glitch.me/collect?v={{ version }}&lang={{ lang }}");
+        analytics.searchParams.append("user_lang", navigator.language);
+        analytics.searchParams.append("host", location.host);
+        analytics.searchParams.append("platform", navigator.platform);
+        $.getJSON(analytics.toString(), (data) => $("#counter").html(data.count));
+    });
+</script>

data/_includes/assets/common.js

@@ -1,39 +1,75 @@
 $(document).ready(function() {
-    let analytics = new URL("https://rundocs-analytics.glitch.me/collect?v={{ version }}&lang={{ lang }}");
-    let highlight = new URL(location.href).searchParams.get("highlight");
-    let current = $(".wy-menu-vertical").find(`[href="${location.pathname}"]`);
+    function set(name, value) {
+        return localStorage.setItem(name, value);
+    }
 
-    /* directory toc */
-    if (current.length > 0) {
-        current.closest("li.toctree-l1").parent().addClass("current");
-        current.closest("li.toctree-l1").addClass("current");
-        current.closest("li.toctree-l2").addClass("current");
-        current.closest("li.toctree-l3").addClass("current");
-        current.closest("li.toctree-l4").addClass("current");
-        current.closest("li.toctree-l5").addClass("current");
-        current[0].scrollIntoView();
+    function get(name) {
+        return localStorage.getItem(name) || false;
     }
-    /* content toc */
-    $(".wy-menu-vertical li.current").append(function() {
-        let level = parseInt($(this).attr("class").match(/toctree-l(\d+)/)[1]) + 1;
-        let toc = ["<ul>"];
-        let sort = parseInt(this.dataset.sort);
+
+    /* anchors */
+    anchors.add();
+
+    /* generate content TOC (id from anchors) */
+    $(".wy-menu-vertical li.current").append('<ul class="content-toc"></ul>').html(function() {
+        let level = parseInt(this.dataset.level);
+        let temp = 0;
+        let stack = [$(this).find(".content-toc")];
 
         $(".document").find("h2,h3,h4,h5,h6").each(function() {
-            toc.push(`<li class="toctree-l${level}"><a class="reference internal" href="#${this.id}">${$(this).text()}</a></li>`);
+            let anchor = $("<a/>").addClass("reference internal").text($(this).text()).attr("href", `#${this.id}`);
+            let tagLevel = parseInt(this.tagName.slice(1)) - 1;
+
+            if (tagLevel > temp) {
+                let parent = stack[0].children("li:last")[0];
+                if (parent) {
+                    stack.unshift($("<ul/>").appendTo(parent));
+                }
+            } else {
+                stack.splice(0, Math.min(temp - tagLevel, Math.max(stack.length - 1, 0)));
+            }
+            temp = tagLevel;
+
+            $("<li/>").addClass(`toctree-l${level + tagLevel}`).append(anchor).appendTo(stack[0]);
         });
-        toc.push("</ul>");
-        /* return is apend */
-        if (toc.length == 2) {
-            return "";
-        } else {
-            return toc.join("");
+        /* if TOC is empty remove ul */
+        if (!stack[0].html()) {
+            stack[0].remove();
         }
     });
+
+    /* display current file in TOC */
+    let link = $(".wy-menu-vertical").find(`[href="${location.pathname}"]`);
+    if (link.length > 0) {
+        link.closest("li.toctree-l1").parent().addClass("current");
+        link.closest("li.toctree-l1").addClass("current");
+        link.closest("li.toctree-l2").addClass("current");
+        link.closest("li.toctree-l3").addClass("current");
+        link.closest("li.toctree-l4").addClass("current");
+        link.closest("li.toctree-l5").addClass("current");
+    }
+
+    /* restore sidebar scroll within 10 minutes */
+    let scroll = get("scroll");
+    let scrollTime = get("scrollTime");
+    let scrollHost = get("scrollHost");
+
+    if (scroll && scrollTime && scrollHost) {
+        if (scrollHost == location.host && (Date.now() - scrollTime < 6e5)) {
+            $(".wy-side-scroll").scrollTop(scroll);
+        }
+    }
+    $(".wy-side-scroll").scroll(function() {
+        set("scroll", this.scrollTop);
+        set("scrollTime", Date.now());
+        set("scrollHost", location.host);
+    });
+
     /* native nav */
     SphinxRtdTheme.Navigation.enable(true);
 
     /* search highlight */
+    let highlight = new URL(location.href).searchParams.get("highlight");
     if (highlight) {
         $(".section").find("*").each(function() {
             try {
@@ -41,7 +77,7 @@ $(document).ready(function() {
                     $(this).addClass("highlighted-box");
                 }
             } catch (e) {
-                feedback(["highlight", e.message]);
+                debug(e.message);
             }
         });
         $(".section").find(".highlighted-box").each(function() {
@@ -50,16 +86,9 @@ $(document).ready(function() {
             }
         });
     }
+
     /* admonition */
     $(".admonition-title").each(function() {
         $(this).html(ui.admonition[$(this).attr("ui")]);
     });
-    /* anchors */
-    anchors.add();
-
-    /* analytics */
-    analytics.searchParams.append("user_lang", navigator.language);
-    analytics.searchParams.append("host", location.host);
-    analytics.searchParams.append("platform", navigator.platform);
-    $.getJSON(analytics.toString(), (data) => $("#counter").html(data.count));
-});
+});

data/_includes/assets/search.js

@@ -13,7 +13,7 @@ function search(data) {
         $(".search").empty();
         $(".search-summary").html(i18n[lang].search_results_not_found);
         $("#search-results h2").html(i18n[lang].search_results);
-        return feedback(["search", e.message]);
+        return debug(e.message);
     }
 
     function slice(content, min, max) {
@@ -32,7 +32,7 @@ function search(data) {
                 }
             }
         } catch (e) {
-            feedback(["search", e.message]);
+            debug(e.message);
         }
         try {
             if (page.content) {
@@ -40,7 +40,7 @@ function search(data) {
                 content = page.content.match(regexp);
             }
         } catch (e) {
-            feedback(["search", e.message]);
+            debug(e.message);
         }
         if (title || content) {
             let result = [`<a href="${ui.baseurl}${page.url}?highlight=${text}">${page.title}</a>`];
@@ -72,5 +72,5 @@ function search(data) {
 }
 
 $(document).ready(function() {
-    $.ajax(`${ui.baseurl}/pages.json`).done(search).fail((xhr, message) => feedback(["search", message]));
+    $.ajax(`${ui.baseurl}/pages.json`).done(search).fail((xhr, message) => debug(message));
 });

data/_includes/assets/sw.caches.js

@@ -0,0 +1,33 @@
+self.addEventListener("activate", function(event) {
+    let cacheWhitelist = ["rundocs-{{ version }}"];
+
+    event.waitUntil(
+        caches.keys().then(function(keyList) {
+            return Promise.all(keyList.map(function(key) {
+                if (cacheWhitelist.indexOf(key) === -1) {
+                    return caches.delete(key);
+                }
+            }));
+        })
+    );
+});
+
+self.addEventListener("fetch", function(e) {
+    if (/^https:\/\/cdn\.jsdelivr\.net\/gh\/rundocs\/jekyll-rtd-theme@.+/.exec(e.request.url)) {
+        e.respondWith(
+            caches.match(e.request).then(function(resp) {
+                if (resp !== undefined) {
+                    return resp;
+                } else {
+                    return fetch(e.request, { cache: "no-store" }).then(function(resp) {
+                        let clone = resp.clone();
+                        caches.open("rundocs-{{ version }}").then(function(cache) {
+                            cache.put(e.request, clone);
+                        });
+                        return resp;
+                    }).catch(console.log);
+                }
+            })
+        );
+    }
+});

data/_includes/extend/toctree.liquid

@@ -24,7 +24,7 @@
             {%- assign level = level | minus: 1 -%}
         {%- endif -%}
 
-        <li class="toctree-l{{ level }} {{ current }}" data-sort="{{ item.sort }}">
+        <li class="toctree-l{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
             <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
                 {%- if item.sort and site.show_sorted != false -%}
                     {{ item.sort }}. {{ item.title | default: item.url }}

data/_includes/reset/defaults.liquid

@@ -1,10 +1,10 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.4" -%}
+{%- assign version = "1.1.5" -%}
 {%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
 
 {%- assign schema_date = page.date | default: site.time | date_to_xmlschema -%}
 {%- assign schema_modi = site.time | date_to_xmlschema -%}
-{%- assign schema_surl = page.url | absolute_url | replace: 'http://', 'https://' | xml_escape -%}
+{%- assign schema_surl = page.url | absolute_url | xml_escape -%}
 
 {% comment %} scss {% endcomment %}
 {%- capture site_scss -%}
@@ -58,8 +58,8 @@
 {% comment %} content {% endcomment %}
 {%- assign content = content
     | replace: '’', "'"
-    | replace: '<pre class="highlight"><code>', "<pre>"
-    | replace: '<pre><code class=', "<pre class="
+    | replace: '<pre class="highlight"><code>', '<pre class="notranslate">'
+    | replace: '<pre><code class="', '<pre class="notranslate '
     | replace: "</code></pre>", "</pre>"
     | replace: '<code class="language-plaintext highlighter-rouge">', '<code class="literal">'
     | replace: "<table>", '<table class="docutils align-default">' -%}

data/_includes/toctree.liquid

@@ -10,9 +10,13 @@
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
-        <li class="toctree-l{{ level }} {{ current }}">
+        <li class="toctree-l{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
             <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
-                {{ item.title | default: item.url }}
+                {%- if item.sort and site.show_sorted != false -%}
+                    {{ item.sort }}. {{ item.title | default: item.url }}
+                {%- else -%}
+                    {{ item.title | default: item.url }}
+                {%- endif -%}
             </a>
         </li>
     {%- endfor %}

data/_layouts/default.liquid

@@ -28,13 +28,17 @@ layout: plugins/compress
             dataLayer.push(arguments);
         }
 
-        function feedback(messages) {
-            gtag("event", "exception", {
-                "description": messages.join(":")
-            });
+        function debug() {
+            console.debug.apply(console, arguments);
         }
 
         gtag("js", new Date());
+
+        if ("serviceWorker" in navigator) {
+            navigator.serviceWorker.register("{{ site.baseurl }}/sw.caches.js");
+        } else {
+            debug("Service Worker not supported!");
+        }
     </script>
     <!-- meta -->
     <meta name="description" content="{{ description }}">
@@ -85,8 +89,8 @@ layout: plugins/compress
     </script>
     <!-- link -->
     <link rel="canonical" href="{{ schema_surl }}">
-    {% if prev %}<link rel="prev" href="{{ prev.url | absolute_url | replace: 'http://', 'https://' }}">{% endif %}
-    {% if next %}<link rel="next" href="{{ next.url | absolute_url | replace: 'http://', 'https://' }}">{% endif %}
+    {% if prev %}<link rel="prev" href="{{ prev.url | absolute_url }}">{% endif %}
+    {% if next %}<link rel="next" href="{{ next.url | absolute_url }}">{% endif %}
     <!-- theme -->
     <link rel="stylesheet" href="{{ cdn }}/assets/css/theme.css">
     <link rel="stylesheet" href="{{ cdn }}/assets/css/rougify/{{ site.rougify | default: 'github' }}.css">
@@ -182,15 +186,18 @@ layout: plugins/compress
     <!-- script -->
     <script src="{{ cdn }}/assets/js/theme.js"></script>
     <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
+
     {% comment %} mermaid {% endcomment %}
-    {%- if content contains '<pre class="language-mermaid">' -%}
-        {%- if site.mermaid.src -%}
-            <script src="{{ site.mermaid.src }}"></script>
+    {%- if content contains '<pre class="notranslate language-mermaid">' -%}
+        {%- if site.mermaid.custom -%}
+            <script src="{{ site.mermaid.custom }}"></script>
         {%- else -%}
             <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
-        {%- endif -%}
-        <script>mermaid.initialize({startOnLoad: true});</script>
-    {%- endif -%}
+        {%- endif %}
+        <script>
+            mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
+        </script>
+    {%- endif %}
     <script>
         {% include assets/common.js %}
         {% include assets/custom.js %} {{ site.script }}

data/_layouts/plugins/extension.liquid

@@ -8,7 +8,7 @@
         {%- assign admonitions = "note, tip, warning, danger" | split: ", " -%}
         {%- comment %} get pre code and type {% endcomment -%}
         {%- assign pre_blocks = child_blocks.first | replace_first: ">", "```<temp>```" | split: "```<temp>```" -%}
-        {%- assign pre_type = pre_blocks.first | replace: '"', '' | replace: " class=language-", ""  -%}
+        {%- assign pre_type = pre_blocks.first | replace: '"', '' | replace: " class=notranslate language-", ""  -%}
 
         {%- if admonitions contains pre_type -%}
             <div class="admonition {{ pre_type }}">

data/assets/robots.liquid

@@ -6,4 +6,4 @@ permalink: /robots.txt
 User-agent: *
 Allow: /
 
-Sitemap: {{ "sitemap.xml" | absolute_url | replace: "http://", "https://" }}
+Sitemap: {{ "sitemap.xml" | absolute_url }}

data/assets/sitemap.liquid

@@ -9,7 +9,7 @@ permalink: /sitemap.xml
 <urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
     {%- for page in site_pages -%}
         <url>
-            <loc>{{ page.url | absolute_url | replace: "http://", "https://" | xml_escape }}</loc>
+            <loc>{{ page.url | absolute_url | xml_escape }}</loc>
             <priority>{{ page.content | size | divided_by: 2048.0 | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 }}</priority>
             <lastmod>{{ site.time | date_to_xmlschema }}</lastmod>
         </url>

data/assets/sw.caches.liquid

@@ -0,0 +1,8 @@
+---
+layout: plugins/compress
+permalink: /sw.caches.js
+---
+
+{%- include reset/defaults.liquid -%}
+
+{%- include assets/sw.caches.js -%}

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rtd-theme
 version: !ruby/object:Gem::Version
-  version: 1.1.4
+  version: 1.1.5
 platform: ruby
 authors:
 - saowang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-21 00:00:00.000000000 Z
+date: 2020-08-24 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -43,6 +43,7 @@ files:
 - _includes/assets/custom.js
 - _includes/assets/custom.scss
 - _includes/assets/search.js
+- _includes/assets/sw.caches.js
 - _includes/breadcrumbs.liquid
 - _includes/extend/list.liquid
 - _includes/extend/tabs.liquid
@@ -125,6 +126,7 @@ files:
 - assets/robots.liquid
 - assets/search.liquid
 - assets/sitemap.liquid
+- assets/sw.caches.liquid
 homepage: https://github.com/rundocs/jekyll-rtd-theme
 licenses:
 - MIT