jekyll-rtd-theme 1.0.1 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6951c99db8b05f676775f3d340a5ee35053b7f9a3eb4d475a8b5c60cf4b835
-  data.tar.gz: 0cb3eabfc0e92c3d35e83538757b9c43d7c450a1343892bfecaac16bdf5f0553
+  metadata.gz: 282253f9da9722cd28af8e9c627f2db0c058aec9534c048cbd46debf2deaaa5f
+  data.tar.gz: 2f169bf76523fac4055f67af31744db424a616455bdb6d3ccb286158bae9c55a
 SHA512:
-  metadata.gz: b0b4d12c7fb8a28302bf151a0767dfa73db9e280947a0deb5147b2a164ec6efa33c01b20108186f44914d7144c71827ac37e68cb2416ed56ac9833b7892db30d
-  data.tar.gz: ade5cf7162131e9d927baf5f4381882f98ad586c7a8c9b0cf9fb8ad07eead5598215567596ba53e01cd7fc4771a20c754d7e443cd7c90ea29803f3461916ebc2
+  metadata.gz: 05b63adf3aa720a064975accecb0c92cde53ab4df1be6f1c900be3c41fa3e19084215051244acf30078563ccf235e61cc5b8c39bcea6fb51d7fd4608b7fb7a57
+  data.tar.gz: 16d6c0c5c9ab03b6acde4a16960d57d7214571bd9f65dad54ed2d3107c3b983657a27cb5f9c184aed4575aee8fab6f3c774a7172183966ffb8e8420c31f39ebe

data/README.md

@@ -1,4 +1,4 @@
-# Jekyll-rtd-theme
+# jekyll-rtd-theme
 [![](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)][repository]
 [![](https://img.shields.io/gem/v/jekyll-rtd-theme)][rubygem]
 [![](https://img.shields.io/gem/dt/jekyll-rtd-theme)][rubygem]
@@ -17,10 +17,10 @@ Just another documentation theme compatible with GitHub Pages, based on sphinx_r
 - 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 support
+- Search engine (RegExp supported)
 - Commenting support
 - Google,Baidu,CNZZ Analytics support.
-- UI localized text in English(default), Chinese(中文)...
+- Multi-language supported
 - And many features waiting for you to discover.
 
 ## Roadmap

data/_includes/addons.liquid

@@ -13,7 +13,9 @@
     <div class="rst-other-versions">
         {%- assign items = site.addons | default: addons -%}
         {% for item in items -%}
-            {% include addons/source/{{ item }}.liquid %}
+            {%- if addons contains item -%}
+                {% include addons/source/{{ item }}.liquid %}
+            {%- endif -%}
         {% endfor -%}
         <hr>
         <small>

data/_includes/addons/comments/disqus.liquid

@@ -7,4 +7,4 @@
         document.head.appendChild(script);
     })(document.createElement("script"));
 </script>
-{% endif %}
+{% endif %}

data/_includes/addons/seo/og.liquid

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

data/_includes/addons/seo/schema.liquid

@@ -7,4 +7,4 @@
         "url": "{{ schema_url }}",
         "dateModified": "{{ schema_lastmod }}"
     }
-</script>
+</script>

data/_includes/addons/source/analytics.liquid

@@ -9,8 +9,6 @@
 
 <script>
     $(document).ready(function() {
-        $.getJSON("https://rundocs-analytics.glitch.me/analytics?host=" + location.host, function(data) {
-            $("#counter").html(data.count);
-        });
+        $.getJSON("https://rundocs-analytics.glitch.me/analytics?host=" + location.host, (data) => $("#counter").html(data.count));
     });
 </script>

data/_includes/addons/source/{gems.liquid → plugins.liquid}

@@ -1,5 +1,5 @@
 <dl>
-    <dt>{{ __gems }}</dt>
+    <dt>{{ __plugins }}</dt>
     {%- for item in site.plugins %}
         <dd><a href="https://rubygems.org/gems/{{ item }}"><i class="fa fa-cog"></i> {{ item }}</a></dd>
     {%- endfor %}

data/_includes/assets/common.js

@@ -0,0 +1,40 @@
+$(document).ready(function() {
+    let highlight = new URL(location.href).searchParams.get("highlight");
+
+    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");
+        }
+    };
+    SphinxRtdTheme.Navigation.enable(true);
+
+    if (highlight) {
+        $(".section").find("*").each(function() {
+            try {
+                if (this.outerHTML.match(new RegExp(highlight, "im"))) {
+                    $(this).addClass("highlighted-box");
+                }
+            } catch (e) {
+                console.log(e.message);
+            }
+        });
+        $(".section").find(".highlighted-box").each(function() {
+            if (($(this).find(".highlighted-box").length > 0)) {
+                $(this).removeClass("highlighted-box");
+            }
+        });
+    }
+    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();
+});

