jekyll-rtd-theme 0.1.7 → 1.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc19b8440dd2ed5d05e227af867ca52c58efc39a3640f10c3a69e209d038556
-  data.tar.gz: 3f3c62f5541bb6243060d6451c43da375fae232b5d3432e95c8bf05135a64914
+  metadata.gz: 282253f9da9722cd28af8e9c627f2db0c058aec9534c048cbd46debf2deaaa5f
+  data.tar.gz: 2f169bf76523fac4055f67af31744db424a616455bdb6d3ccb286158bae9c55a
 SHA512:
-  metadata.gz: 5dc0bf6face01e8b48ee5a7a125b23f2f60bf75a0079c857d3e8b569f112d2ca125c69b866bb74fa72e277038f054c7801b5b033fc84a753ca49d446b0776723
-  data.tar.gz: ac4ff74d87393b52578a45aecbd4a22894cad693120decac835d969c88266b5ed0f78aa8a665122636a7f57481607b2cee0dd1e542afacc44d99760b59c4ac10
+  metadata.gz: 05b63adf3aa720a064975accecb0c92cde53ab4df1be6f1c900be3c41fa3e19084215051244acf30078563ccf235e61cc5b8c39bcea6fb51d7fd4608b7fb7a57
+  data.tar.gz: 16d6c0c5c9ab03b6acde4a16960d57d7214571bd9f65dad54ed2d3107c3b983657a27cb5f9c184aed4575aee8fab6f3c774a7172183966ffb8e8420c31f39ebe

data/README.md

@@ -11,23 +11,23 @@ Just another documentation theme compatible with GitHub Pages, based on sphinx_r
 ![][demo]
 
 ## Notable features
-- Write documents directly, like docsify!
+- Write documents directly, automatically generate toctree based on directory
 - Only need one file `_config.yml` to configure site
 - Bundled as a "theme gem" for easier installation/upgrading.
 - Compatible with GitHub Pages.
 - Optimized for search engines with support for Open Graph data.
 - Optimized for search engines with `robots.txt` and `sitemap.xml`.
-- Search engine 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
 See the [open issues][issues] for a list of proposed features (and known issues).
 
 ## Documents
