jekyll-rtd-theme 1.1.1 → 1.1.6

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 195022eba0c5f3fcb99d247278f0fa8da67c554ba16829f1475d6b6bcc5ca482
-  data.tar.gz: 8c2081bea527becb525f1e0ec86959942e179ff49ea4ef63bbcf151e59460c88
+  metadata.gz: e623e1c2a34e05c520de194e2893323851d344c01638700815240352903369f2
+  data.tar.gz: e5a5b57710023f64e0767f9e347fbbfe9b39b192975ec4f33293863f9ec6783f
 SHA512:
-  metadata.gz: 539cf3a199ff035b039598609d880cd07dd6834f1c653e56f4bf4061a2989232d7b43719f35fe843ab2a0b11e6da6d7da53646b2fe81610d68ba17ce7160f3dd
-  data.tar.gz: d51f6474b9f776573eb16e2a599862b6fbb890a97c2c7ac8c5e62737861f3139162828246e052f899a801b063550eca190ec6e6cabeae48b526dafb0d690b248
+  metadata.gz: ceed9ba1e1c855a4a38dc5a6a8c78dcdf81922969fd09a450c83443c228f62cf56b2198d516b6452d12c3f1018f2e65e3dc636756f0f8c859e2346b6859eed24
+  data.tar.gz: 4fb3d3b40f6588d790326d43b187ddf61b275e96600543aaef84521eeb0cfc0063af8a714771cfbb289fa3396862c4bf4400a2efaf8b8d0c0f81e9036e917543

data/README.md

