jekyll-rtd-theme 1.0.0 → 1.0.5

data/_sass/_album.scss

@@ -22,4 +22,4 @@
             width: 100%;
         }
     }
-}
+}

data/_sass/_embed.scss

@@ -20,4 +20,4 @@
             max-width: 100%;
         }
     }
-}
+}

data/_sass/fluid.scss

@@ -4,4 +4,4 @@
     .wy-nav-content {
         max-width: none;
     }
-}
+}

data/_sass/site.scss

@@ -1,6 +1,6 @@
 @import "_album.scss";
 @import "_embed.scss";
-
+/* custom */
 p {
     font-size: 15px;
 }
@@ -11,21 +11,21 @@ footer {
         text-align: center;
     }
 }
-
+/* breadcrumbs icon */
 .fa-angle-double-right {
     font-size: 13px;
 }
-
+/* fixed the addon overflow */
 .rst-versions {
     &.shift-up {
         overflow-y: auto;
     }
 }
-
+/* fixed the toctree padding */
 .wy-nav-side {
     padding-bottom: 3em;
 }
-
+/* mobile title margin, not the best method, flex should be better  */
 .wy-nav-top {
     a {
         margin-left: -30px;
@@ -33,31 +33,32 @@ footer {
 }
 
 .rst-content {
+    /* fixed the long list */
     ol,
     ul {
         overflow-x: auto;
     }
-
+    /* fixed link>code */
     a code.literal {
         color: #2980b9;
     }
-
+    /* custom */
     code,
     div[class^=highlight] pre,
     pre {
         font-family: monospace;
         font-size: 12px;
     }
-
-    .copyright-rtd {
+    /* theme copyright */
+    .rundocs {
         display: none;
     }
-
+    /* view box of search results */
     .highlighted-box {
         border: 1px solid #f1c40f;
     }
 }
-
+/* fixed the last of search results display */
 #search-results {
     li:last-child {
         border-bottom: 0;
@@ -66,12 +67,14 @@ footer {
 }
 @media screen and (max-width: 768px) {
     .wy-nav-content-wrap {
+        /* custom */
         .wy-nav-content {
             padding: 1em;
         }
     }
 }
 @media screen and (max-width: 480px) {
+    /* show edit on mobile */
     .wy-breadcrumbs li.wy-breadcrumbs-aside {
         display: initial;
     }

data/assets/favicon.svg

@@ -2,4 +2,4 @@
     <path d="M0 0h24v24H0z" fill="none"/>
     <path d="M19 3H5c-1.1 0-2 .9-2 2v14c0 1.1.9 2 2 2h14c1.1 0 2-.9 2-2V5c0-1.1-.9-2-2-2zm-5 14H7v-2h7v2zm3-4H7v-2h10v2zm0-4H7V7h10v2z"/>
 </svg>
-<!-- material-design-icons article -->
+<!-- material-design-icons article -->

data/assets/js/html5shiv.min.js

@@ -0,0 +1,4 @@
+/**
+* @preserve HTML5 Shiv 3.7.3 | @afarkas @jdalton @jon_neal @rem | MIT/GPL2 Licensed
+*/
+!function(a,b){function c(a,b){var c=a.createElement("p"),d=a.getElementsByTagName("head")[0]||a.documentElement;return c.innerHTML="x<style>"+b+"</style>",d.insertBefore(c.lastChild,d.firstChild)}function d(){var a=t.elements;return"string"==typeof a?a.split(" "):a}function e(a,b){var c=t.elements;"string"!=typeof c&&(c=c.join(" ")),"string"!=typeof a&&(a=a.join(" ")),t.elements=c+" "+a,j(b)}function f(a){var b=s[a[q]];return b||(b={},r++,a[q]=r,s[r]=b),b}function g(a,c,d){if(c||(c=b),l)return c.createElement(a);d||(d=f(c));var e;return e=d.cache[a]?d.cache[a].cloneNode():p.test(a)?(d.cache[a]=d.createElem(a)).cloneNode():d.createElem(a),!e.canHaveChildren||o.test(a)||e.tagUrn?e:d.frag.appendChild(e)}function h(a,c){if(a||(a=b),l)return a.createDocumentFragment();c=c||f(a);for(var e=c.frag.cloneNode(),g=0,h=d(),i=h.length;i>g;g++)e.createElement(h[g]);return e}function i(a,b){b.cache||(b.cache={},b.createElem=a.createElement,b.createFrag=a.createDocumentFragment,b.frag=b.createFrag()),a.createElement=function(c){return t.shivMethods?g(c,a,b):b.createElem(c)},a.createDocumentFragment=Function("h,f","return function(){var n=f.cloneNode(),c=n.createElement;h.shivMethods&&("+d().join().replace(/[\w\-:]+/g,function(a){return b.createElem(a),b.frag.createElement(a),'c("'+a+'")'})+");return n}")(t,b.frag)}function j(a){a||(a=b);var d=f(a);return!t.shivCSS||k||d.hasCSS||(d.hasCSS=!!c(a,"article,aside,dialog,figcaption,figure,footer,header,hgroup,main,nav,section{display:block}mark{background:#FF0;color:#000}template{display:none}")),l||i(a,d),a}var k,l,m="3.7.3-pre",n=a.html5||{},o=/^<|^(?:button|map|select|textarea|object|iframe|option|optgroup)$/i,p=/^(?:a|b|code|div|fieldset|h1|h2|h3|h4|h5|h6|i|label|li|ol|p|q|span|strong|style|table|tbody|td|th|tr|ul)$/i,q="_html5shiv",r=0,s={};!function(){try{var a=b.createElement("a");a.innerHTML="<xyz></xyz>",k="hidden"in a,l=1==a.childNodes.length||function(){b.createElement("a");var a=b.createDocumentFragment();return"undefined"==typeof a.cloneNode||"undefined"==typeof a.createDocumentFragment||"undefined"==typeof a.createElement}()}catch(c){k=!0,l=!0}}();var t={elements:n.elements||"abbr article aside audio bdi canvas data datalist details dialog figcaption figure footer header hgroup main mark meter nav output picture progress section summary template time video",version:m,shivCSS:n.shivCSS!==!1,supportsUnknownElements:l,shivMethods:n.shivMethods!==!1,type:"default",shivDocument:j,createElement:g,createDocumentFragment:h,addElements:e};a.html5=t,j(b),"object"==typeof module&&module.exports&&(module.exports=t)}("undefined"!=typeof window?window:this,document);

data/assets/robots.txt

@@ -6,4 +6,4 @@ permalink: /robots.txt
 User-agent: *
 Allow: /
 
-Sitemap: {{ "sitemap.xml" | absolute_url }}
+Sitemap: {{ "sitemap.xml" | absolute_url | replace: "http://", "https://" }}

data/assets/search.liquid

@@ -1,8 +1,9 @@
 ---
 permalink: /search.html
-layout: basic
+layout: default
 ---
 
+{%- include reset/site_pages.liquid -%}
 {%- include reset/i18n.liquid -%}
 
 <div id="search-results">
@@ -10,3 +11,18 @@ layout: basic
     <p class="search-summary"></p>
     <ul class="search"></ul>
 </div>
+
+<script>
+    const i18n = {
+        {%- for lang in site_langs -%}
+            {%- include i18n/{{ lang }}.liquid %}
+            "{{ lang }}": {
+                search_docs: "{{ __search_docs }}",
+                search_results: "{{ __search_results }}",
+                search_results_found: "{{ __search_results_found }}",
+                search_results_not_found: "{{ __search_results_not_found }}"
+            }{% unless forloop.last %},{% endunless %}
+        {%- endfor -%}
+    };
+</script>
+<script>{% include assets/search.js %}</script>

data/assets/sitemap.liquid

@@ -0,0 +1,17 @@
+---
+layout: plugins/compress
+permalink: /sitemap.xml
+---
+
+{%- include reset/site_pages.liquid -%}
+
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    {%- for page in site_pages -%}
+        <url>
+            <loc>{{ page.url | absolute_url | replace: "http://", "https://" | xml_escape }}</loc>
+            <priority>{{ page.content | size | divided_by: 2048.0 | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 }}</priority>
+            <lastmod>{{ site.time | date_to_xmlschema }}</lastmod>
+        </url>
+    {%- endfor %}
+</urlset>

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: jekyll-rtd-theme
 version: !ruby/object:Gem::Version
-  version: 1.0.0
+  version: 1.0.5
 platform: ruby
 authors:
 - saowang
 autorequire: 
 bindir: bin
 cert_chain: []
-date: 2020-08-02 00:00:00.000000000 Z
+date: 2020-08-10 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: github-pages
@@ -16,14 +16,14 @@ dependencies:
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '206'
+        version: '207'
   type: :runtime
   prerelease: false
   version_requirements: !ruby/object:Gem::Requirement
     requirements:
     - - "~>"
       - !ruby/object:Gem::Version
-        version: '206'
+        version: '207'
 description: 
 email:
 - saowang@outlook.com
@@ -34,36 +34,34 @@ files:
 - LICENSE
 - README.md
 - _includes/addons.liquid
-- _includes/addons/analytics/baidu.liquid
-- _includes/addons/analytics/cnzz.liquid
-- _includes/addons/analytics/google.liquid
-- _includes/addons/comments/disqus.liquid
-- _includes/addons/seo/og.liquid
-- _includes/addons/seo/schema.liquid
-- _includes/addons/source/analytics.liquid
-- _includes/addons/source/gems.liquid
-- _includes/addons/source/github.liquid
-- _includes/addons/source/i18n.liquid
+- _includes/addons/analytics.liquid
+- _includes/addons/github.liquid
+- _includes/addons/i18n.liquid
+- _includes/addons/plugins.liquid
 - _includes/album.liquid
+- _includes/assets/common.js
 - _includes/assets/custom.js
 - _includes/assets/custom.scss
-- _includes/assets/site.js
+- _includes/assets/search.js
 - _includes/breadcrumbs.liquid
 - _includes/extend/list.liquid
 - _includes/extend/tabs.liquid
 - _includes/extend/toctree.liquid
 - _includes/footer.liquid
-- _includes/i18n/en-US.liquid
-- _includes/i18n/zh-CN.liquid
+- _includes/i18n/en.liquid
+- _includes/i18n/fr.liquid
+- _includes/i18n/it.liquid
+- _includes/i18n/ja.liquid
+- _includes/i18n/ko.liquid
+- _includes/i18n/ru.liquid
+- _includes/i18n/zh-cn.liquid
 - _includes/list.liquid
 - _includes/reset/defaults.liquid
 - _includes/reset/i18n.liquid
-- _includes/reset/schema.liquid
+- _includes/reset/languages.liquid
 - _includes/reset/site_pages.liquid
 - _includes/reset/workdir.liquid
-- _includes/searchbox.liquid
 - _includes/toctree.liquid
-- _layouts/basic.liquid
 - _layouts/default.liquid
 - _layouts/plugins/compress.liquid
 - _sass/_album.scss
@@ -114,12 +112,13 @@ files:
 - assets/css/theme.css
 - assets/favicon.svg
 - assets/js/anchor.min.js
+- assets/js/html5shiv.min.js
 - assets/js/jquery.min.js
 - assets/js/theme.js
 - assets/pages.json
 - assets/robots.txt
 - assets/search.liquid
-- assets/sitemap.xml
+- assets/sitemap.liquid
 homepage: https://github.com/rundocs/jekyll-rtd-theme
 licenses:
 - MIT
@@ -142,5 +141,5 @@ requirements: []
 rubygems_version: 3.1.2
 signing_key: 
 specification_version: 4
-summary: Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
+summary: Just another jekyll docs theme compatible with GitHub Pages, based on sphinx_rtd_theme
 test_files: []

data/_includes/addons/analytics/baidu.liquid

@@ -1,18 +0,0 @@
-{%- if site.baidu.linksubmit -%}
-<script>
-    (function(script) {
-        script.src = "https://zz.bdstatic.com/linksubmit/push.js";
-        document.head.appendChild(script);
-    })(document.createElement("script"));
-</script>
-{%- endif -%}
-
-{%- if site.baidu.hm -%}
-<script>
-    var _hmt = _hmt || [];
-    (function(script) {
-        script.src = "https://hm.baidu.com/hm.js?{{ site.baidu.hm }}";
-        document.head.appendChild(script);
-    })(document.createElement("script"));
-</script>
-{%- endif -%}

data/_includes/addons/analytics/cnzz.liquid

@@ -1,4 +0,0 @@
-{%- if site.cnzz -%}
-    <span id="cnzz_stat_icon_{{ site.cnzz }}" style="display: none;"></span>
-    <script async src="https://v1.cnzz.com/z_stat.php?id={{ site.cnzz }}"></script>
-{%- endif -%}

data/_includes/addons/analytics/google.liquid

@@ -1,18 +0,0 @@
-{%- if site.google.gtag -%}
-<!-- Google Analytics -->
-<script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
-<script>
-    window.dataLayer = window.dataLayer || [];
-
-    function gtag() {
-        dataLayer.push(arguments);
-    }
-    gtag("js", new Date());
-    gtag("config", "{{ site.google.gtag }}");
-</script>
-{%- endif -%}
-
-{%- 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 -%}

data/_includes/addons/comments/disqus.liquid

@@ -1,10 +0,0 @@
-{% 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/seo/og.liquid

@@ -1,7 +0,0 @@
-<meta property="og:title" content="{{ title }}">
-<meta property="og:description" content="{{ description }}">
-<meta property="og:locale" content="{{ lang }}">
-<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 }}">

data/_includes/addons/seo/schema.liquid

@@ -1,10 +0,0 @@
-<script type="application/ld+json">
-    {
-        "@context": "http://schema.org",
-        "@type": "Article",
-        "name": "{{ title }}",
-        "author": "{{ author }}",
-        "url": "{{ schema_url }}",
-        "dateModified": "{{ schema_lastmod }}"
-    }
-</script>

data/_includes/assets/site.js

@@ -1,125 +0,0 @@
-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);
-});