jekyll-rtd-theme 0.1.2 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d728e9dd369e1b9eb77dafc805c93c0be0df3f261ff0e2da35e392ba392e0c22
-  data.tar.gz: 488693e13df30b47b639bef32bf20c72407a0524c2ad5c285b983b0de20fc908
+  metadata.gz: 1f94a7289ccca794b05555f5b78e270b6ccd2923b124ea0f3b105edd72c8ce90
+  data.tar.gz: a9980784705a9095519cfcab9678b89867cd7312e3b525594f32621ad1b7046f
 SHA512:
-  metadata.gz: f947fe21c94458a4ffaa47159f90e606e14596b95edb3063f98fa0a00f51416d03b372f53b1a4dba1e8708129913d8792c8b3429477a263105a418cd49768cfa
-  data.tar.gz: f094f2fff9cb6d9adc0184997d7bd07273e623dbf2a0ca80848faf7b9f13a997cc8f78a2e04ee8c095ac12bfa00723c01bdfc34033b9ca4b60fc2d33755cc358
+  metadata.gz: 328562d6d9430cedd7d7b93b8586f958117c0dec1dcfc0fbb75d3d2f1b7470d1b7140d02aee80101b9f9b96b1e453c3b8bc86b16ace4bd134c2ce232853d4288
+  data.tar.gz: 245e29a661dbc001da381b865aec75e01bda6019d6984b8cfb0049dfcf4d93552d47bb1e5b21f412e0f9756249a605a66dfa972a580dc36961b19f18c5c9d982

data/README.md

@@ -1,49 +1,43 @@
 # jekyll-rtd-theme
-![gh-pages](https://github.com/rundocs/jekyll-rtd-theme/workflows/gh-pages/badge.svg)
-[![Gem Version](https://img.shields.io/gem/v/jekyll-rtd-theme)][gem]
-[![Gem Downloads](https://img.shields.io/gem/dt/jekyll-rtd-theme)][gem]
-[![Users](https://img.shields.io/endpoint?url=https://rundocs-analytics.glitch.me/shields)](https://github.com/rundocs/analytics)
-[![Jsdelivr hits](https://data.jsdelivr.com/v1/package/gh/rundocs/static/badge)](https://cdn.jsdelivr.net/gh/rundocs/static/)
-[![CodeFactor](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme)
-
-Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_theme styles
-
-## Installation
-There are two ways to install: as a gem-based theme, as a remote theme (GitHub Pages compatible)
-
-#### Gem-based method
-1. Add the following to your github repository's `Gemfile`
-    ```ruby
-    source "https://rubygems.org"
-
-    gem "jekyll-rtd-theme"
-
-    gem "github-pages", group: :jekyll_plugins
-    ```
-2. Add the following to your github repository's `_config.yml`
-    ```yml
-    theme: jekyll-rtd-theme
-    ```
-
-#### Remote theme method
-1. Add the following to your site's `_config.yml`
-    ```yml
-    remote_theme: rundocs/jekyll-rtd-theme
-    ```
-2. Remove any other `theme` or `remote_theme` entry
-
+[![](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 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 full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
 
-## Contributing
-1. Clone down the theme's repository (`git clone https://github.com/rundocs/jekyll-rtd-theme.git`)
-2. `cd` into the theme's directory
-3. Run `bundle` to install the necessary dependencies
-4. Run `bundle exec jekyll server` to start the preview server
-5. Visit [`http://localhost:4000`](http://localhost:4000) in your browser to preview the theme
+## The License
+The theme is available as open source under the terms of the [MIT License][license].
 
 
-[gem]: https://rubygems.org/gems/jekyll-rtd-theme
+[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
+[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/{versions.liquid → addons.liquid}

@@ -1,13 +1,13 @@
 <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 addons = "github,gems,analytics" | split: "," -%}
-        {% for name in addons -%}
-            {% include addons/source/{{ name }}.liquid %}
+        {%- assign items = site.addons | default: addons -%}
+        {% for item in items -%}
+            {% include addons/source/{{ item }}.liquid %}
         {% endfor -%}
         <hr>
         <small>

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/assets/404.liquid

@@ -2,4 +2,4 @@
 
 ## {{ __404 }}
 
-{{ __no_results_found }}
+{{ __not_found }}

data/_includes/assets/js/core.js

@@ -0,0 +1,106 @@
+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 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}">${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();
+    SphinxRtdTheme.Navigation.reset = reset;
+    SphinxRtdTheme.Navigation.enable(true);
+});

data/_includes/assets/search.liquid

@@ -1,5 +1,7 @@
 {%- include reset/i18n.liquid -%}
 
-<h2>{{ __search_results }}</h2>
-
-<div id="search-results"></div>
+<div id="search-results">
+    <h2>{{ __searching }}<span>...</span></h2>
+    <p class="search-summary"></p>
+    <ul class="search"></ul>
+</div>

data/_includes/breadcrumbs.liquid

@@ -1,29 +1,37 @@
 <div role="navigation" aria-label="breadcrumbs navigation">
     <ul class="wy-breadcrumbs">
-        <li><a href="{{ site.baseurl }}/" class="icon icon-home"></a>&raquo;</li>
-        {% case page.url %}
-            {% when "/search.html" %}
+        <li>
+            <a href="{{ site.baseurl }}/" class="icon icon-home"></a><i class="fa fa-angle-double-right"></i>
+        </li>
+        {%- case page.url -%}
+            {%- when "/search.html" %}
                 <li>{{ __search }}</li>
-            {% when "/404.html" %}
+            {%- when "/404.html" %}
                 <li>{{ __404 }}</li>
-            {% else %}
-                {% assign blocks = page.path | split: "/" %}
-                {% assign length = blocks | size %}
-                {% if page.dir == page.url and page.url != "/" %}
-                    {% assign length = blocks | size | minus: 1 %}
-                {% endif %}
-                {% for block in blocks limit: length %}
-                    {% if forloop.last %}
+            {%- else -%}
+                {%- assign blocks = page.path | split: "/" -%}
+                {%- assign length = blocks | size -%}
+                {%- if page.dir == page.url and page.url != "/" -%}
+                    {%- assign length = blocks | size | minus: 1 -%}
+                {%- endif -%}
+                {%- for block in blocks limit: length -%}
+                    {%- if forloop.last %}
                         <li>{{ page.title }}</li>
-                    {% else %}
-                        {% capture href %}{{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block | append: "/" }}{% endfor %}{% endcapture %}
-                        <li><a href="{{ href }}">{{ block | capitalize }}</a> &raquo;</li>
-                    {% endif %}
-                {% endfor %}
-        {% endcase %}
-        <li class="wy-breadcrumbs-aside">
-            <a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
-        </li>
+                    {%- else -%}
+                        {%- capture href -%}
+                            {{ 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>
+                        </li>
+                    {%- endif -%}
+                {%- endfor -%}
+        {%- endcase %}
+        {%- 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,26 +1,29 @@
-{%- 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 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 %}
         <li class="toctree-l{{ level }} {{ current }}">
             <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
+                {%- 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 %}
+        <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

@@ -13,13 +13,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

@@ -2,7 +2,7 @@
 {%- assign __homepage = "仓库" -%}
 {%- assign __issues = "反馈" -%}
 {%- assign __download = "下载" -%}
-{%- assign __gems = "文档插件" -%}
+{%- assign __gems = "主题插件" -%}
 {%- assign __statistics = "访问统计" -%}
 {%- assign __total_visits = "累计浏览次数:" -%}
 
@@ -13,13 +13,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 = "您的搜索没有匹配到任何文档, 请确保所有字符拼写正确!" -%}