@@ -5,31 +5,35 @@
 [![](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]
 [![](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)][codefactor]
 [![](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com)
+[![](https://badges.gitter.im/rundocs/jekyll-rtd-theme.svg)][gitter]
 
-Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
+GitHub-flavored docs theme for Jekyll, based on sphinx_rtd_theme
 
-![](https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png)
+<img class="shadow-box" width="50%" alt="jekyll-rtd-theme" src="https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png">
+
+## Quick start
+```yml
+remote_theme: rundocs/jekyll-rtd-theme
+```
+You can [generate](https://github.com/rundocs/starter-slim/generate) with the same files and folders from [rundocs/starter-slim](https://github.com/rundocs/starter-slim/)
 
 ## Features
-- Automatically generate sidebar based on directory
-- Only need one file `_config.yml` to configure site
-- Search engine optimized
+- Automatically generate nested sidebar based on directory
 - Multi-language supported
+- Search engine optimized
 - Document search (RegExp supported)
 - Support third-party comments
 - Google, Baidu, CNZZ Analytics supported
-
-## Roadmap
-See the [open issues](https://github.com/rundocs/jekyll-rtd-theme/issues) for a list of proposed features (and known issues)
+- Just need one file `_config.yml` to configure site
 
 ## Documents
-You can view theme related [tests](https://rundocs.github.io/jekyll-rtd-theme), For full documentation, please refer to [https://rundocs.io](https://rundocs.io)
+For full documentation, please refer to [rundocs.io](https://rundocs.io/), You can also view [the theme related tests documentation](https://rundocs.github.io/jekyll-rtd-theme)
 
-## The License
+## License
 The theme is available as open source under the terms of the [MIT License](https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE).
 
-
 [repository]: https://github.com/rundocs/jekyll-rtd-theme
 [rubygem]: https://rubygems.org/gems/jekyll-rtd-theme
 [cdn]: https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme/
 [codefactor]: https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme
+[gitter]: https://gitter.im/rundocs/jekyll-rtd-theme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge

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,9 +1,6 @@
 $(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");
-
-    SphinxRtdTheme.Navigation.reset = function() {
-        const link = $(".wy-menu-vertical").find(`[href="${location.pathname}"]`);
+    function initialize(name) {
+        let link = $(".wy-menu-vertical").find(`[href="${decodeURI(name)}"]`);
         if (link.length > 0) {
             $(".wy-menu-vertical .current").removeClass("current");
             link.addClass("current");
@@ -14,34 +11,161 @@ $(document).ready(function() {
             link.closest("li.toctree-l4").addClass("current");
             link.closest("li.toctree-l5").addClass("current");
         }
-    };
-    SphinxRtdTheme.Navigation.enable(true);
-
-    if (highlight) {
-        $(".section").find("*").each(function() {
-            try {
-                if (this.outerHTML.match(new RegExp(highlight, "im"))) {
-                    $(this).addClass("highlighted-box");
+    }
+
+    function toggleCurrent(link) {
+        let closest = link.closest("li");
+        closest.siblings("li.current").removeClass("current");
+        closest.siblings().find("li.current").removeClass("current");
+        closest.find("> ul li.current").removeClass("current");
+        closest.toggleClass("current");
+    }
+
+    function toc() {
+        $(".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() {
+                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)));
                 }
-            } catch (e) {
-                feedback(["highlight", e.message]);
+                temp = tagLevel;
+
+                $("<li/>").addClass(`toctree-l${level + tagLevel}`).append(anchor).appendTo(stack[0]);
+            });
+            if (!stack[0].html()) {
+                stack[0].remove();
             }
         });
-        $(".section").find(".highlighted-box").each(function() {
-            if (($(this).find(".highlighted-box").length > 0)) {
-                $(this).removeClass("highlighted-box");
+    }
+
+    function set(name, value) {
+        return localStorage.setItem(name, value);
+    }
+
+    function get(name) {
+        return localStorage.getItem(name) || false;
+    }
+
+    function restore() {
+        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);
         });
     }
-    for (let item in ui.admonition) {
-        $(`.language-${item}`).each(function() {
-            $(this).replaceWith(`<div class="admonition ${item}"><p class="admonition-title">${ui.admonition[item]}</p><p>${$(this).html()}</p></div>`);
-        });
+
+    function highlight() {
+        let text = new URL(location.href).searchParams.get("highlight");
+        let box = ".highlighted-box";
+
+        if (text) {
+            $(".section").find("*").each(function() {
+                try {
+                    if (this.outerHTML.match(new RegExp(text, "im"))) {
+                        $(this).addClass("highlighted-box");
+                    }
+                } catch (e) {
+                    debug(e.message);
+                }
+            });
+            $(".section").find(box).each(function() {
+                if (($(this).find(box).length > 0)) {
+                    $(this).removeClass(box);
+                }
+            });
+        }
     }
+
     anchors.add();
+    toc();
+    initialize(location.pathname);
+    restore();
+    highlight();
+
+    /* nested ul */
+    $(".wy-menu-vertical ul").siblings("a").each(function() {
+        let link = $(this);
+        let expand = $('<span class="toctree-expand"></span>');
+
+        expand.on("click", function(e) {
+            e.stopPropagation();
+            toggleCurrent(link);
+            return false;
+        });
+        link.prepend(expand);
+    });
+
+    /* admonition */
+    $(".admonition-title").each(function() {
+        $(this).html(ui.admonition[$(this).attr("ui")]);
+    });
+
+    /* bind */
+    $(document).on("click", '[data-toggle="wy-nav-top"]', function() {
+        $('[data-toggle="wy-nav-shift"]').toggleClass("shift");
+        $('[data-toggle="rst-versions"]').toggleClass("shift");
+    });
+    $(document).on("click", ".wy-menu-vertical .current ul li a", function() {
+        $('[data-toggle="wy-nav-shift"]').removeClass("shift");
+        $('[data-toggle="rst-versions"]').toggleClass("shift");
+        toggleCurrent($(this));
+
+        $("html,body").animate({
+            scrollTop: $(this.hash).offset().top
+        }, 500);
+    });
+    $(document).on("scroll", function() {
+        let start = $(this).scrollTop() + ($(window).height() * 0.382);
+        let items = [];
 
-    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));
+        $(".document").find("h1,h2,h3,h4,h5,h6").each(function() {
+            items.push({
+                offset: $(this).offset().top,
+                id: this.id,
+                level: parseInt(this.tagName.slice(1))
+            });
+        });
+        for (let i = 0; i < items.length; i++) {
+            if (start > items[i].offset) {
+                if (i < items.length - 1) {
+                    if (start < items[i + 1].offset) {
+                        if (items[i].level == 1) {
+                            initialize(location.pathname);
+                        } else {
+                            initialize("#" + items[i].id);
+                        }
+                    }
+                } else {
+                    initialize("#" + items[i].id);
+                }
+            }
+        }
+    });
+    $(document).on("click", '[data-toggle="rst-current-version"]', function() {
+        $('[data-toggle="rst-versions"]').toggleClass("shift-up");
+    });
+    $(window).bind("resize", function() {
+        requestAnimationFrame(function() {});
+    });
+    $(window).bind("hashchange", (e) => initialize(location.hash || location.pathname));
 });

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 }}">
+        <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,14 +1,14 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.1" -%}
+{%- assign version = "1.1.6" -%}
 {%- 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 -%}
-    @import "site.scss";
+    @import "jekyll-rtd-theme.scss";
     {% if site.fluid %}@import "fluid.scss";{% endif %}
     {% include assets/custom.scss %} {{ site.scss }}
 {%- endcapture -%}
@@ -22,25 +22,15 @@
 
 {% comment %} github-metadata {% endcomment %}
 {%- if site.github_metadata != false -%}
-    {%- if jekyll.environment == "production" -%}
-        {%- assign author = site.author | default: site.github.owner_name -%}
-        {%- assign branch = site.github.source.branch -%}
-        {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
-        {%- assign repository_url = site.github.repository_url -%}
-        {%- assign issues_url = site.github.issues_url -%}
-        {%- assign zip_url = site.github.zip_url -%}
-        {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
-    {%- else -%}
-        {%- assign author = site.author | default: "[author]" -%}
-        {%- assign branch = "[branch]" -%}
-        {%- assign commit = "[commit]" -%}
-        {%- assign repository_url = "#" -%}
-        {%- assign issues_url = "#" -%}
-        {%- assign zip_url = "#" -%}
-        {%- assign github_edit_link = "#" -%}
-    {%- endif -%}
+    {%- assign author = site.author | default: site.github.owner_name -%}
+    {%- assign branch = site.github.source.branch -%}
+    {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
+    {%- assign repository_url = site.github.repository_url -%}
+    {%- assign issues_url = site.github.issues_url -%}
+    {%- assign zip_url = site.github.zip_url -%}
+    {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
 {%- else -%}
-    {%- assign author = site.author | default: "[author]" -%}
+    {%- assign author = site.author -%}
     {%- assign branch = "" -%}
     {%- assign commit = "" -%}
     {%- assign repository_url = "" -%}
@@ -68,11 +58,13 @@
 {% 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">' -%}
+    | replace: "<dl>", '<dl class="definition">'
+    | replace: "<table>", '<div class="wy-table-responsive"><table class="docutils align-default">'
+    | replace: "</table>", '</table></div>' -%}
 
 {% comment %} prev and next {% endcomment %}
 {%- assign workdir_files = site_files | where_exp: "item", "item.dir == page.dir" -%}

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,12 +89,12 @@ 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">
-    <style>{{ site_scss | scssify }}</style>
+    <style>{{ site_scss | scssify | strip_newlines }}</style>
     <!-- icon -->
     <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">
     <!-- script -->
@@ -109,6 +113,7 @@ layout: plugins/compress
             }
         };
     </script>
+    {% include extra/head.html %}
 </head>
 
 <body class="wy-body-for-nav">
@@ -141,8 +146,12 @@ layout: plugins/compress
         <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
             <!-- MOBILE NAV -->
             <nav class="wy-nav-top" aria-label="top navigation">
-                <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-                <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">{{ site.title }}</a>
+                <div class="flex">
+                    <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
+                    <div class="wy-nav-title">
+                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">{{ site.title }}</a>
+                    </div>
+                </div>
             </nav>
             <div class="wy-nav-content">
                 <div class="rst-content">
@@ -173,9 +182,21 @@ layout: plugins/compress
         </section>
     </div>
     {%- if site.addons %}{% include addons.liquid %}{% endif %}
+    {% include extra/footer.html %}
     <!-- 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="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({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
+        </script>
+    {%- endif %}
     <script>
         {% include assets/common.js %}
         {% include assets/custom.js %} {{ site.script }}