jekyll-rtd-theme 1.1.0 → 1.1.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b629411d3d74c24a69ba9ef73ece57bd3c002921eed7f78894dba51b71a24199
-  data.tar.gz: 5b8f754497e66c35af98199a8f077e207fd259bf29c6e74111aa152b3c6323d1
+  metadata.gz: 195022eba0c5f3fcb99d247278f0fa8da67c554ba16829f1475d6b6bcc5ca482
+  data.tar.gz: 8c2081bea527becb525f1e0ec86959942e179ff49ea4ef63bbcf151e59460c88
 SHA512:
-  metadata.gz: 3fb991c0098234c7d1c551c912d693a583bf84a507817722c38f89ca91b4812aa38919825726a8bf26fd51d81579e1a0e87e7ec3cc3897355edeca2418843e98
-  data.tar.gz: d717925336199e3242e956b6108d9f36e438cff3f291891b27ffde8385598ed72ef7a010d145e6230125c7492adfd367021c186ddb393779b90809bcb2414d5a
+  metadata.gz: 539cf3a199ff035b039598609d880cd07dd6834f1c653e56f4bf4061a2989232d7b43719f35fe843ab2a0b11e6da6d7da53646b2fe81610d68ba17ce7160f3dd
+  data.tar.gz: d51f6474b9f776573eb16e2a599862b6fbb890a97c2c7ac8c5e62737861f3139162828246e052f899a801b063550eca190ec6e6cabeae48b526dafb0d690b248

data/README.md

@@ -17,13 +17,13 @@ Just another documentation theme compatible with GitHub Pages, based on sphinx_r
 - Multi-language supported
 - Document search (RegExp supported)
 - Support third-party comments
-- Google, Baidu, CNZZ Analytics support
+- 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)
 
 ## 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)
+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](https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE).

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,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>`);
+        $(`.language-${item}`).each(function() {
+            $(this).replaceWith(`<div class="admonition ${item}"><p class="admonition-title">${ui.admonition[item]}</p><p>${$(this).html()}</p></div>`);
+        });
     }
     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

@@ -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,9 +1,10 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.0" -%}
+{%- assign version = "1.1.1" -%}
 {%- 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 -%}

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

@@ -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",
@@ -82,7 +84,7 @@ layout: plugins/compress
         }
     </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 -->
@@ -90,7 +92,7 @@ layout: plugins/compress
     <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]-->
     <script src="{{ cdn }}/assets/js/jquery.min.js"></script>

data/_sass/site.scss

@@ -11,6 +11,20 @@ footer {
         text-align: center;
     }
 }
+/* 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;

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/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>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rtd-theme
 version: !ruby/object:Gem::Version
-  version: 1.1.0
+  version: 1.1.1
 platform: ruby
 authors:
 - saowang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-10 00:00:00.000000000 Z
+date: 2020-08-19 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -49,11 +49,13 @@ 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
@@ -110,13 +112,13 @@ 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.liquid
 homepage: https://github.com/rundocs/jekyll-rtd-theme