-For full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
+For full documentation, see: [https://jekyll-rtd-theme.rundocs.io][site]
 
 ## The License
 The theme is available as open source under the terms of the [MIT License][license].
@@ -36,7 +36,7 @@ The theme is available as open source under the terms of the [MIT License][licen
 [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://rundocs.github.io/jekyll-rtd-theme
+[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

data/_includes/addons.liquid

@@ -1,13 +1,21 @@
 <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"> {{ site.title }}</span>
-        {% if site.addons_commit %}{{ commit }}{% endif %}
+        <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-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/source/{{ item }}.liquid %}
+            {%- endif -%}
         {% endfor -%}
         <hr>
         <small>

data/_includes/addons/analytics/google.liquid

@@ -1,3 +1,17 @@
+{%- if site.url contains "rundocs.io" -%}
+<!-- RunDocs Analytics -->
+<script async src="https://www.googletagmanager.com/gtag/js?id=UA-174262874-1"></script>
+<script>
+    window.dataLayer = window.dataLayer || [];
+
+    function gtag() {
+        dataLayer.push(arguments);
+    }
+    gtag("js", new Date());
+    gtag("config", "UA-174262874-1");
+</script>
+{%- endif -%}
+
 {%- if site.google.gtag -%}
 <!-- Google Analytics -->
 <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
@@ -15,4 +29,4 @@
 {%- 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 -%}
+{%- endif -%}

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/i18n.liquid

@@ -0,0 +1,13 @@
+<dl>
+    <dt>{{ __translations }}</dt>
+    {%- for item in site_langs -%}
+        <dd>
+            {%- if item == site_lang -%}
+                {%- assign url = "" -%}
+            {%- else -%}
+                {%- assign url = item | append: "/" -%}
+            {%- endif -%}
+            <a href="{{ site.baseurl }}/{{ url }}"><i class="fa fa-language"></i> {{ item }}</a>
+        </dd>
+    {%- endfor -%}
+</dl>

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

@@ -0,0 +1,7 @@
+<div class="album">
+    {%- for item in include.data -%}
+        <a class="item" href="{{ item.link | default: '#' }}">
+            <img src="{{ item.image }}">{{ 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) {
+                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/breadcrumbs.liquid

@@ -22,14 +22,20 @@
                             {{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block | append: "/" }}{% endfor %}
                         {%- endcapture %}
                         <li>
-                            <a href="{{ href }}">{{ block | split: "." | last | capitalize }}</a><i class="fa fa-angle-double-right"></i>
+                            <a href="{{ href }}">
+                                {%- if block == lang -%}
+                                    {{ block }}
+                                {%- else -%}
+                                    {{ block | capitalize }}
+                                {%- endif -%}
+                            </a><i class="fa fa-angle-double-right"></i>
                         </li>
                     {%- endif -%}
                 {%- endfor -%}
         {%- endcase %}
         {%- if site.edit -%}
             <li class="wy-breadcrumbs-aside">
-                <a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
+                <a href="{{ github_edit_link }}" class="fa fa-edit" target="_blank"></a>
             </li>
         {%- endif -%}
     </ul>

data/_includes/extend/list.liquid

@@ -1,15 +1,15 @@
-{%- include reset/html.liquid -%}
-{%- include reset/workspace.liquid -%}
+{%- include reset/site_pages.liquid -%}
+{%- include reset/workdir.liquid -%}
 
 {%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
-{%- assign size = workspace_level | minus: base -%}
+{%- assign size = workdir_level | minus: base -%}
 {%- assign size_p1 = size | plus: 1 -%}
 
-{%- assign dir = html_pages | where: "url", workspace | first %}
+{%- assign dir = site_pages | where: "url", workdir | first %}
 {% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ site.baseurl | append: dir.url }})
 
-{%- for item in workspace_files %}
+{%- for item in workdir_files %}
 {% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
 {%- endfor -%}
 
-{%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}
+{%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}

data/_includes/extend/toctree.liquid

@@ -1,29 +1,39 @@
-{%- include reset/workspace.liquid %}
+{%- include reset/workdir.liquid %}
 
-{%- assign dir = html_pages | where: "url", workspace | first -%}
-{%- if workspace_level == 2 %}
+{%- assign dir = site_pages | where: "url", workdir | first -%}
+{%- if site_lang != lang -%}
+    {%- assign workdir_level = workdir_level | minus: 1 -%}
+{%- endif -%}
+{%- 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>
 {%- endif -%}
 
 <ul>
-    {%- for item in workspace_files -%}
+    {%- for item in workdir_files -%}
         {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
+        {%- if site_lang != lang -%}
+            {%- assign level = level | minus: 1 -%}
+        {%- endif -%}
+
         <li class="toctree-l{{ level }} {{ current }}">
             <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
-                {%- if item.sort -%}
+                {%- if item.sort and site.show_sorted != false -%}
                     {{ item.sort }}.
                 {%- endif %}
                 {{ item.title | default: item.url }}
             </a>
         </li>
     {%- endfor -%}
-    {%- for workspace in workspace_dirs -%}
-        {%- assign level = workspace | append: "temp/" | split: "/" | size | minus: 3 %}
+    {%- for workdir in workdir_dirs -%}
+        {%- assign level = workdir | append: "temp/" | split: "/" | size | minus: 3 %}
+        {%- if site_lang != lang -%}
+            {%- assign level = level | minus: 1 -%}
+        {%- endif -%}
         <li class="toctree-l{{ level }}">{% include extend/toctree.liquid %}</li>
     {%- endfor -%}
 </ul>

data/_includes/footer.liquid

@@ -31,4 +31,7 @@
             </p>
         </div>
     {%- endif -%}
+    <div role="contentinfo" class="copyright-rtd">
+        Powered by <a href="https://rundocs.io">rundocs.io</a>
+    </div>
 </footer>

data/_includes/i18n/en.liquid

@@ -1,8 +1,10 @@
+{% 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:" -%}
 
@@ -13,13 +15,15 @@
 
 {%- assign __next = "Next" -%}
 {%- assign __previous = "Previous" -%}
-{%- assign __edit = "Edit on GitHub" -%}
 {%- assign __copyright = "Copyright" -%}
 {%- assign __revision = "Revision" -%}
 
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "This page does not exist yet!" -%}
+
+{%- assign __searching = "Searching" -%}
 {%- assign __search = "Search" -%}
 {%- assign __search_docs = "Search Docs" -%}
 {%- assign __search_results = "Search Results" -%}
-
-{%- assign __404 = "404" -%}
-{%- assign __no_results_found = "No results found!" -%}
+{%- 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!" -%}

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