jekyll-rtd-theme 0.1.7 → 0.1.8

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 4dc19b8440dd2ed5d05e227af867ca52c58efc39a3640f10c3a69e209d038556
-  data.tar.gz: 3f3c62f5541bb6243060d6451c43da375fae232b5d3432e95c8bf05135a64914
+  metadata.gz: 1f94a7289ccca794b05555f5b78e270b6ccd2923b124ea0f3b105edd72c8ce90
+  data.tar.gz: a9980784705a9095519cfcab9678b89867cd7312e3b525594f32621ad1b7046f
 SHA512:
-  metadata.gz: 5dc0bf6face01e8b48ee5a7a125b23f2f60bf75a0079c857d3e8b569f112d2ca125c69b866bb74fa72e277038f054c7801b5b033fc84a753ca49d446b0776723
-  data.tar.gz: ac4ff74d87393b52578a45aecbd4a22894cad693120decac835d969c88266b5ed0f78aa8a665122636a7f57481607b2cee0dd1e542afacc44d99760b59c4ac10
+  metadata.gz: 328562d6d9430cedd7d7b93b8586f958117c0dec1dcfc0fbb75d3d2f1b7470d1b7140d02aee80101b9f9b96b1e453c3b8bc86b16ace4bd134c2ce232853d4288
+  data.tar.gz: 245e29a661dbc001da381b865aec75e01bda6019d6984b8cfb0049dfcf4d93552d47bb1e5b21f412e0f9756249a605a66dfa972a580dc36961b19f18c5c9d982

data/_includes/addons.liquid

@@ -1,7 +1,7 @@
 <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 %}
+        {% if site.addons_branch %}v: {{ branch }}{% endif %}
         <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">

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

@@ -29,7 +29,7 @@
         {%- 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,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 -%}
+                {%- 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 %}
         <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">
+        <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 = "您的搜索没有匹配到任何文档, 请确保所有字符拼写正确!" -%}

data/_includes/list.liquid

@@ -1,10 +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 %}
+{%- for item in workdir_files %}
 - [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
 {%- endfor -%}
 
 {%- if include.all -%}
-    {%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}
+    {%- 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 = "0.1.8" -%}
+{%- assign addons = "github, 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 "style.scss";
+    {%- if site.fluid %}
+        @import "fluid.scss";
+    {% endif -%}
+    @import "custom.scss"; {{ site.scss }}
+{%- endcapture -%}
+
+{%- capture site_script %}
+    {% include assets/js/core.js %}
+    {% include assets/js/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 -%}

data/_includes/reset/schema.liquid

@@ -0,0 +1,2 @@
+{%- assign schema_url = page.url | absolute_url | xml_escape -%}
+{%- assign schema_lastmod = page.date | default: site.time | date_to_xmlschema -%}

data/_includes/reset/site_pages.liquid

@@ -0,0 +1,8 @@
+{%- assign site_pages = site.html_pages
+    | sort: "path"
+    | sort: "sort"
+    | where_exp: "item", "item.url != '/404.html'"
+    | where_exp: "item", "item.url != '/search.html'" -%}
+
+{%- assign site_dirs  = site_pages | where_exp: "item", "item.dir == item.url" -%}
+{%- assign site_files = site_pages | where_exp: "item", "item.dir != item.url" -%}

data/_includes/reset/workdir.liquid

@@ -0,0 +1,17 @@
+{%- assign workdir = include.workdir | default: "/" -%}
+{%- assign workdir_level = workdir | append: "temp/" | split: "/" | size | minus: 1 -%}
+{%- assign workdir_files = site_files | where_exp: "item", "item.dir == workdir" -%}
+
+{%- capture items -%}
+    {%- for item in site_dirs -%}
+        {%- assign current_m1 = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
+        {%- if workdir_level == current_m1 -%}
+            {%- assign temp = workdir | append: "@@" -%}
+            {%- assign dir = item.dir | replace: workdir, temp | split: "@@" | first -%}
+            {%- if workdir == dir -%}
+                {{ item.dir }}|
+            {%- endif -%}
+        {%- endif -%}
+    {%- endfor -%}
+{%- endcapture -%}
+{%- assign workdir_dirs = items | split: "|" -%}

data/_includes/searchbox.liquid

@@ -1,7 +1,5 @@
 <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="check_keywords" value="yes">
-        <input type="hidden" name="area" value="default">
     </form>
-</div>
+</div>

data/_includes/toctree.liquid

@@ -1,7 +1,7 @@
-{%- include reset/workspace.liquid %}
+{%- include reset/workdir.liquid %}
 
 <ul>
-    {%- for item in workspace_files -%}
+    {%- for item in workdir_files -%}
         {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 1 -%}
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
@@ -14,4 +14,4 @@
     {%- endfor %}
 </ul>
 
-{%- for workspace in workspace_dirs %}{% include extend/toctree.liquid %}{% endfor -%}
+{%- for workdir in workdir_dirs %}{% include extend/toctree.liquid %}{% endfor -%}

data/_layouts/default.liquid

@@ -2,7 +2,7 @@
 layout: plugins/compress
 ---
 
-{%- include reset/start.liquid -%}
+{%- include reset/defaults.liquid -%}
 
 <!DOCTYPE html>
 
@@ -43,7 +43,8 @@ layout: plugins/compress
     <link rel="canonical" href="{{ schema_url }}">
     <!-- theme -->
     <link rel="stylesheet" href="{{ cdn }}/assets/css/theme.css">
-    <style>{{ site_style | scssify }}</style>
+    <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 -->