data/_includes/assets/search.js

@@ -0,0 +1,80 @@
+function feedback(type, message) {
+    console.log(`feedback: https://github.com/rundocs/jekyll-rtd-theme/issues?q=${type}+${message}`);
+}
+
+function search(data) {
+    let text = new URL(location.href).searchParams.get("q");
+    let lang = new URL(location.href).searchParams.get("lang") || ui.lang;
+
+    $("input[name='q']").val(text);
+    $("input[name='q']").attr("placeholder", i18n[lang].search_docs + "...");
+
+    let results = [];
+    let regexp = new RegExp();
+    try {
+        regexp = new RegExp(text, "im");
+    } catch (e) {
+        $(".search").empty();
+        $(".search-summary").html(i18n[lang].search_results_not_found);
+        $("#search-results h2").html(i18n[lang].search_results);
+        return;
+    }
+
+    function slice(content, min, max) {
+        return content.slice(min, max).replace(regexp, (match) => `<span class="highlighted">${match}</span>`);
+    }
+    for (page of data) {
+        let [title, content] = [null, null];
+        try {
+            if (page.title) {
+                title = page.title.match(regexp);
+            } else {
+                if (page.url == "/") {
+                    page.title = ui.title;
+                } else {
+                    page.title = page.url;
+                }
+            }
+        } catch (e) {
+            feedback("search", e.message);
+        }
+        try {
+            if (page.content) {
+                page.content = $("<div/>").html(page.content).text();
+                content = page.content.match(regexp);
+            }
+        } catch (e) {
+            feedback("search", e.message);
+        }
+        if (title || content) {
+            let result = [`<a href="${ui.baseurl}${page.url}?highlight=${text}">${page.title}</a>`];
+            if (content) {
+                let [min, max] = [content.index - 100, content.index + 100];
+                let [prefix, suffix] = ["...", "..."];
+
+                if (min < 0) {
+                    prefix = "";
+                    min = 0;
+                }
+                if (max > page.content.length) {
+                    suffix = "";
+                    max = page.content.length;
+                }
+                result.push(`<p class="context">${prefix}${slice(page.content ,min, max)}${suffix}</p>`);
+            }
+            results.push(`<li>${result.join("")}</li>`);
+        }
+    }
+    if (results.length > 0 && text.length > 0) {
+        $(".search").html(results.join(""));
+        $(".search-summary").html(i18n[lang].search_results_found.replace("#", results.length));
+    } else {
+        $(".search").empty();
+        $(".search-summary").html(i18n[lang].search_results_not_found);
+    }
+    $("#search-results h2").html(i18n[lang].search_results);
+}
+
+$(document).ready(function() {
+    $.ajax(`${ui.baseurl}/pages.json`).done(search).fail((xhr, message) => feedback("search", message));
+});

data/_includes/i18n/{en-US.liquid → en.liquid}

@@ -1,8 +1,9 @@
+{% comment %} English {% endcomment %}
 {%- assign __github = "GitHub" -%}
 {%- assign __homepage = "Homepage" -%}
 {%- assign __issues = "Issues" -%}
 {%- assign __download = "Download" -%}
-{%- assign __gems = "Gems" -%}
+{%- assign __plugins = "Theme Plugins" -%}
 {%- assign __translations = "Translations" -%}
 {%- assign __statistics = "Statistics" -%}
 {%- assign __total_visits = "Total visits:" -%}

data/_includes/i18n/fr.liquid

