jekyll-rtd-theme 1.1.2 → 1.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 2e823e3b01e51ae8671337a94314e736ab6227762eb7477bf0ae8fbb0d0ad1c3
-  data.tar.gz: 222f110766405f9cd0a299dfccde339f04ac85ea82abf8258ca471a3d39353e5
+  metadata.gz: bfa6e7cffcb895b7a19f9f904415f281083b74a3578bb9e2679058895719c54a
+  data.tar.gz: 144a22891ac23e3fc30dbfc9b2ccfa11c595be2667f0d24de1c034f747086e05
 SHA512:
-  metadata.gz: 9ded9e6c16623c617ea73684a082742b29bf850f4bf7dab8d99e3ee58cf2dfb6730c97f0a6863b5ad9cb9be71436b119947544f4d610e3e415c9a875792fd0b1
-  data.tar.gz: acdbeaf0a2631fe40d1c08b2c2245ce18af876fcba2304b4b949368476a785629373f6241c419a8776293672531e790385277ad992f24f7e8879737e759d6ddf
+  metadata.gz: 53034a59f804c982e3c36dc863567050dbb8c45bd510c09e6244c9e839d0456df681dfb3e4deb2b1b9a8d3aedb87f7aa2db0f20692aa80fde22e471d21e6b201
+  data.tar.gz: fb7a032b4b6f85f82cd9078ba514970fce313cf2b6dbab52689c7de8979ce69da7aa38560ba63cad1c20885e67f6980d749ff776f4f8b51dd66be42a4d918f24

data/README.md

@@ -7,28 +7,34 @@
 [![](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 our website ([rundocs.io](https://rundocs.io/)) for details
 
-## The 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).
+### test
+- Latest test document: [rundocs.github.io/jekyll-rtd-theme](https://rundocs.github.io/jekyll-rtd-theme)
+- Preview debug branch, please refer to [rundocs.github.io/debug](https://rundocs.github.io/debug)
 
+## The license
+The theme is available as open source under the terms of the MIT License
 
 [repository]: https://github.com/rundocs/jekyll-rtd-theme
 [rubygem]: https://rubygems.org/gems/jekyll-rtd-theme

data/_includes/addons.liquid

@@ -1,7 +1,7 @@
 <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
         <span class="fa fa-book"> {{ site.title }}</span>
-        {% if site.addons_branch and site.github_metadata != false %}v: {{ branch }}{% endif %}
+        {% if site.addons_branch and site.github_metadata != false %}{{ branch }}{% endif %}
         <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">
@@ -9,6 +9,10 @@
         {% for item in items -%}
             {%- if addons contains item -%}
                 {% include addons/{{ item }}.liquid %}
+            {%- else -%}
+                {%- if item.github -%}
+                    {% include addons/github.liquid items=item.github %}
+                {%- endif -%}
             {%- endif -%}
         {% endfor -%}
         <hr>

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/addons/github.liquid

@@ -1,6 +1,20 @@
 <dl>
     <dt>{{ __github }}</dt>
-    <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-    <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-    <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
+    {%- if include.items -%}
+        {% for item in include.items -%}
+            {% case item %}
+                {% when "homepage" %}
+                    <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
+                {% when "issues" %}
+                    <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
+                {% when "download" %}
+                    <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
+                {% else %}
+            {% endcase %}
+        {% endfor -%}
+    {%- else -%}
+        <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
+        <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
+        <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
+    {%- endif -%}
 </dl>

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,157 @@ $(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) {
-        $(".admonition-title").each(function() {
-            $(this).html(ui.admonition[$(this).attr("ui")]);
-        });
+
+    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>');
 
-    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));
+        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));
+    });
+    $(document).on("scroll", function() {
+        let start = $(this).scrollTop() + 5;
+        let items = [];
+
+        $(".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", () => 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/footer.liquid

@@ -1,17 +1,19 @@
 <footer>
-    {%- if next or prev -%}
-        <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-            {%- if next -%}
-                <a href="{{ next.url | relative_url }}" class="btn btn-neutral float-right" title="{{ next.title }}" accesskey="n" rel="next">
-                    {{- __next }} <span class="fa fa-arrow-circle-right"></span>
-                </a>
-            {%- endif -%}
-            {%- if prev -%}
-                <a href="{{ prev.url | relative_url }}" class="btn btn-neutral  float-left" title="{{ prev.title }}" accesskey="p" rel="prev">
-                    <span class="fa fa-arrow-circle-left"></span> {{ __previous -}}
-                </a>
-            {%- endif -%}
-        </div>
+    {%- if page.url != "/search.html" and page.url != "/404.html" -%}
+        {%- if next or prev -%}
+            <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
+                {%- if next -%}
+                    <a href="{{ next.url | relative_url }}" class="btn btn-neutral float-right" title="{{ next.title }}" accesskey="n" rel="next">
+                        {{- __next }} <span class="fa fa-arrow-circle-right"></span>
+                    </a>
+                {%- endif -%}
+                {%- if prev -%}
+                    <a href="{{ prev.url | relative_url }}" class="btn btn-neutral  float-left" title="{{ prev.title }}" accesskey="p" rel="prev">
+                        <span class="fa fa-arrow-circle-left"></span> {{ __previous -}}
+                    </a>
+                {%- endif -%}
+            </div>
+        {%- endif -%}
     {%- endif -%}
     <hr>
     {%- if site.copyright -%}

data/_includes/reset/defaults.liquid

@@ -1,10 +1,10 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.2" -%}
+{%- assign version = "1.1.7" -%}
 {%- 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 -%}
@@ -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">'
+    | replace: "</table>", '</table></div>' -%}
 
 {% comment %} prev and next {% endcomment %}
 {%- assign workdir_files = site_files | where_exp: "item", "item.dir == page.dir" -%}