jekyll-rtd-theme 1.0.4 → 1.1.3

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cd0100e421bd3ccbc2da040ef98ccdbc657f8aad2224c6544f2baeded4761d5d
-  data.tar.gz: 6162401684e143cd3690c51dd1e8dcf4430dfe60c3fa670bd9b0928bbd134160
+  metadata.gz: 17d21728bc57e4cf176a94b347ec1fa282bc3330a2fb1fafd4fae290a81c6f9a
+  data.tar.gz: 5b7a0c810f57c8c819e5eb204e05fb9a364c7ab917b8a261c3764b060901cac1
 SHA512:
-  metadata.gz: 30acf708a39d44c221d0a01a74791df3ed94bf5384122ac472574ebd9196fcd25bfe1031c6ec32508e746f5c9444da6fdc2f0e02d896f94b521f627621bbf77a
-  data.tar.gz: 946c8bf42fb42359567acb26ab3c6ee2cd029d5a7ea5d412524d087081f83223b62bc24a1ba936bfbd4853c2e2cad09de7da1fc6cadceddd4bc49138bad6ae82
+  metadata.gz: 25d5137a9c12bfcae20f06eccf5a63f6468be384a7e8e3d2449da2d6a042a0f57a4aef8e5238ff69328103ae85328b5f5382360de935ae712c3b2ad2082777b7
+  data.tar.gz: c98a582a2bf2f770e4d167242983832fdb3443a74d7428deee6db8cf809f04dacb8b24862e439e25ffff83cd34035ff0283a56017419312797a3b99488d15c44

data/README.md

@@ -5,39 +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
 
-![][demo]
+<img class="shadow-box" width="50%" alt="jekyll-rtd-theme" src="https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png">
 
-## Notable features
-- Write documents directly, automatically generate toctree based on directory
-- Only need one file `_config.yml` to configure site
-- Bundled as a "theme gem" for easier installation/upgrading.
-- Compatible with GitHub Pages.
-- Optimized for search engines with support for Open Graph data.
-- Optimized for search engines with `robots.txt` and `sitemap.xml`.
-- Search engine (RegExp supported)
-- Commenting support
-- Google,Baidu,CNZZ Analytics support.
-- Multi-language supported
-- And many features waiting for you to discover.
+## 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/)
 
-## Roadmap
-See the [open issues][issues] for a list of proposed features (and known issues).
+## Features
+- 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
+- Just need one file `_config.yml` to configure site
 
 ## Documents
-For full documentation, see: [https://jekyll-rtd-theme.rundocs.io][site]
-
-## The License
-The theme is available as open source under the terms of the [MIT License][license].
+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)
 
+## 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
-[issues]: https://github.com/rundocs/jekyll-rtd-theme/issues
-[license]: https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE
-[site]: https://jekyll-rtd-theme.rundocs.io
 [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
-[demo]: https://user-images.githubusercontent.com/68011645/88376699-87980500-cdd0-11ea-8900-7bab8c811bc9.png
+[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,7 @@
     <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));
-    });
-</script>

data/_includes/assets/common.js

