jekyll-rtd-theme 1.0.3 → 1.1.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: e6ab3ca0b72d6b6ae550ce6e421c2c80eb5367ab5e7219c31b565cf0c1c4fe38
-  data.tar.gz: c90717607dab1545b3b6b12376198000f962ba4b8efeca14b355c19b09011583
+  metadata.gz: 2e823e3b01e51ae8671337a94314e736ab6227762eb7477bf0ae8fbb0d0ad1c3
+  data.tar.gz: 222f110766405f9cd0a299dfccde339f04ac85ea82abf8258ca471a3d39353e5
 SHA512:
-  metadata.gz: 59c624650e717629807657c4595356d9cf08b7ff8ffc516430eecb26689d9e64664d0ca7b72b5b4c3420c5b4ce14ea5c9b84c272ff74b8d4bc18720e83252419
-  data.tar.gz: b424b8d443805882799667df8f8a4a7fa99c2046425bf915b2afa2c162d98db4f3e999342999f5411d16580d55613d6b1a5d4551882cadbe97321b106c8f9cc9
+  metadata.gz: 9ded9e6c16623c617ea73684a082742b29bf850f4bf7dab8d99e3ee58cf2dfb6730c97f0a6863b5ad9cb9be71436b119947544f4d610e3e415c9a875792fd0b1
+  data.tar.gz: acdbeaf0a2631fe40d1c08b2c2245ce18af876fcba2304b4b949368476a785629373f6241c419a8776293672531e790385277ad992f24f7e8879737e759d6ddf

data/README.md

