jekyll-rtd-theme 0.1.5 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 38dce7565904ba703d3b6870eec6338eaefd2e4b5526bde0390503c91b4de99b
-  data.tar.gz: d5e3c38ee7c3ce55a1ed7fc8c90aa842ea1568ce8f2effba21a90443ce51621f
+  metadata.gz: b61e6939570e8e17427fc25c946f3c71898ae8b8577738fcb0fe18d3a9705947
+  data.tar.gz: 8a6881d5c9972017f2d4c46f762abde775e7faa91069fd3d1af575b79fa25ca6
 SHA512:
-  metadata.gz: fc3a218caea7780ce30300ccd4a35dc463daaeb3a1a85ad307b95d1b753f48c32cca9b731cbe05efda2f2600ad83684019eb3a41a1957944e26750eaf2c3142b
-  data.tar.gz: 07a279a1eab91ee5be3c0aa007b9f175f916cf431436f0aae9ba422519d7e32aca4e366e44d0d7750a9900e721fb204a83e883b1a2e0d5201aecab5850251b46
+  metadata.gz: 9df9150705c695c6df77afde19e06309a3299a72cac77ea42c0c983cb5d22fba636f9359e9420df944c11d2ef5a313e9a7880759058767cc163543271f373568
+  data.tar.gz: f6f74fc89f2d28e53a1e1d4abd250bf3f76717cebdcc2e576a53e3b5897719b9e0c3f0c3da74715592f0bbced77a341e714a67d4f2322718792451ba48c8b3c8

data/README.md

@@ -1,28 +1,41 @@
 # jekyll-rtd-theme