@@ -0,0 +1,29 @@
+{% comment %} French {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "Page d'accueil" -%}
+{%- assign __issues = "Problèmes" -%}
+{%- assign __download = "Télécharger" -%}
+{%- assign __plugins = "Plugins de thème" -%}
+{%- assign __translations = "Traductions" -%}
+{%- assign __statistics = "Statistiques" -%}
+{%- assign __total_visits = "Total des visites:" -%}
+
+{%- assign __note = "Remarques" -%}
+{%- assign __tip = "Conseils" -%}
+{%- assign __warning = "avertissement" -%}
+{%- assign __danger = "Danger" -%}
+
+{%- assign __next = "Page suivante" -%}
+{%- assign __previous = "Page précédente" -%}
+{%- assign __copyright = "droits d'auteur" -%}
+{%- assign __revision = "Révision" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "Cette page n'existe pas encore!" -%}
+
+{%- assign __searching = "Recherche" -%}
+{%- assign __search = "Chercher" -%}
+{%- assign __search_docs = "Rechercher des documents" -%}
+{%- assign __search_results = "Résultats de recherche" -%}
+{%- assign __search_results_found = "Recherche terminée, page (s) «#» trouvée (s) correspondant à la requête de recherche." -%}
+{%- assign __search_results_not_found = "Votre recherche ne correspond à aucun document, veuillez vous assurer que tous les caractères sont correctement orthographiés!" -%}

data/_includes/i18n/it.liquid

@@ -0,0 +1,29 @@
+{% comment %} Italian {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "Homepage" -%}
+{%- assign __issues = "Problemi" -%}
+{%- assign __download = "Scarica" -%}
+{%- assign __plugins = "Plugin del tema" -%}
+{%- assign __translations = "Traduzioni" -%}
+{%- assign __statistics = "statistica" -%}
+{%- assign __total_visits = "Visite totali:" -%}
+
+{%- assign __note = "Osservazioni" -%}
+{%- assign __tip = "Suggerimenti" -%}
+{%- assign __warning = "avvertimento" -%}
+{%- assign __danger = "Pericolo" -%}
+
+{%- assign __next = "Pagina successiva" -%}
+{%- assign __previous = "Pagina precedente" -%}
+{%- assign __copyright = "Diritto d'autore" -%}
+{%- assign __revision = "Revisione" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "Questa pagina non esiste ancora!" -%}
+
+{%- assign __searching = "ricerca" -%}
+{%- assign __search = "Ricerca" -%}
+{%- assign __search_docs = "Cerca documenti" -%}
+{%- assign __search_results = "risultati di ricerca" -%}
+{%- assign __search_results_found = "Ricerca terminata, sono state trovate pagine # corrispondenti alla query di ricerca." -%}
+{%- assign __search_results_not_found = "La tua ricerca non ha prodotto risultati in nessun documento, assicurati che tutti i caratteri siano scritti correttamente!" -%}

data/_includes/i18n/ja.liquid

@@ -0,0 +1,29 @@
+{% comment %} Japanese {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "ホームページ" -%}
+{%- assign __issues = "問題" -%}
+{%- assign __download = "ダウンロード" -%}
+{%- assign __plugins = "テーマプラグイン" -%}
+{%- assign __translations = "翻訳" -%}
+{%- assign __statistics = "統計学" -%}
+{%- assign __total_visits = "総訪問数：" -%}
+
+{%- assign __note = "備考" -%}
+{%- assign __tip = "チップ" -%}
+{%- assign __warning = "警告" -%}
+{%- assign __danger = "危険" -%}
+
+{%- assign __next = "次のページ" -%}
+{%- assign __previous = "前のページ" -%}
+{%- assign __copyright = "著作権" -%}
+{%- assign __revision = "リビジョン" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "このページはまだ存在しません！" -%}
+
+{%- assign __searching = "探す" -%}
+{%- assign __search = "探す" -%}
+{%- assign __search_docs = "ドキュメントを検索" -%}
+{%- assign __search_results = "の検索結果" -%}
+{%- assign __search_results_found = "検索が終了し、検索クエリに一致する「＃」ページが見つかりました。" -%}
+{%- assign __search_results_not_found = "検索はどのドキュメントにも一致しませんでした。すべての文字のスペルが正しいことを確認してください！" -%}

