jekyll-rtd-theme 1.1.5 → 2.0.0

data/_includes/head/custom.liquid

@@ -0,0 +1,19 @@
+{%- capture custom_script -%}
+    {% include assets/custom.js %} {{ site.script }}
+{%- endcapture -%}
+
+{%- capture custom_scss -%}
+    {% include assets/custom.scss %} {{ site.scss }}
+{%- endcapture -%}
+
+{%- if custom_script -%}
+    <script>
+        {{ custom_script }}
+    </script>
+{%- endif -%}
+
+{%- if custom_scss -%}
+    <style>
+        {{ custom_scss | scssify | strip_newlines }}
+    </style>
+{%- endif -%}

data/_includes/head/links.liquid

@@ -0,0 +1,16 @@
+{%- comment %} canonical link {% endcomment %}
+<link rel="canonical" href="{{ schema_surl }}">
+
+{%- if prev -%}
+    <link rel="prev" href="{{ prev.url | absolute_url }}">
+{%- endif -%}
+
+{%- if next -%}
+    <link rel="next" href="{{ next.url | absolute_url }}">
+{%- endif -%}
+
+{% comment %} theme {% endcomment %}
+<link rel="stylesheet" href="{{ cdn }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
+
+{% comment %} icon {% endcomment %}
+<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">

data/_includes/head/metadata.liquid

@@ -0,0 +1,21 @@
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
+<meta name="description" content="{{ description }}">
+<meta name="revised" content="{{ docs.build_revision }}">
+<meta name="author" content="{{ author }}">
+<meta name="generator" content="jekyll-rtd-theme v{{ version }}">
+
+{%- comment %} custom {% endcomment %}
+{% for meta in site.meta -%}
+    <meta name="{{ meta.first }}" content="{{ meta.last }}">
+{% endfor -%}
+
+{% comment %} https://ogp.me {% endcomment %}
+<meta property="og:title" content="{{ title }}">
+<meta property="og:description" content="{{ description }}">
+<meta property="og:locale" content="{{ lang }}">
+<meta property="og:url" content="{{ schema_surl }}">
+<meta property="og:type" content="article">
+<meta property="article:author" content="{{ author }}">
+<meta property="article:published_time" content="{{ schema_date }}">
+<meta property="article:modified_time" content="{{ schema_modi }}">

data/_includes/head/script.extension.liquid

@@ -0,0 +1,29 @@
+{%- comment %} mermaid {% endcomment -%}
+{%- if content contains '<code class="language-mermaid">' -%}
+    {%- if site.mermaid.custom -%}
+        <script src="{{ site.mermaid.custom }}"></script>
+    {%- else -%}
+        <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
+    {%- endif %}
+    <script>
+        mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
+    </script>
+{%- endif %}
+
+{% comment %} Google Analytics {% endcomment %}
+{%- if site.google.gtag -%}
+    <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 -%}
+
+{% comment %} Google AdSense {% endcomment %}
+{%- if site.google.adsense -%}
+    <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
+{%- endif -%}

data/_includes/head/script.liquid

@@ -0,0 +1,16 @@
+<script>
+    window.ui = {
+        title: "{{ site.title }}",
+        lang: "{{ site.lang }}",
+        version: "{{ version }}",
+        baseurl: "{{ site.baseurl }}",
+        i18n: {
+            search_docs: "{{ __.search_docs | default: 'Search Docs' }}",
+            search_results: "{{ __.search_results | default: 'Search Results' }}",
+            search_results_found: "{{ __.search_results_found | default: 'Search finished, found # page(s) matching the search query.' }}",
+            search_results_not_found: "{{ __.search_results_not_found | default: 'Your search did not match any documents, please make sure that all characters are spelled correctly!' }}"
+        }
+    };
+</script>
+<script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+<script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/head/script.schema.liquid

@@ -0,0 +1,27 @@
+<script type="application/ld+json">
+    {
+        "@context": "https://schema.org",
+        "@type": "Article",
+        "mainEntityOfPage": {
+            "@type": "WebPage",
+            "@id": "{{ schema_surl }}"
+        },
+        "headline": "{{ title }}",
+        "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
+        "author": {
+            "@type": "Person",
+            "name": "{{ author }}"
+        },
+        "datePublished": "{{ schema_date }}",
+        "dateModified": "{{ schema_modi }}",
+        "publisher": {
+            "@type": "{{ docs.owner.type }}",
+            "name": "{{ author }}",
+            "logo": {
+                "@type": "ImageObject",
+                "url": "{{ docs.owner.avatar_url }}"
+            }
+        },
+        "description": "{{ description }}"
+    }
+</script>