@@ -5,39 +5,33 @@
 [![](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
 
-![][demo]
+![](https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png)
 
-## Notable features
-- Write documents directly, automatically generate toctree based on directory
+## Features
+- Automatically generate sidebar 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.
+- Search engine optimized
 - Multi-language supported
-- And many features waiting for you to discover.
+- Document search (RegExp supported)
+- Support third-party comments
+- Google, Baidu, CNZZ Analytics supported
 
 ## Roadmap
-See the [open issues][issues] for a list of proposed features (and known issues).
+See the [open issues](https://github.com/rundocs/jekyll-rtd-theme/issues) for a list of proposed features (and known issues)
 
 ## Documents
-For full documentation, see: [https://jekyll-rtd-theme.rundocs.io][site]
+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)
 
 ## The License
-The theme is available as open source under the terms of the [MIT 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
-[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.liquid

@@ -8,7 +8,7 @@
         {%- assign items = site.addons | default: addons -%}
         {% for item in items -%}
             {%- if addons contains item -%}
-                {% include addons/source/{{ item }}.liquid %}
+                {% include addons/{{ item }}.liquid %}
             {%- endif -%}
         {% endfor -%}
         <hr>

data/_includes/addons/analytics.liquid

@@ -0,0 +1,8 @@
+<dl>
+    <dt>{{ __statistics }}</dt>
+    <dd>
+        <a href="https://github.com/rundocs/analytics" target="_blank">
+            {{ __total_visits }} <span id="counter"><span class="progress"></span></span> <i class="fa fa-eye"></i>
+        </a>
+    </dd>
+</dl>

data/_includes/album.liquid

@@ -1,7 +1,7 @@
 <div class="album">
     {%- for item in include.data -%}
         <a class="item" href="{{ item.link | default: '#' }}">
-            <img src="{{ item.image }}">{{ item.title }}
+            <img src="{{ item.image }}" alt="{{ item.title }}">{{ item.title }}
         </a>
     {%- endfor -%}
 </div>

data/_includes/assets/common.js

@@ -1,4 +1,5 @@
 $(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() {
@@ -33,8 +34,14 @@ $(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/list.liquid

@@ -6,10 +6,10 @@
 {%- assign size_p1 = size | plus: 1 -%}
 
 {%- assign dir = site_pages | where: "url", workdir | first %}
-{% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ site.baseurl | append: dir.url }})
+{% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
 
 {%- for item in workdir_files %}
-{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}

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="{{ site.baseurl | append: dir.url }}">{{ dir.title | default: dir.url }}</a>
+    <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 %}
@@ -21,16 +25,19 @@
         {%- endif -%}
 
         <li class="toctree-l{{ level }} {{ current }}">
-            <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
+            <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
                 {%- if item.sort and site.show_sorted != false -%}
-                    {{ item.sort }}.
-                {%- endif %}
-                {{ item.title | default: item.url }}
+                    {{ item.sort }}. {{ item.title | default: item.url }}
+                {%- else -%}
+                    {{ item.title | default: item.url }}
+                {%- endif -%}
             </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

@@ -2,12 +2,12 @@
     {%- if next or prev -%}
         <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
             {%- if next -%}
-                <a href="{{ site.baseurl | append: next.url }}" class="btn btn-neutral float-right" title="{{ next.title }}" accesskey="n" rel="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="{{ site.baseurl | append: prev.url }}" class="btn btn-neutral  float-left" title="{{ prev.title }}" accesskey="p" rel="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 -%}
@@ -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/list.liquid

@@ -2,7 +2,7 @@
 {%- include reset/workdir.liquid workdir=page.dir -%}
 
 {%- for item in workdir_files %}
-- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- if include.all -%}

data/_includes/reset/defaults.liquid

@@ -1,10 +1,24 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.0.3" -%}
+{%- assign version = "1.1.2" -%}
 {%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
 
-{%- include reset/site_pages.liquid %}
-{%- include reset/i18n.liquid -%}
-{%- include reset/schema.liquid -%}
+{%- 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 "jekyll-rtd-theme.scss";
+    {% if site.fluid %}@import "fluid.scss";{% endif %}
+    {% include assets/custom.scss %} {{ site.scss }}
+{%- endcapture -%}
+
+{% comment %} cdn {% endcomment %}
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
 
 {% comment %} github-metadata {% endcomment %}
 {%- if site.github_metadata != false -%}
@@ -36,25 +50,8 @@
     {%- assign addons = "i18n, plugins, analytics" | split: ", " -%}
 {%- endif -%}
 
-{% comment %} scss and script {% endcomment %}
-{%- capture site_scss -%}
-    @import "site.scss";
-    {%- if site.fluid %}
-        @import "fluid.scss";
-    {% endif -%}
-    {% include assets/custom.scss %} {{ site.scss }}
-{%- endcapture -%}
-
-{%- capture site_script %}
-    {% include assets/common.js %}
-    {% include assets/custom.js %} {{ site.script }}
-{%- endcapture -%}
-
-{%- if site.debug -%}
-    {%- assign cdn = site.baseurl -%}
-{%- else -%}
-    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
-{%- endif -%}
+{%- include reset/site_pages.liquid %}
+{%- include reset/i18n.liquid -%}
 
 {% comment %} title {% endcomment %}
 {%- case page.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,17 +1,22 @@
 {%- 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 %}
         <li class="toctree-l{{ level }} {{ current }}">
-            <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
+            <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
                 {{ item.title | default: item.url }}
             </a>
         </li>
     {%- endfor %}
 </ul>
 
+{% comment %} list the root dirs {% endcomment %}
 {%- for workdir in workdir_dirs %}{% include extend/toctree.liquid %}{% endfor -%}

data/_layouts/default.liquid

@@ -20,7 +20,7 @@ layout: plugins/compress
     <meta charset="utf-8">
     <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
     <meta content="IE=Edge" http-equiv="X-UA-Compatible">
-    <title>{{ title }}</title>
+    <title>{{ title | truncate: 110 }}</title>
     <script>
         window.dataLayer = window.dataLayer || [];
 
@@ -41,32 +41,60 @@ layout: plugins/compress
     <meta name="author" content="{{ author }}">
     <meta name="revised" content="{{ commit }}">
     <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
-    <!-- custom meta -->
+    <!-- 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_surl }}">
+    <meta property="og:type" content="article">
+    <meta property="article:author" content="{{ author }}">
+    <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 }}">
     {% endfor -%}
-    <!-- og -->
-    {% include addons/seo/og.liquid %}
     <!-- schema -->
-    {% include addons/seo/schema.liquid %}
+    <script type="application/ld+json">
+        {
+            "@context": "https://schema.org",
+            "@type": "Article",
+            "mainEntityOfPage": {
+                "@type": "WebPage",
+                "@id": "{{ schema_surl }}"
+            },
+            "headline": "{{ title | truncate: 110 }}",
+            "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
+            "author": {
+                "@type": "Person",
+                "name": "{{ author }}"
+            },
+            "datePublished": "{{ schema_date }}",
+            "dateModified": "{{ schema_modi }}",
+            "publisher": {
+                "@type": "Organization",
+                "name": "RunDocs",
+                "logo": {
+                    "@type": "ImageObject",
+                    "url": "https://rundocs.io/logo.png"
+                }
+            },
+            "description": "{{ description }}"
+        }
+    </script>
     <!-- link -->
-    {% if prev -%}
-        <link rel="prev" href="{{ prev.url | absolute_url | xml_escape }}">
-    {%- endif -%}
-    {%- if next -%}
-        <link rel="next" href="{{ next.url | absolute_url | xml_escape }}">
-    {%- endif -%}
-    <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>
     <!-- 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]-->
+    <!--[if lt IE 9]><script src="{{ cdn }}/assets/js/html5shiv.min.js"></script><![endif]-->
     <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
     <script>
         const ui = {
@@ -81,20 +109,11 @@ 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">
     <div class="wy-grid-for-nav">
-        <!-- SIDE NAV, TOGGLES ON MOBILE -->
+        <!-- NAV -->
         <nav data-toggle="wy-nav-shift" class="wy-nav-side">
             <div class="wy-side-scroll">
                 <div class="wy-side-nav-search">
@@ -112,21 +131,20 @@ layout: plugins/compress
                         </form>
                     </div>
                 </div>
-                <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-                    {% include toctree.liquid %}
-                </div>
+                <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">{% include toctree.liquid %}</div>
                 {%- if site.embed -%}
-                <div class="wy-embed-wrap">
-                    <div class="wy-embed">{{ site.embed }}</div>
-                </div>
+                    <div class="wy-embed-wrap"><div class="wy-embed">{{ site.embed }}</div></div>
                 {%- endif -%}
             </div>
         </nav>
+
         <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>
+                    <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">{{ site.title }}</a>
+                </div>
             </nav>
             <div class="wy-nav-content">
                 <div class="rst-content">
@@ -139,7 +157,17 @@ layout: plugins/compress
                                 <div class="section">{{ content }}</div>
                             {%- endif -%}
                         </div>
-                        {% include addons/comments/disqus.liquid %}
+                        {% comment %} comments {% endcomment %}
+                        {% if site.disqus %}
+                            <div id="disqus_thread" class="articleComments"></div>
+                            <script>
+                                (function(script) {
+                                    script.src = "https://{{ site.disqus }}.disqus.com/embed.js";
+                                    script.setAttribute("data-timestamp", +new Date());
+                                    document.head.appendChild(script);
+                                })(document.createElement("script"));
+                            </script>
+                        {% endif %}
                     </div>
                     {% include footer.liquid %}
                 </div>
@@ -150,11 +178,50 @@ layout: plugins/compress
     <!-- script -->
     <script src="{{ cdn }}/assets/js/theme.js"></script>
     <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
-    <script>{{ site_script }}</script>
-    <!-- analytics -->
-    {%- include addons/analytics/baidu.liquid -%}
-    {%- include addons/analytics/cnzz.liquid -%}
-    {%- include addons/analytics/google.liquid -%}
+    <script>
+        {% include assets/common.js %}
+        {% include assets/custom.js %} {{ site.script }}
+    </script>
+
+    {% comment %} Baidu link submit {% endcomment %}
+    {%- if site.baidu.linksubmit -%}
+        <script>
+            (function(script) {
+                script.src = "https://zz.bdstatic.com/linksubmit/push.js";
+                document.head.appendChild(script);
+            })(document.createElement("script"));
+        </script>
+    {%- endif -%}
+
+    {% comment %} Baidu Analytics {% endcomment %}
+    {%- if site.baidu.hm -%}
+        <script>
+            var _hmt = _hmt || [];
+            (function(script) {
+                script.src = "https://hm.baidu.com/hm.js?{{ site.baidu.hm }}";
+                document.head.appendChild(script);
+            })(document.createElement("script"));
+        </script>
+    {%- endif -%}
+
+    {% comment %} CNZZ Analytics {% endcomment %}
+    {%- if site.cnzz -%}
+        <span id="cnzz_stat_icon_{{ site.cnzz }}" style="display: none;"></span>
+        <script async src="https://v1.cnzz.com/z_stat.php?id={{ site.cnzz }}"></script>
+    {%- endif -%}
+
+    {% 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 }}");
+        </script>
+    {%- endif -%}
+
+    {% comment %} Google AdSense {% endcomment %}
+    {%- if site.google.adsense -%}
+        <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
+    {%- endif -%}
 </body>
 
 </html>

data/_layouts/plugins/compress.liquid

@@ -8,7 +8,18 @@
         {%- if block.size == 1 -%}
             {{ block_after }}
         {%- else -%}
-            <pre{{ block.first }}</pre>{{ block_after }}
+            {%- assign blocks = block.first | replace_first: ">", "```<temp>```" | split: "```<temp>```" -%}
+            {%- assign admonitions = "note, tip, warning, danger" | split: ", " -%}
+            {%- assign type = blocks.first | replace: '"', '' | replace: " class=language-", ""  -%}
+            {%- comment %} admonitions card {% endcomment -%}
+            {%- if admonitions contains type -%}
+                <div class="admonition {{ type }}">
+                    {%- comment %} title will be translated via ui {% endcomment -%}
+                    <p class="admonition-title" ui="{{ type }}"><span class="progress"></span></p>{{ blocks.last | markdownify | strip_newlines -}}
+                </div>{{ block_after -}}
+            {%- else -%}
+                <pre{{ block.first }}</pre>{{ block_after -}}
+            {%- endif -%}
         {%- endif -%}
     {%- endfor -%}
 {%- endif -%}

data/_sass/_album.scss

@@ -1,10 +1,3 @@
-.flex {
-    display: -webkit-flex;
-    display: flex;
-    flex-wrap: wrap;
-    flex-direction: row;
-}
-
 .album {
     @extend .flex;
 
@@ -19,7 +12,8 @@
         }
 
         img {
+            @extend .shadow-box;
             width: 100%;
         }
     }
-}
+}