data/_includes/i18n/ko.liquid

@@ -0,0 +1,29 @@
+{% comment %} Korean {% endcomment %}
+{%- assign __github = "Github" -%}
+{%- assign __homepage = "홈페이지" -%}
+{%- assign __issues = "이슈" -%}
+{%- assign __download = "다운로드" -%}
+{%- assign __plugins = "테마 플러그인" -%}
+{%- assign __translations = "번역" -%}
+{%- assign __statistics = "통계" -%}
+{%- assign __total_visits = "총 방문수 :" -%}
+
+{%- assign __note = "비고" -%}
+{%- assign __tip = "팁" -%}
+{%- assign __warning = "경고" -%}
+{%- assign __danger = "위험" -%}
+
+{%- assign __next = "다음 페이지" -%}
+{%- assign __previous = "이전 페이지" -%}
+{%- assign __copyright = "저작권" -%}
+{%- assign __revision = "개정" -%}
+
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "이 페이지는 아직 존재하지 않습니다!" -%}
+
+{%- assign __searching = "수색" -%}
+{%- assign __search = "검색" -%}
+{%- assign __search_docs = "문서 검색" -%}
+{%- assign __search_results = "검색 결과" -%}
+{%- assign __search_results_found = "검색이 완료되었습니다. 검색어와 일치하는 # 페이지를 찾았습니다." -%}
+{%- assign __search_results_not_found = "검색어와 일치하는 문서가 없습니다. 모든 문자의 철자가 올바른지 확인하십시오!" -%}

data/_includes/i18n/{zh-CN.liquid → zh-cn.liquid}

@@ -1,8 +1,9 @@
+{% comment %} Chinese Simplified {% endcomment %}
 {%- assign __github = "开源文档" -%}
 {%- assign __homepage = "仓库" -%}
 {%- assign __issues = "反馈" -%}
 {%- assign __download = "下载" -%}
-{%- assign __gems = "主题插件" -%}
+{%- assign __plugins = "主题插件" -%}
 {%- assign __translations = "文档翻译" -%}
 {%- assign __statistics = "访问统计" -%}
 {%- assign __total_visits = "累计浏览次数:" -%}

data/_includes/reset/defaults.liquid