-[![](https://github.com/rundocs/jekyll-rtd-theme/workflows/gh-pages/badge.svg)][repository]
+[![](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]
 [![](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]
 [![](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)][codefactor]
+[![](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com)
 
-Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_theme styles
+Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
 
 ![][demo]
 
+## Notable features
+- Write documents directly, like docsify!
+- 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.
+
 ## Roadmap
 See the [open issues][issues] for a list of proposed features (and known issues).
 
-
 ## Documents
-For complete documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
+For full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
 
 ## The License
 The theme is available as open source under the terms of the [MIT License][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
+[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
 [rubygem]: https://rubygems.org/gems/jekyll-rtd-theme
 [cdn]: https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme/

data/_includes/{versions.liquid → addons.liquid}

@@ -1,11 +1,11 @@
 <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>
-        {{ commit }}
+        {% if site.addons_branch %}v: {{ branch }}{% endif %}
         <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">
-        {%- assign items = addons | split: ", " -%}
+        {%- assign items = site.addons | default: addons -%}
         {% for item in items -%}
             {% include addons/source/{{ item }}.liquid %}
         {% endfor -%}

data/_includes/addons/comments/disqus.liquid

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

data/_includes/addons/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/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/site.js

@@ -0,0 +1,125 @@
+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/breadcrumbs.liquid

@@ -22,14 +22,22 @@
                             {{ 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 %}
-        <li class="wy-breadcrumbs-aside">
-            <a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
-        </li>
+        {%- if site.edit -%}
+            <li class="wy-breadcrumbs-aside">
+                <a href="{{ github_edit_link }}" class="fa fa-edit" target="_blank"></a>
+            </li>
+        {%- endif -%}
     </ul>
     <hr>
 </div>

data/_includes/extend/list.liquid

@@ -0,0 +1,15 @@
+{%- include reset/site_pages.liquid -%}
+{%- include reset/workdir.liquid -%}
+
+{%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
+{%- assign size = workdir_level | minus: base -%}
+{%- 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 }})
+
+{%- for item in workdir_files %}
+{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+{%- endfor -%}
+
+{%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}

data/_includes/extend/tabs.liquid

@@ -0,0 +1,2 @@
+{%- assign tab = "    " -%}
+{%- for temp in (1..include.size) %}{{ tab }}{% endfor -%}

data/_includes/{toctree_ln.liquid → 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 %}
-        <li class="toctree-l{{ level }}">{% include toctree_ln.liquid %}</li>
+    {%- 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

@@ -14,14 +14,24 @@
         </div>
     {%- endif -%}
     <hr>
-    <div role="contentinfo" class="copyright">
-        <p>
-            <i class="fa fa-copyright"></i> {{ __copyright }}
-            {{ site.time | date: "%Y" }},
-            {{ author }}
-            <span class="commit">
-                {{ __revision }} <code>{{ commit }}</code>
-            </span>
-        </p>
+    {%- if site.copyright -%}
+        <div role="contentinfo" class="copyright">
+            <p>
+                <i class="fa fa-copyright"></i> {{ __copyright }}
+                {% if site.copyright.since -%}
+                    {{ site.copyright.since | append: "-" }}
+                {%- endif -%}
+                {{ site.time | date: "%Y" }},
+                {{ author }}
+                {% if site.copyright.revision -%}
+                    <span class="commit">
+                        {{ __revision }} <code>{{ commit }}</code>
+                    </span>
+                {%- endif -%}
+            </p>
+        </div>
+    {%- endif -%}
+    <div role="contentinfo" class="copyright-rtd">
+        <a href="https://github.com/rundocs/jekyll-rtd-theme">jekyll-rtd-theme</a>
     </div>
 </footer>

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

@@ -3,6 +3,7 @@
 {%- assign __issues = "Issues" -%}
 {%- assign __download = "Download" -%}
 {%- assign __gems = "Gems" -%}
+{%- assign __translations = "Translations" -%}
 {%- assign __statistics = "Statistics" -%}
 {%- assign __total_visits = "Total visits:" -%}
 
@@ -13,13 +14,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/{zh.liquid → zh-CN.liquid}

@@ -2,7 +2,8 @@
 {%- assign __homepage = "仓库" -%}
 {%- assign __issues = "反馈" -%}
 {%- assign __download = "下载" -%}
-{%- assign __gems = "文档插件" -%}
+{%- assign __gems = "主题插件" -%}
+{%- assign __translations = "文档翻译" -%}
 {%- assign __statistics = "访问统计" -%}
 {%- assign __total_visits = "累计浏览次数:" -%}
 
@@ -13,13 +14,15 @@
 
 {%- assign __next = "下一篇" -%}
 {%- assign __previous = "上一篇" -%}
-{%- assign __edit = "" -%}
 {%- assign __copyright = "版权所有" -%}
 {%- assign __revision = "修订版本" -%}
 
+{%- assign __404 = "404" -%}
+{%- assign __not_found = "此页面尚不存在!" -%}
+
+{%- assign __searching = "正在搜索" -%}
 {%- assign __search = "搜索" -%}
 {%- assign __search_docs = "搜索文档" -%}
 {%- assign __search_results = "搜索结果" -%}
-
-{%- assign __404 = "404" -%}
-{%- assign __no_results_found = "查询结果为空!" -%}
+{%- assign __search_results_found = "搜索完成, 找到与搜索查询匹配的#个页面" -%}
+{%- assign __search_results_not_found = "您的搜索没有匹配到任何文档, 请确保所有字符拼写正确!" -%}

data/_includes/list.liquid

@@ -1,6 +1,10 @@
-{%- include reset/html.liquid -%}
-{%- include reset/workspace.liquid workspace=page.dir -%}
+{%- include reset/site_pages.liquid -%}
+{%- include reset/workdir.liquid workdir=page.dir -%}
 
-{%- for item in workspace_files %}
-1. [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+{%- for item in workdir_files %}
+- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
 {%- endfor -%}
+
+{%- if include.all -%}
+    {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
+{%- endif -%}

data/_includes/reset/defaults.liquid

@@ -0,0 +1,88 @@
+{%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
+{%- assign version = "1.0.0" -%}
+{%- assign addons = "github, i18n, gems, analytics" | split: ", " -%}
+
+{%- include reset/site_pages.liquid %}
+{%- include reset/i18n.liquid -%}
+{%- include reset/schema.liquid -%}
+
+{% comment %} github-metadata {% endcomment %}
+{%- if jekyll.environment != "production" -%}
+    {%- assign author = site.author | default: "[author]" -%}
+    {%- assign branch = "[branch]" -%}
+    {%- assign commit = "[commit]" -%}
+    {%- assign repository_url = "#" -%}
+    {%- assign issues_url = "#" -%}
+    {%- assign zip_url = "#" -%}
+    {%- assign github_edit_link = "#" -%}
+{%- else -%}
+    {%- assign author = site.author | default: site.github.owner_name -%}
+    {%- assign branch = site.github.source.branch -%}
+    {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
+    {%- assign repository_url = site.github.repository_url -%}
+    {%- assign issues_url = site.github.issues_url -%}
+    {%- assign zip_url = site.github.zip_url -%}
+    {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
+{%- endif -%}
+
+{% comment %} scss and script {% endcomment %}
+{%- capture site_scss -%}
+    @import "site.scss";
+    {%- if site.fluid %}
+        @import "fluid.scss";
+    {% endif -%}
+    {% include assets/custom.scss %} {{ site.scss }}
+{%- endcapture -%}
+
+{%- capture site_script %}
+    {% include assets/site.js %}
+    {% include assets/custom.js %} {{ site.script }}
+{%- endcapture -%}
+
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
+
+{% comment %} title {% endcomment %}
+{%- case page.url -%}
+    {%- when "/" -%}
+        {%- assign title = site.title | append: " · " | append: site.description -%}
+    {%- when "/search.html" -%}
+        {%- assign title = __search   | append: " · " | append: site.title -%}
+    {%- when "/404.html" -%}
+        {%- assign title = __404      | append: " · " | append: site.title -%}
+    {%- else -%}
+        {%- assign title = page.title | default: page.url | append: " · " | append: site.title -%}
+{%- endcase -%}
+
+{% comment %} content {% endcomment %}
+{%- assign content = content
+    | replace: '’', "'"
+    | replace: '<pre class="highlight"><code>', "<pre>"
+    | replace: '<pre><code class=', "<pre class="
+    | replace: "</code></pre>", "</pre>"
+    | replace: '<code class="language-plaintext highlighter-rouge">', '<code class="literal">'
+    | replace: "<table>", '<table class="docutils align-default">' -%}
+
+{% comment %} prev and next {% endcomment %}
+{%- assign workdir_files = site_files | where_exp: "item", "item.dir == page.dir" -%}
+
+{%- assign _index = 0 -%}
+{%- for item in workdir_files %}
+    {%- if item.url == page.url %}
+        {%- assign _index = forloop.index -%}
+    {%- endif %}
+{%- endfor -%}
+
+{%- for item in workdir_files -%}
+    {%- assign _index_prev = _index | minus: 1 -%}
+    {%- assign _index_next = _index | plus: 1 -%}
+    {%- if forloop.index == _index_prev -%}
+        {%- assign prev = item -%}
+    {%- endif %}
+    {%- if forloop.index == _index_next and page.url != page.dir -%}
+        {%- assign next = item -%}
+    {%- endif %}
+{%- endfor -%}