@@ -1,6 +1,24 @@
 $(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");
 
+    /* content toc */
+    $(".wy-menu-vertical li.current").append(function() {
+        let level = parseInt($(this).attr("class").match(/toctree-l(\d)/)[1]) + 1;
+        let toc = ["<ul>"];
+
+        $(".document").find("h2,h3,h4,h5,h6").each(function() {
+            toc.push(`<li class="toctree-l${level}"><a class="reference internal" href="#${this.id}">${$(this).html()}</a></li>`);
+        });
+        toc.push("</ul>");
+        /* return is apend */
+        if (toc.length == 2) {
+            return "";
+        } else {
+            return toc.join("");
+        }
+    });
+
     SphinxRtdTheme.Navigation.reset = function() {
         const link = $(".wy-menu-vertical").find(`[href="${location.pathname}"]`);
         if (link.length > 0) {
@@ -32,9 +50,13 @@ $(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>`);
-    }
+    $(".admonition-title").each(function() {
+        $(this).html(ui.admonition[$(this).attr("ui")]);
+    });
     anchors.add();
+
+    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/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 %}
@@ -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

@@ -31,7 +31,7 @@
             </p>
         </div>
     {%- endif -%}
-    <div role="contentinfo" class="copyright-rtd">
-        Powered by <a href="https://rundocs.io">rundocs.io</a>
+    <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://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.0.4" -%}
+{%- assign version = "1.1.3" -%}
 {%- 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 | replace: 'http://', 'https://' | 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 = "" -%}

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 -%}

data/_includes/toctree.liquid

@@ -1,8 +1,12 @@
 {%- include reset/workdir.liquid %}
 
+{% comment %} list the root files {% endcomment %}
 <ul>
     {%- for item in workdir_files -%}
-        {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 1 -%}
+        {%- assign level = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
+        {%- if site_lang != lang -%}
+            {%- assign level = level | minus: 1 -%}
+        {%- endif -%}
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
@@ -14,4 +18,5 @@
     {%- endfor %}
 </ul>
 
+{% comment %} list the root dirs {% endcomment %}
 {%- for workdir in workdir_dirs %}{% include extend/toctree.liquid %}{% endfor -%}

data/_layouts/default.liquid

@@ -14,7 +14,7 @@ layout: plugins/compress
     {%- endif %}
 -->
 
-<html amp class="writer-html5" lang="{{ lang }}">
+<html class="writer-html5" lang="{{ lang }}">
 
 <head>
     <meta charset="utf-8">
@@ -41,14 +41,16 @@ layout: plugins/compress
     <meta name="author" content="{{ author }}">
     <meta name="revised" content="{{ commit }}">
     <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
-    <!-- meta-og -->
+    <!-- meta-ogp -->
+    {% comment %} https://ogp.me {% endcomment %}
     <meta property="og:title" content="{{ title }}">
     <meta property="og:description" content="{{ description }}">
     <meta property="og:locale" content="{{ lang }}">
-    <meta property="og:url" content="{{ schema_url }}">
+    <meta property="og:url" content="{{ schema_surl }}">
     <meta property="og:type" content="article">
     <meta property="article:author" content="{{ author }}">
-    <meta property="article:modified_time" content="{{ schema_lastmod }}">
+    <meta property="article:published_time" content="{{ schema_date }}">
+    <meta property="article:modified_time" content="{{ schema_modi }}">
     <!-- meta-custom -->
     {% for meta in site.meta -%}
         <meta name="{{ meta.first }}" content="{{ meta.last }}">
@@ -60,7 +62,7 @@ layout: plugins/compress
             "@type": "Article",
             "mainEntityOfPage": {
                 "@type": "WebPage",
-                "@id": "{{ schema_url }}"
+                "@id": "{{ schema_surl }}"
             },
             "headline": "{{ title | truncate: 110 }}",
             "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
@@ -68,8 +70,8 @@ layout: plugins/compress
                 "@type": "Person",
                 "name": "{{ author }}"
             },
-            "datePublished": "{{ page.date | default: site.time | date_to_xmlschema }}",
-            "dateModified": "{{ schema_lastmod }}",
+            "datePublished": "{{ schema_date }}",
+            "dateModified": "{{ schema_modi }}",
             "publisher": {
                 "@type": "Organization",
                 "name": "RunDocs",
@@ -77,19 +79,20 @@ layout: plugins/compress
                     "@type": "ImageObject",
                     "url": "https://rundocs.io/logo.png"
                 }
-            }
+            },
+            "description": "{{ description }}"
         }
     </script>
     <!-- link -->
-    <link rel="canonical" href="{{ schema_url }}">
+    <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 %}
     <!-- 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 }}/assets/favicon.svg">
+    <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">
     <!-- script -->
     <!--[if lt IE 9]><script src="{{ cdn }}/assets/js/html5shiv.min.js"></script><![endif]-->
     <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
@@ -106,15 +109,6 @@ layout: plugins/compress
             }
         };
     </script>
-    {%- if jekyll.environment == "production" -%}
-        <script async src="https://www.googletagmanager.com/gtag/js?id=UA-174262874-1"></script>
-        <script>
-            gtag("set", {
-                "user_id": location.host
-            });
-            gtag("config", "UA-174262874-1");
-        </script>
-    {%- endif -%}
 </head>
 
 <body class="wy-body-for-nav">
@@ -147,19 +141,24 @@ 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">
                     {% include breadcrumbs.liquid %}
-                    <div class="document" role="main">
-                        {%- if page.url == "/search.html" -%}
-                            {{ content }}
-                        {%- else -%}
-                            <div class="section">{{ content }}</div>
-                        {%- endif -%}
-
+                    <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
+                        <div itemprop="articleBody">
+                            {%- if page.url == "/search.html" -%}
+                                {{ content }}
+                            {%- else -%}
+                                <div class="section">{{ content }}</div>
+                            {%- endif -%}
+                        </div>
                         {% comment %} comments {% endcomment %}
                         {% if site.disqus %}
                             <div id="disqus_thread" class="articleComments"></div>
@@ -181,6 +180,11 @@ 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">' -%}
+        <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
+        <script>mermaid.initialize({startOnLoad: true});</script>
+    {%- endif -%}
     <script>
         {% include assets/common.js %}
         {% include assets/custom.js %} {{ site.script }}
@@ -215,7 +219,6 @@ layout: plugins/compress
 
     {% comment %} Google Analytics {% endcomment %}
     {%- if site.google.gtag -%}
-        <!--  -->
         <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
         <script>
             gtag("config", "{{ site.google.gtag }}");