@@ -1,6 +1,6 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.0.1" -%}
-{%- assign addons = "github, i18n, gems, analytics" | split: ", " -%}
+{%- assign version = "1.0.2" -%}
+{%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
 
 {%- include reset/site_pages.liquid %}
 {%- include reset/i18n.liquid -%}
@@ -35,7 +35,7 @@
 {%- endcapture -%}
 
 {%- capture site_script %}
-    {% include assets/site.js %}
+    {% include assets/common.js %}
     {% include assets/custom.js %} {{ site.script }}
 {%- endcapture -%}
 

data/_includes/reset/i18n.liquid

@@ -1,21 +1,29 @@
-{%- assign site_lang = site.lang | default: "en-US" -%}
+{%- include reset/languages.liquid -%}
 
+{% comment %} Set default lang {% endcomment %}
+{%- assign site_lang = "en" -%}
+{%- if languages contains site.lang -%}
+    {%- assign site_lang = site.lang -%}
+{%- endif -%}
+
+{% comment %} Get docs all avaiable langs {% endcomment %}
 {%- capture langs -%}
     {{ site_lang }}|
     {%- for item in site_dirs -%}
         {%- assign chapter = item.dir | remove_first: "/" | split: "/" | first -%}
-        {%- if chapter contains "-" -%}
+        {%- if languages contains chapter -%}
             {{ chapter }}|
         {%- endif -%}
     {%- endfor -%}
 {%- endcapture -%}
 {%- assign site_langs = langs | split: "|" | uniq -%}
 
+{% comment %} include language by the root subdirectory {% endcomment %}
 {%- assign lang = site_lang -%}
 
 {%- if page.dir != "/" -%}
     {%- assign chapter = page.dir | remove_first: "/" | split: "/" | first -%}
-    {%- if chapter contains "-" -%}
+    {%- if languages contains chapter -%}
         {%- assign lang = chapter -%}
     {%- endif -%}
 {%- endif -%}

data/_includes/reset/languages.liquid

@@ -0,0 +1,110 @@
+{% comment %} https://cloud.google.com/translate/docs/languages ISO-639-1 {% endcomment %}
+{% comment %} https://github.com/matheuss/google-translate-api/blob/master/languages.js {% endcomment %}
+{%- capture iso_codes -%}
+af
+sq
+am
+ar
+hy
+az
+eu
+be
+bn
+bs
+bg
+ca
+ceb
+ny
+zh-cn
+zh-tw
+co
+hr
+cs
+da
+nl
+en
+eo
+et
+tl
+fi
+fr
+fy
+gl
+ka
+de
+el
+gu
+ht
+ha
+haw
+iw
+hi
+hmn
+hu
+is
+ig
+id
+ga
+it
+ja
+jw
+kn
+kk
+km
+ko
+ku
+ky
+lo
+la
+lv
+lt
+lb
+mk
+mg
+ms
+ml
+mt
+mi
+mr
+mn
+my
+ne
+no
+ps
+fa
+pl
+pt
+ma
+ro
+ru
+sm
+gd
+sr
+st
+sn
+sd
+si
+sk
+sl
+so
+es
+su
+sw
+sv
+tg
+ta
+te
+th
+tr
+uk
+ur
+uz
+vi
+cy
+xh
+yi
+yo
+zu
+{%- endcapture -%}
+
+{%- assign languages = iso_codes | split: " " -%}

data/_includes/reset/workdir.liquid

@@ -1,9 +1,9 @@
-{% comment %} Start from the language chapter(eg: en-US) or root(/) {% endcomment %}
+{% comment %} Start from the language chapter(eg: en-us) or root(/) {% endcomment %}
 {%- assign workdir = include.workdir | default: "/" -%}
 
 {%- if page.dir != "/" -%}
     {%- assign chapter = page.dir | remove_first: "/" | split: "/" | first -%}
-    {%- if chapter contains "-" -%}
+    {%- if languages contains chapter -%}
         {%- capture workdir %}/{{ chapter }}/{% endcapture -%}
     {%- endif -%}
 {%- endif -%}
@@ -21,7 +21,8 @@
             {%- if workdir == dir -%}
                 {% comment %} Root directory does not display other languages {% endcomment %}
                 {%- if workdir == "/" -%}
-                    {%- unless item.dir contains "-" %}{{ item.dir }}|{% endunless -%}
+                    {%- assign language = item.dir | replace: "/", "" -%}
+                    {%- unless languages contains language %}{{ item.dir }}|{% endunless -%}
                 {%- else -%}
                     {{ item.dir }}|
                 {%- endif -%}

data/_layouts/default.liquid

@@ -1,5 +1,132 @@
 ---
-layout: basic
+layout: plugins/compress
 ---
 
-<div class="section">{{ content }}</div>
+{%- include reset/defaults.liquid -%}
+
+<!DOCTYPE html>
+
+<!--
+    {% if site.remote_theme -%}
+        rundocs.io, remote_theme: {{ site.remote_theme }}, based on v{{ version }}
+    {%- else -%}
+        rundocs.io, theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
+    {%- endif %}
+-->
+
+<html class="writer-html5" lang="{{ lang }}">
+
+<head>
+    <meta charset="utf-8">
+    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
+    <title>{{ title }}</title>
+    <!-- meta -->
+    <meta name="description" content="{{ description }}">
+    <meta name="author" content="{{ author }}">
+    <meta name="revised" content="{{ commit }}">
+    <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
+    <!-- custom meta -->
+    {% 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 %}
+    <!-- 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 }}">
+    <!-- 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">
+    <!-- script -->
+    <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+    <script>
+        const ui = {
+            baseurl: "{{ site.baseurl }}",
+            title: "{{ site.title }}",
+            lang: "{{ lang }}",
+            admonition: {
+                note: "{{ __note }}",
+                tip: "{{ __tip }}",
+                warning: "{{ __warning }}",
+                danger: "{{ __danger }}"
+            }
+        };
+    </script>
+</head>
+
+<body class="wy-body-for-nav">
+    <div class="wy-grid-for-nav">
+        <!-- SIDE NAV, TOGGLES ON MOBILE -->
+        <nav data-toggle="wy-nav-shift" class="wy-nav-side">
+            <div class="wy-side-scroll">
+                <div class="wy-side-nav-search">
+                    {% if site.logo %}
+                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">
+                            <img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
+                        </a>
+                    {% else %}
+                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}" class="icon icon-home"> {{ site.title }}</a>
+                    {% endif %}
+                    <div role="search">
+                        <form id="rtd-search-form" class="wy-form" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
+                            <input type="text" name="q" placeholder="{{ __search_docs }}...">
+                            <input type="hidden" name="lang" value="{{ lang }}">
+                        </form>
+                    </div>
+                </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>
+                {%- 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>
+            </nav>
+            <div class="wy-nav-content">
+                <div class="rst-content">
+                    {% include breadcrumbs.liquid %}
+                    <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>
+                        {% include addons/comments/disqus.liquid %}
+                    </div>
+                    {% include footer.liquid %}
+                </div>
+            </div>
+        </section>
+    </div>
+    {%- if site.addons %}{% include addons.liquid %}{% endif %}
+    <!-- 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 -%}
+</body>
+
+</html>