data/_includes/head/title.liquid

@@ -0,0 +1 @@
+<title>{{ title }}</title>

data/_includes/list.liquid

@@ -1,5 +1,5 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/workdir.liquid workdir=page.dir -%}
+{%- include rest/site_pages.liquid -%}
+{%- include rest/workdir.liquid workdir=page.dir -%}
 
 {%- for item in workdir_files %}
 - [{{ item.title | default: item.url }}]({{ item.url | relative_url }})

data/_includes/rest/defaults.liquid

@@ -0,0 +1,69 @@
+{%- include rest/site_pages.liquid -%}
+{%- include rest/i18n.liquid -%}
+
+{%- comment %} variables {% endcomment -%}
+{%- assign version = "2.0.0" -%}
+{%- assign docs = site.github -%}
+{%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
+
+{%- assign rest_created_at = rest.created_at | default: site.time -%}
+{%- assign rest_updated_at = rest.updated_at | default: site.time -%}
+
+{%- assign lang = site.lang | default: "en" -%}
+{%- assign author = docs.owner.name | default: docs.owner_name -%}
+
+{%- comment %} schema {% endcomment -%}
+{%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
+{%- assign schema_modi = site.time | date_to_xmlschema -%}
+{%- assign schema_surl = page.url  | absolute_url | xml_escape -%}
+
+{%- comment %} title {% endcomment -%}
+{%- case page.url -%}
+    {%- when "/" -%}
+        {%- assign title = site.title | append: " · " | append: site.description | truncate: 110 -%}
+    {%- when "/search.html" -%}
+        {%- assign title = __.search  | default: "Search" | append: " · " | append: site.title | truncate: 110 -%}
+    {%- when "/404.html" -%}
+        {%- assign title = "404"      | append: " · " | append: site.title | truncate: 110 -%}
+    {%- else -%}
+        {%- assign title = page.title | default: page.url | append: " · " | append: site.title | truncate: 110 -%}
+{%- endcase -%}
+
+{%- comment %} description {% endcomment -%}
+{%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
+
+{% comment %} debug {% endcomment %}
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
+
+{% comment %} content {% endcomment %}
+{%- assign content = content
+    | replace: '’', "'"
+    | replace: "“", '"'
+    | replace: '”', '"'
+    | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}
+
+
+{% 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 -%}
+        {%- assign next = item -%}
+    {%- endif %}
+{%- endfor -%}

data/_includes/rest/i18n.liquid

@@ -0,0 +1 @@
+{%- assign __ = site.translate | default: site.data.translate -%}

data/_includes/{reset → rest}/workdir.liquid

@@ -1,13 +1,5 @@
-{% comment %} Start from the language chapter(eg: en-us) or root(/) {% endcomment %}
 {%- assign workdir = include.workdir | default: "/" -%}
 
-{%- if page.dir != "/" -%}
-    {%- assign chapter = page.dir | remove_first: "/" | split: "/" | first -%}
-    {%- if languages contains chapter -%}
-        {%- capture workdir %}/{{ chapter }}/{% endcapture -%}
-    {%- endif -%}
-{%- endif -%}
-
 {%- assign workdir_level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
 {%- assign workdir_files = site_files | where_exp: "item", "item.dir == workdir" -%}
 
@@ -19,13 +11,7 @@
             {%- assign dir = item.dir | replace: workdir, temp | split: "@@" | first -%}
             {% comment %} In the current subdirectory {% endcomment %}
             {%- if workdir == dir -%}
-                {% comment %} Root directory does not display other languages {% endcomment %}
-                {%- if workdir == "/" -%}
-                    {%- assign language = item.dir | replace: "/", "" -%}
-                    {%- unless languages contains language %}{{ item.dir }}|{% endunless -%}
-                {%- else -%}
-                    {{ item.dir }}|
-                {%- endif -%}
+                {{ item.dir }}|
             {%- endif -%}
         {%- endif -%}
     {%- endfor -%}

data/_includes/shortcodes/danger.liquid

@@ -0,0 +1,9 @@
+<div class="admonition danger box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.danger | default: "Danger" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
+</div>

data/_includes/shortcodes/mermaid.liquid

@@ -0,0 +1 @@
+<div class="mermaid overflow-x-auto">{{ codes }}</div>

data/_includes/shortcodes/note.liquid

@@ -0,0 +1,9 @@
+<div class="admonition note box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.note | default: "Note" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
+</div>

data/_includes/shortcodes/tip.liquid

@@ -0,0 +1,9 @@
+<div class="admonition tip box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.tip | default: "Tip" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
+</div>

data/_includes/shortcodes/warning.liquid

@@ -0,0 +1,9 @@
+<div class="admonition warning box-shadow mb-3">
+    <div class="title px-2 py-1">
+        <i class="fa fa-exclamation-circle"></i>
+        {{ __.warning | default: "Warning" }}
+    </div>
+    <div class="content p-2">
+        {{ codes | markdownify | strip_newlines -}}
+    </div>
+</div>

data/_layouts/default.liquid

@@ -2,246 +2,28 @@
 layout: plugins/compress
 ---
 
-{%- include reset/defaults.liquid -%}
+{%- include rest/defaults.liquid -%}
 
 <!DOCTYPE html>
-
-<!--
-    {% if site.remote_theme -%}
-        rundocs.io, remote_theme: {{ site.remote_theme }}, based on v{{ version }}
-    {%- else -%}
-        rundocs.io, theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
-    {%- endif %}
--->
-
-<html class="writer-html5" lang="{{ lang }}">
-
-<head>
-    <meta charset="utf-8">
-    <meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
-    <meta content="IE=Edge" http-equiv="X-UA-Compatible">
-    <title>{{ title | truncate: 110 }}</title>
-    <script>
-        window.dataLayer = window.dataLayer || [];
-
-        function gtag() {
-            dataLayer.push(arguments);
-        }
-
-        function debug() {
-            console.debug.apply(console, arguments);
-        }
-
-        gtag("js", new Date());
-
-        if ("serviceWorker" in navigator) {
-            navigator.serviceWorker.register("{{ site.baseurl }}/sw.caches.js");
-        } else {
-            debug("Service Worker not supported!");
-        }
-    </script>
-    <!-- meta -->
-    <meta name="description" content="{{ description }}">
-    <meta name="author" content="{{ author }}">
-    <meta name="revised" content="{{ commit }}">
-    <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
-    <!-- meta-ogp -->
-    {% comment %} https://ogp.me {% endcomment %}
-    <meta property="og:title" content="{{ title }}">
-    <meta property="og:description" content="{{ description }}">
-    <meta property="og:locale" content="{{ lang }}">
-    <meta property="og:url" content="{{ schema_surl }}">
-    <meta property="og:type" content="article">
-    <meta property="article:author" content="{{ author }}">
-    <meta property="article:published_time" content="{{ schema_date }}">
-    <meta property="article:modified_time" content="{{ schema_modi }}">
-    <!-- meta-custom -->
-    {% for meta in site.meta -%}
-        <meta name="{{ meta.first }}" content="{{ meta.last }}">
-    {% endfor -%}
-    <!-- schema -->
-    <script type="application/ld+json">
-        {
-            "@context": "https://schema.org",
-            "@type": "Article",
-            "mainEntityOfPage": {
-                "@type": "WebPage",
-                "@id": "{{ schema_surl }}"
-            },
-            "headline": "{{ title | truncate: 110 }}",
-            "image": [{% for image in page.images %}"{{ image }}"{% unless forloop.last %},{% endunless %}{% endfor %}],
-            "author": {
-                "@type": "Person",
-                "name": "{{ author }}"
-            },
-            "datePublished": "{{ schema_date }}",
-            "dateModified": "{{ schema_modi }}",
-            "publisher": {
-                "@type": "Organization",
-                "name": "RunDocs",
-                "logo": {
-                    "@type": "ImageObject",
-                    "url": "https://rundocs.io/logo.png"
-                }
-            },
-            "description": "{{ description }}"
-        }
-    </script>
-    <!-- link -->
-    <link rel="canonical" href="{{ schema_surl }}">
-    {% if prev %}<link rel="prev" href="{{ prev.url | absolute_url }}">{% endif %}
-    {% if next %}<link rel="next" href="{{ next.url | absolute_url }}">{% endif %}
-    <!-- theme -->
-    <link rel="stylesheet" href="{{ cdn }}/assets/css/theme.css">
-    <link rel="stylesheet" href="{{ cdn }}/assets/css/rougify/{{ site.rougify | default: 'github' }}.css">
-    <style>{{ site_scss | scssify | strip_newlines }}</style>
-    <!-- icon -->
-    <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">
-    <!-- script -->
-    <!--[if lt IE 9]><script src="{{ cdn }}/assets/js/html5shiv.min.js"></script><![endif]-->
-    <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
-    <script>
-        const ui = {
-            baseurl: "{{ site.baseurl }}",
-            title: "{{ site.title }}",
-            lang: "{{ lang }}",
-            admonition: {
-                note: "{{ __note }}",
-                tip: "{{ __tip }}",
-                warning: "{{ __warning }}",
-                danger: "{{ __danger }}"
-            }
-        };
-    </script>
-    {% include extra/head.html %}
-</head>
-
-<body class="wy-body-for-nav">
-    <div class="wy-grid-for-nav">
-        <!-- NAV -->
-        <nav data-toggle="wy-nav-shift" class="wy-nav-side">
-            <div class="wy-side-scroll">
-                <div class="wy-side-nav-search">
-                    {% if site.logo %}
-                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">
-                            <img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
-                        </a>
-                    {% else %}
-                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}" class="icon icon-home"> {{ site.title }}</a>
-                    {% endif %}
-                    <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="lang" value="{{ lang }}">
-                        </form>
-                    </div>
-                </div>
-                <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">{% include toctree.liquid %}</div>
-                {%- if site.embed -%}
-                    <div class="wy-embed-wrap"><div class="wy-embed">{{ site.embed }}</div></div>
-                {%- endif -%}
-            </div>
-        </nav>
-
-        <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">
-            <!-- MOBILE NAV -->
-            <nav class="wy-nav-top" aria-label="top navigation">
-                <div class="flex">
-                    <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
-                    <div class="wy-nav-title">
-                        <a href="{{ site.baseurl }}/{% if site_lang != lang %}{{ lang }}/{% endif %}">{{ site.title }}</a>
-                    </div>
-                </div>
-            </nav>
-            <div class="wy-nav-content">
-                <div class="rst-content">
-                    {% include breadcrumbs.liquid %}
-                    <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
-                        <div itemprop="articleBody">
-                            {%- if page.url == "/search.html" -%}
-                                {{ content }}
-                            {%- else -%}
-                                <div class="section">{{ content }}</div>
-                            {%- endif -%}
-                        </div>
-                        {% comment %} comments {% endcomment %}
-                        {% 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 %}
-                    </div>
-                    {% include footer.liquid %}
-                </div>
-            </div>
-        </section>
-    </div>
-    {%- if site.addons %}{% include addons.liquid %}{% endif %}
-    {% include extra/footer.html %}
-    <!-- script -->
-    <script src="{{ cdn }}/assets/js/theme.js"></script>
-    <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
-
-    {% comment %} mermaid {% endcomment %}
-    {%- if content contains '<pre class="notranslate language-mermaid">' -%}
-        {%- if site.mermaid.custom -%}
-            <script src="{{ site.mermaid.custom }}"></script>
-        {%- else -%}
-            <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
-        {%- endif %}
-        <script>
-            mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
-        </script>
-    {%- endif %}
-    <script>
-        {% include assets/common.js %}
-        {% include assets/custom.js %} {{ site.script }}
-    </script>
-
-    {% comment %} Baidu link submit {% endcomment %}
-    {%- 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 -%}
-
-    {% comment %} Baidu Analytics {% endcomment %}
-    {%- 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 -%}
-
-    {% comment %} CNZZ Analytics {% endcomment %}
-    {%- 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 -%}
-
-    {% comment %} Google Analytics {% endcomment %}
-    {%- if site.google.gtag -%}
-        <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
-        <script>
-            gtag("config", "{{ site.google.gtag }}");
-        </script>
-    {%- endif -%}
-
-    {% comment %} Google AdSense {% endcomment %}
-    {%- if site.google.adsense -%}
-        <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
-    {%- endif -%}
-</body>
-
+<html lang="{{ site.lang }}">
+    <head>
+        {%- include head/metadata.liquid -%}
+
+        {%- include head/title.liquid -%}
+        {%- include head/links.liquid -%}
+
+        {%- include head/script.schema.liquid -%}
+        {%- include head/script.liquid -%}
+        {%- include head/custom.liquid -%}
+        {%- include head/script.extension.liquid -%}
+
+        {%- include extra/head.html -%}
+    </head>
+    <body class="container">
+        {%- include class/sidebar-wrap.liquid -%}
+        {%- include class/content-wrap.liquid -%}
+        {%- include class/addons-wrap.liquid  -%}
+
+        {%- include extra/footer.html -%}
+    </body>
 </html>