data/_sass/{site.scss → jekyll-rtd-theme.scss}

@@ -1,3 +1,14 @@
+/* common */
+.shadow-box {
+    box-shadow: 0 1px 1px 0 rgba(0,0,0,0.14), 0 3px 1px -2px rgba(0,0,0,0.12), 0 1px 5px 0 rgba(0,0,0,0.2);
+}
+
+.flex {
+    display: -webkit-flex;
+    display: flex;
+    flex-wrap: wrap;
+    flex-direction: row;
+}
 @import "_album.scss";
 @import "_embed.scss";
 /* custom */
@@ -11,6 +22,24 @@ footer {
         text-align: center;
     }
 }
+/* admonition add shadow-box */
+.admonition {
+    @extend .shadow-box;
+}
+/* from glitch */
+.progress:after {
+    display: inline-block;
+    content: "\2026";
+    width: 0;
+    overflow: hidden;
+    vertical-align: bottom;
+    animation: ellipsis steps(4, end) 1000ms infinite;
+}
+@keyframes ellipsis {
+    to {
+        width: 1.25em;
+    }
+}
 /* breadcrumbs icon */
 .fa-angle-double-right {
     font-size: 13px;
@@ -25,10 +54,23 @@ footer {
 .wy-nav-side {
     padding-bottom: 3em;
 }
-/* mobile title margin, not the best method, flex should be better  */
+/* mobile button and title */
 .wy-nav-top {
-    a {
-        margin-left: -30px;
+    padding: 0;
+
+    .flex {
+        align-items: center;
+
+        i {
+            /* for better touch experience */
+            padding: 10px;
+            font-size: 20px;
+        }
+
+        a {
+            flex: auto;
+            padding-right: 10px;
+        }
     }
 }
 
@@ -50,7 +92,7 @@ footer {
         font-size: 12px;
     }
     /* theme copyright */
-    .copyright-rtd {
+    .rundocs {
         display: none;
     }
     /* view box of search results */

data/assets/404.liquid

@@ -1,6 +1,6 @@
 ---
-permalink: /404.html
 layout: default
+permalink: /404.html
 ---
 
 {%- include reset/i18n.liquid -%}

data/assets/{favicon.svg → favicon.liquid}

@@ -1,5 +1,10 @@
+---
+layout: plugins/compress
+permalink: /favicon.svg
+---
+
+{% comment %} material-design-icons article {% endcomment %}
 <svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="#2980b9" width="36px" height="36px">
     <path d="M0 0h24v24H0z" fill="none"/>
     <path d="M19 3H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2zm-5 14H7v-2h7v2zm3-4H7v-2h10v2zm0-4H7V7h10v2z"/>
 </svg>
-<!-- material-design-icons article -->

data/assets/robots.liquid

@@ -0,0 +1,9 @@
+---
+layout: null
+permalink: /robots.txt
+---
+
+User-agent: *
+Allow: /
+
+Sitemap: {{ "sitemap.xml" | absolute_url | replace: "http://", "https://" }}

data/assets/search.liquid

@@ -1,13 +1,13 @@
 ---
-permalink: /search.html
 layout: default
+permalink: /search.html
 ---
 
 {%- include reset/site_pages.liquid -%}
 {%- include reset/i18n.liquid -%}
 
 <div id="search-results">
-    <h2>{{ __searching }}<span>...</span></h2>
+    <h2>{{ __searching }}<span class="progress"></span></h2>
     <p class="search-summary"></p>
     <ul class="search"></ul>
 </div>

data/assets/sitemap.liquid

@@ -0,0 +1,17 @@
+---
+layout: plugins/compress
+permalink: /sitemap.xml
+---
+
+{%- include reset/site_pages.liquid -%}
+
+<?xml version="1.0" encoding="UTF-8"?>
+<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>
+            <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>
+    {%- endfor %}
+</urlset>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rtd-theme
 version: !ruby/object:Gem::Version
-  version: 1.0.3
+  version: 1.1.2
 platform: ruby
 authors:
 - saowang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-08 00:00:00.000000000 Z
+date: 2020-08-20 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -34,16 +34,10 @@ files:
 - LICENSE
 - README.md
 - _includes/addons.liquid
-- _includes/addons/analytics/baidu.liquid
-- _includes/addons/analytics/cnzz.liquid
-- _includes/addons/analytics/google.liquid
-- _includes/addons/comments/disqus.liquid
-- _includes/addons/seo/og.liquid
-- _includes/addons/seo/schema.liquid
-- _includes/addons/source/analytics.liquid
-- _includes/addons/source/github.liquid
-- _includes/addons/source/i18n.liquid
-- _includes/addons/source/plugins.liquid
+- _includes/addons/analytics.liquid
+- _includes/addons/github.liquid
+- _includes/addons/i18n.liquid
+- _includes/addons/plugins.liquid
 - _includes/album.liquid
 - _includes/assets/common.js
 - _includes/assets/custom.js
@@ -55,17 +49,18 @@ files:
 - _includes/extend/toctree.liquid
 - _includes/footer.liquid
 - _includes/i18n/en.liquid
+- _includes/i18n/es.liquid
 - _includes/i18n/fr.liquid
 - _includes/i18n/it.liquid
 - _includes/i18n/ja.liquid
 - _includes/i18n/ko.liquid
 - _includes/i18n/ru.liquid
+- _includes/i18n/sv.liquid
 - _includes/i18n/zh-cn.liquid
 - _includes/list.liquid
 - _includes/reset/defaults.liquid
 - _includes/reset/i18n.liquid
 - _includes/reset/languages.liquid
-- _includes/reset/schema.liquid
 - _includes/reset/site_pages.liquid
 - _includes/reset/workdir.liquid
 - _includes/toctree.liquid
@@ -74,7 +69,7 @@ files:
 - _sass/_album.scss
 - _sass/_embed.scss
 - _sass/fluid.scss
-- _sass/site.scss
+- _sass/jekyll-rtd-theme.scss
 - assets/404.liquid
 - assets/css/fonts/Roboto-Slab-Bold.woff
 - assets/css/fonts/Roboto-Slab-Bold.woff2
@@ -117,15 +112,15 @@ files:
 - assets/css/rougify/thankful_eyes.css
 - assets/css/rougify/tulip.css
 - assets/css/theme.css
-- assets/favicon.svg
+- assets/favicon.liquid
 - assets/js/anchor.min.js
 - assets/js/html5shiv.min.js
 - assets/js/jquery.min.js
 - assets/js/theme.js
-- assets/pages.json
-- assets/robots.txt
+- assets/pages.liquid
+- assets/robots.liquid
 - assets/search.liquid
-- assets/sitemap.xml
+- assets/sitemap.liquid
 homepage: https://github.com/rundocs/jekyll-rtd-theme
 licenses:
 - MIT
@@ -148,5 +143,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
+summary: Just another jekyll docs theme compatible with GitHub Pages, based on sphinx_rtd_theme
 test_files: []

data/_includes/addons/analytics/baidu.liquid

@@ -1,18 +0,0 @@
-{%- if site.baidu.linksubmit -%}
-    <script>
-        (function(script) {
-            script.src = "https://zz.bdstatic.com/linksubmit/push.js";
-            document.head.appendChild(script);
-        })(document.createElement("script"));
-    </script>
-{%- endif -%}
-
-{%- if site.baidu.hm -%}
-    <script>
-        var _hmt = _hmt || [];
-        (function(script) {
-            script.src = "https://hm.baidu.com/hm.js?{{ site.baidu.hm }}";
-            document.head.appendChild(script);
-        })(document.createElement("script"));
-    </script>
-{%- endif -%}

data/_includes/addons/analytics/cnzz.liquid

@@ -1,4 +0,0 @@
-{%- if site.cnzz -%}
-    <span id="cnzz_stat_icon_{{ site.cnzz }}" style="display: none;"></span>
-    <script async src="https://v1.cnzz.com/z_stat.php?id={{ site.cnzz }}"></script>
-{%- endif -%}

data/_includes/addons/analytics/google.liquid

@@ -1,12 +0,0 @@
-{%- if site.google.gtag -%}
-    <!-- Google Analytics -->
-    <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
-    <script>
-        gtag("config", "{{ site.google.gtag }}");
-    </script>
-{%- endif -%}
-
-{%- if site.google.adsense -%}
-    <!-- Google AdSense -->
-    <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
-{%- endif -%}

data/_includes/addons/comments/disqus.liquid

@@ -1,10 +0,0 @@
-{% if site.disqus %}
-<div id="disqus_thread" class="articleComments"></div>
-<script>
-    (function(script) {
-        script.src = "https://{{ site.disqus }}.disqus.com/embed.js";
-        script.setAttribute("data-timestamp", +new Date());
-        document.head.appendChild(script);
-    })(document.createElement("script"));
-</script>
-{% endif %}

data/_includes/addons/seo/og.liquid

@@ -1,7 +0,0 @@
-<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:type" content="article">
-<meta property="article:author" content="{{ author }}">
-<meta property="article:modified_time" content="{{ schema_lastmod }}">

data/_includes/addons/seo/schema.liquid

@@ -1,10 +0,0 @@
-<script type="application/ld+json">
-    {
-        "@context": "http://schema.org",
-        "@type": "Article",
-        "name": "{{ title }}",
-        "author": "{{ author }}",
-        "url": "{{ schema_url }}",
-        "dateModified": "{{ schema_lastmod }}"
-    }
-</script>

data/_includes/addons/source/analytics.liquid

@@ -1,14 +0,0 @@
-<dl>
-    <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>
-        </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/reset/schema.liquid

@@ -1,6 +0,0 @@
-{%- assign schema_url = page.url | absolute_url | xml_escape -%}
-{%- assign schema_lastmod = page.date | default: site.time | date_to_xmlschema -%}
-
-{%- assign schema_weight_title = page.title | size | divided_by: 200.0 -%}
-{%- assign schema_weight_content = page.content | size | divided_by: 1024.0 -%}
-{%- assign schema_priority = schema_weight_content | plus: schema_weight_title | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 -%}

data/assets/robots.txt

@@ -1,9 +0,0 @@
----
-layout: null
-permalink: /robots.txt
----
-
-User-agent: *
-Allow: /
-
-Sitemap: {{ "sitemap.xml" | absolute_url }}

data/assets/sitemap.xml

@@ -1,18 +0,0 @@
----
-layout: plugins/compress
-permalink: /sitemap.xml
----
-
-{%- include reset/site_pages.liquid -%}
-
-<?xml version="1.0" encoding="UTF-8"?>
-<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-    {%- for page in site_pages -%}
-        {% include reset/schema.liquid %}
-        <url>
-            <loc>{{ schema_url }}</loc>
-            <priority>{{ schema_priority }}</priority>
-            <lastmod>{{ schema_lastmod }}</lastmod>
-        </url>
-    {%- endfor %}
-</urlset>