jekyll-rtd-theme 1.0.1 → 1.1.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: cb6951c99db8b05f676775f3d340a5ee35053b7f9a3eb4d475a8b5c60cf4b835
-  data.tar.gz: 0cb3eabfc0e92c3d35e83538757b9c43d7c450a1343892bfecaac16bdf5f0553
+  metadata.gz: b629411d3d74c24a69ba9ef73ece57bd3c002921eed7f78894dba51b71a24199
+  data.tar.gz: 5b8f754497e66c35af98199a8f077e207fd259bf29c6e74111aa152b3c6323d1
 SHA512:
-  metadata.gz: b0b4d12c7fb8a28302bf151a0767dfa73db9e280947a0deb5147b2a164ec6efa33c01b20108186f44914d7144c71827ac37e68cb2416ed56ac9833b7892db30d
-  data.tar.gz: ade5cf7162131e9d927baf5f4381882f98ad586c7a8c9b0cf9fb8ad07eead5598215567596ba53e01cd7fc4771a20c754d7e443cd7c90ea29803f3461916ebc2
+  metadata.gz: 3fb991c0098234c7d1c551c912d693a583bf84a507817722c38f89ca91b4812aa38919825726a8bf26fd51d81579e1a0e87e7ec3cc3897355edeca2418843e98
+  data.tar.gz: d717925336199e3242e956b6108d9f36e438cff3f291891b27ffde8385598ed72ef7a010d145e6230125c7492adfd367021c186ddb393779b90809bcb2414d5a

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]
@@ -8,36 +8,28 @@
 
 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 support
-- Commenting support
-- Google,Baidu,CNZZ Analytics support.
-- UI localized text in English(default), Chinese(中文)...
-- And many features waiting for you to discover.
+- Search engine optimized
+- Multi-language supported
+- Document search (RegExp supported)
+- Support third-party comments
+- Google, Baidu, CNZZ Analytics support
 
 ## 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://jekyll-rtd-theme.rundocs.io), 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

data/_includes/addons.liquid

@@ -1,19 +1,15 @@
 <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
-        <span class="fa fa-book">
-            {% if site.url contains "rundocs.io" -%}
-                RunDocs
-            {%- else -%}
-                {{ site.title }}
-            {%- endif -%}
-        </span>
-        {% if site.addons_branch %}v: {{ branch }}{% endif %}
+        <span class="fa fa-book"> {{ site.title }}</span>
+        {% if site.addons_branch and site.github_metadata != false %}v: {{ branch }}{% endif %}
         <span class="fa fa-caret-down"></span>
     </span>
     <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/{{ item }}.liquid %}
+            {%- endif -%}
         {% endfor -%}
         <hr>
         <small>

data/_includes/addons/{source/analytics.liquid → 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/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

@@ -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) {
+                feedback(["highlight", 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,76 @@
+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 feedback(["search", e.message]);
+    }
+
+    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/breadcrumbs.liquid

@@ -33,7 +33,7 @@
                     {%- endif -%}
                 {%- endfor -%}
         {%- endcase %}
-        {%- if site.edit -%}
+        {%- if site.edit and site.github_metadata != false -%}
             <li class="wy-breadcrumbs-aside">
                 <a href="{{ github_edit_link }}" class="fa fa-edit" target="_blank"></a>
             </li>

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

@@ -7,7 +7,7 @@
 {%- if workdir_level == 2 %}
     <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>
@@ -21,11 +21,12 @@
         {%- 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 -%}

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 -%}
@@ -23,7 +23,7 @@
                 {%- endif -%}
                 {{ site.time | date: "%Y" }},
                 {{ author }}
-                {% if site.copyright.revision -%}
+                {% if site.copyright.revision and site.github_metadata != false -%}
                     <span class="commit">
                         {{ __revision }} <code>{{ commit }}</code>
                     </span>
@@ -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://jekyll-rtd-theme.rundocs.io">jekyll-rtd-theme</a></p>
     </div>
 </footer>

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:" -%}
@@ -25,4 +26,4 @@
 {%- assign __search_docs = "Search Docs" -%}
 {%- assign __search_results = "Search Results" -%}
 {%- assign __search_results_found = "Search finished, found # page(s) matching the search query." -%}
-{%- assign __search_results_not_found = "Your search did not match any documents, please make sure that all words are spelled correctly!" -%}
+{%- assign __search_results_not_found = "Your search did not match any documents, please make sure that all characters are spelled correctly!" -%}

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 = "검색어와 일치하는 문서가 없습니다. 모든 문자의 철자가 올바른지 확인하십시오!" -%}