data/_sass/_album.scss

@@ -22,4 +22,4 @@
             width: 100%;
         }
     }
-}
+}

data/_sass/_embed.scss

@@ -20,4 +20,4 @@
             max-width: 100%;
         }
     }
-}
+}

data/_sass/fluid.scss

@@ -4,4 +4,4 @@
     .wy-nav-content {
         max-width: none;
     }
-}
+}

data/_sass/site.scss

@@ -1,6 +1,6 @@
 @import "_album.scss";
 @import "_embed.scss";
-
+/* custom */
 p {
     font-size: 15px;
 }
@@ -11,21 +11,21 @@ footer {
         text-align: center;
     }
 }
-
+/* breadcrumbs icon */
 .fa-angle-double-right {
     font-size: 13px;
 }
-
+/* fixed the addon overflow */
 .rst-versions {
     &.shift-up {
         overflow-y: auto;
     }
 }
-
+/* fixed the toctree padding */
 .wy-nav-side {
     padding-bottom: 3em;
 }
-
+/* mobile title margin, not the best method, flex should be better  */
 .wy-nav-top {
     a {
         margin-left: -30px;
@@ -33,31 +33,32 @@ footer {
 }
 
 .rst-content {
+    /* fixed the long list */
     ol,
     ul {
         overflow-x: auto;
     }
-
+    /* fixed link>code */
     a code.literal {
         color: #2980b9;
     }
-
+    /* custom */
     code,
     div[class^=highlight] pre,
     pre {
         font-family: monospace;
         font-size: 12px;
     }
-
+    /* theme copyright */
     .copyright-rtd {
         display: none;
     }
-
+    /* view box of search results */
     .highlighted-box {
         border: 1px solid #f1c40f;
     }
 }
-
+/* fixed the last of search results display */
 #search-results {
     li:last-child {
         border-bottom: 0;
@@ -66,12 +67,14 @@ footer {
 }
 @media screen and (max-width: 768px) {
     .wy-nav-content-wrap {
+        /* custom */
         .wy-nav-content {
             padding: 1em;
         }
     }
 }
 @media screen and (max-width: 480px) {
+    /* show edit on mobile */
     .wy-breadcrumbs li.wy-breadcrumbs-aside {
         display: initial;
     }

data/assets/favicon.svg

@@ -2,4 +2,4 @@
     <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 -->
+<!-- material-design-icons article -->

data/assets/search.liquid

@@ -1,8 +1,9 @@
 ---
 permalink: /search.html
-layout: basic
+layout: default
 ---
 
+{%- include reset/site_pages.liquid -%}
 {%- include reset/i18n.liquid -%}
 
 <div id="search-results">
@@ -10,3 +11,18 @@ layout: basic
     <p class="search-summary"></p>
     <ul class="search"></ul>
 </div>
+
+<script>
+    const i18n = {
+        {%- for lang in site_langs -%}
+            {%- include i18n/{{ lang }}.liquid %}
+            "{{ lang }}": {
+                search_docs: "{{ __search_docs }}",
+                search_results: "{{ __search_results }}",
+                search_results_found: "{{ __search_results_found }}",
+                search_results_not_found: "{{ __search_results_not_found }}"
+            }{% unless forloop.last %},{% endunless %}
+        {%- endfor -%}
+    };
+</script>
+<script>{% include assets/search.js %}</script>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rtd-theme
 version: !ruby/object:Gem::Version
-  version: 1.0.1
+  version: 1.0.2
 platform: ruby
 authors:
 - saowang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-05 00:00:00.000000000 Z
+date: 2020-08-07 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -41,29 +41,33 @@ files:
 - _includes/addons/seo/og.liquid
 - _includes/addons/seo/schema.liquid
 - _includes/addons/source/analytics.liquid
-- _includes/addons/source/gems.liquid
 - _includes/addons/source/github.liquid
 - _includes/addons/source/i18n.liquid
+- _includes/addons/source/plugins.liquid
 - _includes/album.liquid
+- _includes/assets/common.js
 - _includes/assets/custom.js
 - _includes/assets/custom.scss
-- _includes/assets/site.js
+- _includes/assets/search.js
 - _includes/breadcrumbs.liquid
 - _includes/extend/list.liquid
 - _includes/extend/tabs.liquid
 - _includes/extend/toctree.liquid
 - _includes/footer.liquid
-- _includes/i18n/en-US.liquid
-- _includes/i18n/zh-CN.liquid
+- _includes/i18n/en.liquid
+- _includes/i18n/fr.liquid
+- _includes/i18n/it.liquid
+- _includes/i18n/ja.liquid
+- _includes/i18n/ko.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/searchbox.liquid
 - _includes/toctree.liquid
-- _layouts/basic.liquid
 - _layouts/default.liquid
 - _layouts/plugins/compress.liquid
 - _sass/_album.scss

data/_includes/assets/site.js

@@ -1,125 +0,0 @@
-function feedback(type, message) {
-    console.log(`feedback: https://github.com/rundocs/jekyll-rtd-theme/issues?q=${type}+${message}`);
-}
-
-function highlight() {
-    let text = new URL(location.href).searchParams.get("highlight");
-    let regexp = new RegExp(text, "im");
-
-    if (text) {
-        $(".section").find("*").each(function() {
-            if (this.outerHTML.match(regexp)) {
-                $(this).addClass("highlighted-box");
-            }
-        });
-        $(".section").find(".highlighted-box").each(function() {
-            if (($(this).find(".highlighted-box").length > 0)) {
-                $(this).removeClass("highlighted-box");
-            }
-        });
-    }
-}
-
-function search(data) {
-    let text = new URL(location.href).searchParams.get("q");
-    let results = [];
-    let regexp = new RegExp(text, "im");
-
-    function slice(content, min, max) {
-        return content.slice(min, max).replace(regexp, (match) => `<span class="highlighted">${match}</span>`);
-    }
-    for (page of data) {
-        let [title, content] = [null, null];
-        try {
-            if (page.title) {
-                title = page.title.match(regexp);
-            } else {
-                if (page.url == "/") {
-                    page.title = "{{ site.title }}";
-                } else {
-                    page.title = page.url;
-                }
-            }
-        } catch (e) {
-            feedback("search", e.message);
-        }
-        try {
-            if (page.content) {
-                page.content = $("<div/>").html(page.content).text();
-                content = page.content.match(regexp);
-            }
-        } catch (e) {
-            feedback("search", e.message);
-        }
-        if (title || content) {
-            let result = [`<a href="{{ site.baseurl }}${page.url}?highlight=${text}">${page.title}</a>`];
-            if (content) {
-                let [min, max] = [content.index - 100, content.index + 100];
-                let [prefix, suffix] = ["...", "..."];
-
-                if (min < 0) {
-                    prefix = "";
-                    min = 0;
-                }
-                if (max > page.content.length) {
-                    suffix = "";
-                    max = page.content.length;
-                }
-                result.push(`<p class="context">${prefix}${slice(page.content ,min, max)}${suffix}</p>`);
-            }
-            results.push(`<li>${result.join("")}</li>`);
-        }
-    }
-    if (results.length > 0 && text.length > 0) {
-        $("#search-results ul.search").html(results.join(""));
-        $("#search-results p.search-summary").html("{{ __search_results_found }}".replace("#", results.length));
-    } else {
-        $("#search-results ul.search").empty();
-        $("#search-results p.search-summary").html("{{ __search_results_not_found }}");
-    }
-    $("#rtd-search-form [name='q']").val(text);
-    $("#search-results h2").html("{{ __search_results }}");
-}
-
-function reset() {
-    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");
-    }
-}
-
-function admonition() {
-    const items = {
-        note: "{{ __note }}",
-        tip: "{{ __tip }}",
-        warning: "{{ __warning }}",
-        danger: "{{ __danger }}"
-    };
-    for (let item in items) {
-        let content = $(`.language-${item}`).html();
-        $(`.language-${item}`).replaceWith(`<div class="admonition ${item}"><p class="admonition-title">${items[item]}</p><p>${content}</p></div>`);
-    }
-}
-
-$(document).ready(function() {
-    if (location.pathname == "{{ site.baseurl }}/search.html") {
-        $.ajax({
-                dataType: "json",
-                url: "{{ site.baseurl }}/pages.json"
-            })
-            .done(search)
-            .fail((xhr, message) => feedback("search", message));
-    }
-    admonition();
-    anchors.add();
-    highlight();
-    SphinxRtdTheme.Navigation.reset = reset;
-    SphinxRtdTheme.Navigation.enable(true);
-});

data/_includes/searchbox.liquid

@@ -1,5 +0,0 @@
-<div role="search">
-    <form id="rtd-search-form" class="wy-form" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
-        <input type="text" name="q" placeholder="{{ __search_docs }}...">
-    </form>
-</div>

data/_layouts/basic.liquid

@@ -1,108 +0,0 @@
----
-layout: plugins/compress
----
-
-{%- include reset/defaults.liquid -%}
-
-<!DOCTYPE html>
-
-<!--
-    {% if site.remote_theme -%}
-        rundocs.io, remote_theme: {{ site.remote_theme }}, based on v{{ version }}
-    {%- else -%}
-        rundocs.io, theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
-    {%- endif %}
--->
-
-<html class="writer-html5" lang="{{ lang }}">
-
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
-    <title>{{ title }}</title>
-    <!-- meta -->
-    <meta name="description" content="{{ description }}">
-    <meta name="author" content="{{ author }}">
-    <meta name="revised" content="{{ commit }}">
-    <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
-    <!-- custom meta -->
-    {% 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 %}
-    <!-- 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 }}">
-    <!-- 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">
-    <!-- script -->
-    <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
-</head>
-
-<body class="wy-body-for-nav">
-    <div class="wy-grid-for-nav">
-        <!-- SIDE NAV, TOGGLES ON MOBILE -->
-        <nav data-toggle="wy-nav-shift" class="wy-nav-side">
-            <div class="wy-side-scroll">
-                <div class="wy-side-nav-search">
-                    {% if site.logo %}
-                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">
-                            <img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
-                        </a>
-                    {% else %}
-                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}" class="icon icon-home"> {{ site.title }}</a>
-                    {% endif %}
-                    {% include searchbox.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>
-                {%- 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>
-            </nav>
-            <div class="wy-nav-content">
-                <div class="rst-content">
-                    {% include breadcrumbs.liquid %}
-                    <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-                        <div itemprop="articleBody">{{ content }}</div>
-                        {% include addons/comments/disqus.liquid %}
-                    </div>
-                    {% include footer.liquid %}
-                </div>
-            </div>
-        </section>
-    </div>
-    {%- if site.addons %}{% include addons.liquid %}{% endif %}
-    <!-- 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 -%}
-</body>
-
-</html>