jekyll-rtd-theme 1.1.0 → 1.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b629411d3d74c24a69ba9ef73ece57bd3c002921eed7f78894dba51b71a24199
-  data.tar.gz: 5b8f754497e66c35af98199a8f077e207fd259bf29c6e74111aa152b3c6323d1
+  metadata.gz: 0fe2af4a55863950ce67d80e629b1b91e87a7381598baf0a39e66d8d577e48b3
+  data.tar.gz: d7735dedfcf430ab8cbb1d6f4708aa2ae036d4faff449cc8af18b9e4b5d3e4f2
 SHA512:
-  metadata.gz: 3fb991c0098234c7d1c551c912d693a583bf84a507817722c38f89ca91b4812aa38919825726a8bf26fd51d81579e1a0e87e7ec3cc3897355edeca2418843e98
-  data.tar.gz: d717925336199e3242e956b6108d9f36e438cff3f291891b27ffde8385598ed72ef7a010d145e6230125c7492adfd367021c186ddb393779b90809bcb2414d5a
+  metadata.gz: cd1194ed2522bb51043228ca16f92cc44fb79eb4cb5e12806a6f655b2d04a264cc57efa0382ade4e08887dd6729e8ff0f3e23e9979a173b5abe20935f7662067
+  data.tar.gz: ef92a03c1da2d455219a4f65f3a89d352ecbc4379fe3e24882f14381bb6e5c8d53687a60c0b90370476f63f2761ef6b80622f9fd805601c95409f181a967752a

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 support
-
-## Roadmap
-See the [open issues](https://github.com/rundocs/jekyll-rtd-theme/issues) for a list of proposed features (and known issues)
+- Google, Baidu, CNZZ Analytics supported
+- Just need one file `_config.yml` to configure site
 
 ## Documents
-You can view theme related [tests](https://jekyll-rtd-theme.rundocs.io), 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

@@ -2,13 +2,17 @@
     <dt>{{ __statistics }}</dt>
     <dd>
         <a href="https://github.com/rundocs/analytics" target="_blank">
-            {{ __total_visits }} <span id="counter"></span> <i class="fa fa-eye"></i>
+            {{ __total_visits }} <span id="counter"><span class="progress"></span></span> <i class="fa fa-eye"></i>
         </a>
     </dd>
 </dl>
 
 <script>
     $(document).ready(function() {
-        $.getJSON("https://rundocs-analytics.glitch.me/analytics?host=" + location.host, (data) => $("#counter").html(data.count));
+        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,21 +1,75 @@
 $(document).ready(function() {
-    let highlight = new URL(location.href).searchParams.get("highlight");
+    function set(name, value) {
+        return localStorage.setItem(name, value);
+    }
+
+    function get(name) {
+        return localStorage.getItem(name) || false;
+    }
+
+    /* anchors */
+    anchors.add();
 
-    SphinxRtdTheme.Navigation.reset = function() {
-        const link = $(".wy-menu-vertical").find(`[href="${location.pathname}"]`);
-        if (link.length > 0) {
-            $(".wy-menu-vertical .current").removeClass("current");
-            link.addClass("current");
-            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");
+    /* 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() {
+            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]);
+        });
+        /* 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 {
@@ -23,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() {
@@ -32,9 +86,9 @@ $(document).ready(function() {
             }
         });
     }
-    for (let item in ui.admonition) {
-        let content = $(`.language-${item}`).html();
-        $(`.language-${item}`).replaceWith(`<div class="admonition ${item}"><p class="admonition-title">${ui.admonition[item]}</p><p>${content}</p></div>`);
-    }
-    anchors.add();
-});
+
+    /* admonition */
+    $(".admonition-title").each(function() {
+        $(this).html(ui.admonition[$(this).attr("ui")]);
+    });
+});

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

@@ -1,18 +1,22 @@
 {%- include reset/workdir.liquid %}
 
+{% comment %} display the directory name {% endcomment %}
 {%- assign dir = site_pages | where: "url", workdir | first -%}
 {%- if site_lang != lang -%}
+    {% comment %} current in language directory (level-1) {% endcomment %}
     {%- assign workdir_level = workdir_level | minus: 1 -%}
 {%- endif -%}
 {%- if workdir_level == 2 %}
+    {% comment %} display the root sub-directory as "p.caption" {% endcomment %}
     <p class="caption"><span class="caption-text">{{ dir.title | default: dir.url }}</span></p>
 {%- else %}
     <a class="reference internal" href="{{ dir.url | relative_url }}">{{ dir.title | default: dir.url }}</a>
 {%- endif -%}
 
 <ul>
+    {% comment %} list file {% endcomment %}
     {%- for item in workdir_files -%}
-        {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
+        {%- assign level = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 1 -%}
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
@@ -20,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 }}
@@ -30,8 +34,10 @@
             </a>
         </li>
     {%- endfor -%}
+
+    {% comment %} list dirs {% endcomment %}
     {%- for workdir in workdir_dirs -%}
-        {%- assign level = workdir | append: "temp/" | split: "/" | size | minus: 3 %}
+        {%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
         {%- if site_lang != lang -%}
             {%- assign level = level | minus: 1 -%}
         {%- endif -%}

data/_includes/footer.liquid

@@ -32,6 +32,6 @@
         </div>
     {%- endif -%}
     <div role="contentinfo" class="copyright rundocs">
-        <p>Powered by <a href="https://rundocs.io">rundocs.io</a> using the jekyll docs theme <a href="https://jekyll-rtd-theme.rundocs.io">jekyll-rtd-theme</a></p>
+        <p>Powered by <a href="https://rundocs.io">rundocs.io</a> using the jekyll docs theme <a href="https://rundocs.github.io/jekyll-rtd-theme">jekyll-rtd-theme</a></p>
     </div>
 </footer>

data/_includes/i18n/es.liquid

@@ -0,0 +1,29 @@
+{% comment %} Spanish {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "Página principal" -%}
+{%- assign __issues = "Cuestiones" -%}
+{%- assign __download = "Descargar" -%}
+{%- assign __plugins = "Complementos temáticos" -%}
+{%- assign __translations = "Traducciones" -%}
+{%- assign __statistics = "Estadísticas" -%}
+{%- assign __total_visits = "Visitas totales:" -%}
+
+{%- assign __note = "Observaciones" -%}
+{%- assign __tip = "Consejos" -%}
+{%- assign __warning = "Advertencia" -%}
+{%- assign __danger = "Peligro" -%}
+
+{%- assign __next = "Siguiente página" -%}
+{%- assign __previous = "Pagina anterior" -%}
+{%- assign __copyright = "Derechos de autor" -%}
+{%- assign __revision = "Revisión" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "¡Esta página aún no existe!" -%}
+
+{%- assign __searching = "Buscando" -%}
+{%- assign __search = "Buscar" -%}
+{%- assign __search_docs = "Buscar documentos" -%}
+{%- assign __search_results = "Resultados de la búsqueda" -%}
+{%- assign __search_results_found = "Búsqueda finalizada, se encontraron # páginas que coinciden con la consulta de búsqueda." -%}
+{%- assign __search_results_not_found = "Su búsqueda no coincide con ningún documento, asegúrese de que todos los caracteres estén escritos correctamente." -%}

data/_includes/i18n/sv.liquid

@@ -0,0 +1,29 @@
+{% comment %} Swedish {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "Hemsida" -%}
+{%- assign __issues = "frågor" -%}
+{%- assign __download = "Ladda ner" -%}
+{%- assign __plugins = "Tema Plugins" -%}
+{%- assign __translations = "översättningar" -%}
+{%- assign __statistics = "Statistik" -%}
+{%- assign __total_visits = "Totalt antal besök:" -%}
+
+{%- assign __note = "Anmärkningar" -%}
+{%- assign __tip = "tips" -%}
+{%- assign __warning = "Varning" -%}
+{%- assign __danger = "Fara" -%}
+
+{%- assign __next = "Nästa sida" -%}
+{%- assign __previous = "Föregående sida" -%}
+{%- assign __copyright = "upphovsrätt" -%}
+{%- assign __revision = "Revision" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "Den här sidan finns inte ännu!" -%}
+
+{%- assign __searching = "Sökande" -%}
+{%- assign __search = "Sök" -%}
+{%- assign __search_docs = "Sök i dokument" -%}
+{%- assign __search_results = "sökresultat" -%}
+{%- assign __search_results_found = "Sökningen är klar, hittade # sida (er) som matchar sökfrågan." -%}
+{%- assign __search_results_not_found = "Din sökning matchade inga dokument, se till att alla tecken stavas korrekt!" -%}

data/_includes/reset/defaults.liquid

@@ -1,13 +1,14 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.0" -%}
+{%- assign version = "1.1.5" -%}
 {%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
 
-{%- assign schema_lastmod = site.time | date_to_xmlschema -%}
-{%- assign schema_url = page.url | absolute_url | replace: 'http://', 'https://' | xml_escape -%}
+{%- 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 | 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 -%}
@@ -21,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 = "" -%}
@@ -67,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/reset/workdir.liquid

@@ -8,12 +8,12 @@
     {%- endif -%}
 {%- endif -%}
 
-{%- assign workdir_level = workdir | append: "temp/" | split: "/" | size | minus: 1 -%}
+{%- assign workdir_level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
 {%- assign workdir_files = site_files | where_exp: "item", "item.dir == workdir" -%}
 
 {%- capture items -%}
     {%- for item in site_dirs -%}
-        {%- assign current_m1 = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
+        {%- assign current_m1 = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 1 -%}
         {%- if workdir_level == current_m1 -%}
             {%- assign temp = workdir | append: "@@" -%}
             {%- assign dir = item.dir | replace: workdir, temp | split: "@@" | first -%}