jekyll-rtd-theme 1.1.7 → 2.0.2

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bfa6e7cffcb895b7a19f9f904415f281083b74a3578bb9e2679058895719c54a
-  data.tar.gz: 144a22891ac23e3fc30dbfc9b2ccfa11c595be2667f0d24de1c034f747086e05
+  metadata.gz: 9f4f4168adf2ae575fe0c262155ebb5449ce2a2d69c5c9be9c811287ab0527d6
+  data.tar.gz: 7d70ba9d589a881660140fda943b585ae9f77b392f2bdb1720adfe40bee375b4
 SHA512:
-  metadata.gz: 53034a59f804c982e3c36dc863567050dbb8c45bd510c09e6244c9e839d0456df681dfb3e4deb2b1b9a8d3aedb87f7aa2db0f20692aa80fde22e471d21e6b201
-  data.tar.gz: fb7a032b4b6f85f82cd9078ba514970fce313cf2b6dbab52689c7de8979ce69da7aa38560ba63cad1c20885e67f6980d749ff776f4f8b51dd66be42a4d918f24
+  metadata.gz: 467ea12e4724b57506b3389b08bbeec30721572cb2c5ab00b7211c906a5deffa2674b34fb69778e8b156b8ead4d928f433466b82f0d3248df4900e7387e09f60
+  data.tar.gz: b4a165867d9e4090b97a1443194204fcde0551a069477cfad57cca4140e1816a11e26969595b8c912943da63340ce59a502d783a966ea741e97ab8033c105dc8

data/README.md

@@ -1,43 +1,92 @@
 # jekyll-rtd-theme
-[![](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)
-[![](https://badges.gitter.im/rundocs/jekyll-rtd-theme.svg)][gitter]
 
-GitHub-flavored docs theme for Jekyll, based on sphinx_rtd_theme
+![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)
+![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)
 
-<img class="shadow-box" width="50%" alt="jekyll-rtd-theme" src="https://user-images.githubusercontent.com/68011645/89026666-ad3a8680-d35b-11ea-9f4b-d3fe26ae12ed.png">
+Opinionated github flavored standard document theme for open source projects, with few options, but everything!
+
+## What it does?
+
+This theme is inspired by [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme) and refactored with:
+
+- [github-pages](https://github.com/github/pages-gem)
+- [@primer/css](https://github.com/primer/css)
+
+Give you a native GitHub experience and solved the issue of open source project documentation site
+
+- No need to learn other programming languages for building documentation
+- No need to care about the site SEO
+- Markdown syntax extended
+- Native support for mermaid chart plugin
 
 ## Quick start
+
 ```yml
 remote_theme: rundocs/jekyll-rtd-theme
 ```
+
 You can [generate](https://github.com/rundocs/starter-slim/generate) with the same files and folders from [rundocs/starter-slim](https://github.com/rundocs/starter-slim/)
 
-## Features
-- Automatically generate nested sidebar based on directory
-- Multi-language supported
-- Search engine optimized
-- Document search (RegExp supported)
-- Support third-party comments
-- Google, Baidu, CNZZ Analytics supported
-- Just need one file `_config.yml` to configure site
+## Options
+
+```yml
+title: Your awesome title
+lang: # default: en
+description: Write an awesome description for your new site here
+
+readme_index:
+  with_frontmatter: true
 
-## Documents
-For full documentation, please refer to our website ([rundocs.io](https://rundocs.io/)) for details
+## optional settings ##
+meta:
+  key1: value1
+  key2: value2
+  .
+  .
+  .
 
-### test
-- Latest test document: [rundocs.github.io/jekyll-rtd-theme](https://rundocs.github.io/jekyll-rtd-theme)
-- Preview debug branch, please refer to [rundocs.github.io/debug](https://rundocs.github.io/debug)
+google:
+  gtag:
+  adsense:
+
+mermaid:
+  custom: # mermaid link
+  initialize: # mermaid options, default: {}
+
+# also available via file: _include/assets/custom.scss
+scss:
+
+# also available via file: _include/assets/custom.js
+script:
+
+# also available via file: _data/translate.yml
+translate:
+  # shortcodes
+  danger:
+  note:
+  tip:
+  warning:
+  # 404
+  not_found:
+  # search
+  searching:
+  search:
+  search_docs:
+  search_results:
+  search_results_found: # the "#" in this translate will replaced with results size!
+  search_results_not_found:
+
+## optional plugins ##
+plugins:
+  - jemoji
+  - jekyll-avatar
+  - jekyll-mentions
+```
+
+## Waiting
+
+Document writing specifications, please refer to [rundocs.io](https://rundocs.io) for details
 
 ## The license
-The theme is available as open source under the terms of the MIT License
 
-[repository]: https://github.com/rundocs/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
-[gitter]: https://gitter.im/rundocs/jekyll-rtd-theme?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge
+The theme is available as open source under the terms of the MIT License

data/_includes/addons/analytics.liquid

@@ -1,18 +1,11 @@
 <dl>
-    <dt>{{ __statistics }}</dt>
+    <dt>{{ __.statistics | default: "Statistics" }}</dt>
     <dd>
-        <a href="https://github.com/rundocs/analytics" target="_blank">
-            {{ __total_visits }} <span id="counter"><span class="progress"></span></span> <i class="fa fa-eye"></i>
+        <a href="https://github.com/rundocs/analytics" rel="noreferrer" target="_blank">
+            {{ __.total_visits | default: "Total visits" }}:
+            <span id="counter">
+                <span class="AnimatedEllipsis"></span>
+            </span>
         </a>
     </dd>
 </dl>
-
-<script>
-    $(document).ready(function() {
-        let analytics = new URL("https://rundocs-analytics.glitch.me/collect?v={{ version }}&lang={{ lang }}");
-        analytics.searchParams.append("user_lang", navigator.language);
-        analytics.searchParams.append("host", location.host);
-        analytics.searchParams.append("platform", navigator.platform);
-        $.getJSON(analytics.toString(), (data) => $("#counter").html(data.count));
-    });
-</script>

data/_includes/addons/github.liquid

@@ -1,20 +1,21 @@
 <dl>
-    <dt>{{ __github }}</dt>
-    {%- if include.items -%}
-        {% for item in include.items -%}
-            {% case item %}
-                {% when "homepage" %}
-                    <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-                {% when "issues" %}
-                    <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
-                {% when "download" %}
-                    <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-                {% else %}
-            {% endcase %}
-        {% endfor -%}
-    {%- else -%}
-        <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-        <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
-        <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-    {%- endif -%}
+    <dt>{{ __.github | default: "GitHub" }}</dt>
+    <dd>
+        <a href="{{ docs.repository_url }}" title="{{ __.stars | default: 'Stars' }}: {{ rest.stargazers_count }}">
+            <i class="fa fa-github"></i>
+            {{ __.homepage | default: "Homepage" }}
+        </a>
+    </dd>
+    <dd>
+        <a href="{{ docs.issues_url }}" title="{{ __.open_issues | default: 'Open issues' }}: {{ rest.open_issues }}">
+            <i class="fa fa-question-circle-o"></i>
+            {{ __.issues | default: "Issues" }}
+        </a>
+    </dd>
+    <dd>
+        <a href="{{ docs.zip_url }}" title="{{ __.size | default: 'Size' }}: {{ rest.size }} Kb">
+            <i class="fa fa-download"></i>
+            {{ __.download | default: "Download" }}
+        </a>
+    </dd>
 </dl>

data/_includes/assets/sw.caches.js

@@ -1,33 +1,43 @@
-self.addEventListener("activate", function(event) {
-    let cacheWhitelist = ["rundocs-{{ version }}"];
+self.addEventListener("activate", function (event) {
+  let cacheWhitelist = ["rundocs-{{ version }}"];
 
-    event.waitUntil(
-        caches.keys().then(function(keyList) {
-            return Promise.all(keyList.map(function(key) {
-                if (cacheWhitelist.indexOf(key) === -1) {
-                    return caches.delete(key);
-                }
-            }));
+  event.waitUntil(
+    caches.keys().then(function (keyList) {
+      return Promise.all(
+        keyList.map(function (key) {
+          if (cacheWhitelist.indexOf(key) === -1) {
+            return caches.delete(key);
+          }
         })
-    );
+      );
+    })
+  );
 });
 
-self.addEventListener("fetch", function(e) {
-    if (/^https:\/\/cdn\.jsdelivr\.net\/gh\/rundocs\/jekyll-rtd-theme@.+/.exec(e.request.url)) {
-        e.respondWith(
-            caches.match(e.request).then(function(resp) {
-                if (resp !== undefined) {
-                    return resp;
-                } else {
-                    return fetch(e.request, { cache: "no-store" }).then(function(resp) {
-                        let clone = resp.clone();
-                        caches.open("rundocs-{{ version }}").then(function(cache) {
-                            cache.put(e.request, clone);
-                        });
-                        return resp;
-                    }).catch(console.log);
-                }
+self.addEventListener("fetch", function (e) {
+  if (
+    /^https:\/\/cdn\.jsdelivr\.net\/gh\/rundocs\/jekyll-rtd-theme@.+/.exec(
+      e.request.url
+    )
+  ) {
+    e.respondWith(
+      caches.match(e.request).then(function (resp) {
+        if (resp !== undefined) {
+          return resp;
+        } else {
+          return fetch(e.request, {
+            cache: "no-store",
+          })
+            .then(function (resp) {
+              let clone = resp.clone();
+              caches.open("rundocs-{{ version }}").then(function (cache) {
+                cache.put(e.request, clone);
+              });
+              return resp;
             })
-        );
-    }
-});
+            .catch(console.log);
+        }
+      })
+    );
+  }
+});

data/_includes/class/_breadcrumbs.liquid

@@ -0,0 +1,33 @@
+<div class="navigation-top d-flex flex-justify-between">
+    <ul class="breadcrumb" role="navigation" aria-label="breadcrumbs navigation">
+        <li class="breadcrumb-item">
+            <a class="no-underline" href="{{ site.baseurl }}/">
+                <i class="fa fa-home"></i>
+            </a>
+        </li>
+        {%- case page.url -%}
+            {%- when "/search.html" -%}
+                <li class="breadcrumb-item" aria-current="page">
+                    {{ __.search | default: "Search" }}
+                </li>
+            {%- when "/404.html" -%}
+                <li class="breadcrumb-item" aria-current="page">
+                    404
+                </li>
+            {%- else -%}
+                {%- assign blocks = page.path | split: "/" -%}
+                {%- for block in blocks -%}
+                    <li class="breadcrumb-item" {% if forloop.last %}aria-current="page"{% endif %}>
+                        {%- if forloop.last -%}
+                            {{ page.name }}
+                        {%- else -%}
+                            <a href="{{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block }}/{% endfor %}">{{ block }}</a>
+                        {%- endif -%}
+                    </li>
+                {%- endfor -%}
+        {%- endcase -%}
+    </ul>
+    <a class="edit" href="{% github_edit_link %}" title="{{ __.edit | default: 'Edit on GitHub'}}" rel="noreferrer" target="_blank">
+        <i class="fa fa-edit"></i>
+    </a>
+</div>

data/_includes/class/_footer.liquid

@@ -0,0 +1,41 @@
+{% comment %} prev and next {% endcomment %}
+{%- if page.url != "/search.html" and page.url != "/404.html" -%}
+    {%- if next or prev -%}
+        <div class="navigation-bottom d-flex flex-justify-between py-3" role="navigation" aria-label="footer navigation">
+            <div class="prev">
+                {%- if prev -%}
+                    <a href="{{ prev.url | relative_url }}" class="btn" title="{{ prev.title }}" accesskey="p" rel="prev">
+                        <i class="fa fa-arrow-circle-left"></i> {{ __.previous | default: "Previous" }}
+                    </a>
+                {%- endif -%}
+            </div>
+            <div class="next">
+                {%- if next -%}
+                    <a href="{{ next.url | relative_url }}" class="btn" title="{{ next.title }}" accesskey="n" rel="next">
+                        {{ __.next | default: "Next" }} <i class="fa fa-arrow-circle-right"></i>
+                    </a>
+                {%- endif -%}
+            </div>
+        </div>
+    {%- endif -%}
+{%- endif -%}
+
+<hr>
+
+<div class="copyright text-center text-gray" role="contentinfo">
+    <i class="fa fa-copyright"></i>
+    {%- assign created_time = rest_created_at | date: "%Y" -%}
+    {%- assign updated_time = rest_updated_at | date: "%Y" -%}
+    {%- if created_time == updated_time -%}
+        {{ created_time }},
+    {%- else -%}
+        {{ created_time }}-{{ updated_time }},
+    {%- endif %}
+    <a class="text-gray" href="{{ docs.owner_url }}" target="_blank">
+        {{ author }}
+    </a>
+    {{ __.revision | default: "Revision" }}
+    <a class="text-gray" href="{{ docs.repository_url }}/commit/{{ docs.build_revision }}" title="{{ docs.build_revision }}" target="_blank">
+        {{ docs.build_revision | slice: 0, 7 }}
+    </a>
+</div>

data/_includes/{toctree.liquid → class/_toctree.liquid}

@@ -4,15 +4,12 @@
 <ul>
     {%- for item in workdir_files -%}
         {%- assign level = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
-        {%- if site_lang != lang -%}
-            {%- assign level = level | minus: 1 -%}
-        {%- endif -%}
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
-        <li class="toctree-l{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
-            <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
-                {%- if item.sort and site.show_sorted != false -%}
+        <li class="toc level-{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
+            <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
+                {%- if item.sort -%}
                     {{ item.sort }}. {{ item.title | default: item.url }}
                 {%- else -%}
                     {{ item.title | default: item.url }}

data/_includes/class/addons-wrap.liquid

@@ -0,0 +1,26 @@
+<div class="addons-wrap d-flex flex-column overflow-y-auto">
+    <div class="status d-flex flex-justify-between p-2">
+        <div class="title p-1">
+            <i class="fa fa-book"></i> {{ site.title }}
+        </div>
+        <div class="branch p-1">
+            <span class="name">
+                {{ docs.source.branch }}
+            </span>
+            <i class="fa fa-caret-down"></i>
+        </div>
+    </div>
+    <div class="addons d-flex flex-column height-full p-2 d-none">
+        {%- assign items = "github, analytics" | split: ", " -%}
+        {% for item in items -%}
+            {% include addons/{{ item }}.liquid %}
+        {% endfor -%}
+        <hr>
+        <div class="generator f6 pb-2">
+            Built with
+            <a href="https://github.com/rundocs/jekyll-rtd-theme" target="_blank" title="{% if site.remote_theme %}remote{% endif %} theme v{{ version }}">jekyll-rtd-theme</a>
+            provided by
+            <a href="https://rundocs.io" target="_blank">RunDocs</a>
+        </div>
+    </div>
+</div>

data/_includes/class/content-wrap.liquid

@@ -0,0 +1,20 @@
+<div class="content-wrap">
+    <div class="header d-flex flex-justify-between p-2 hide-lg hide-xl" aria-label="top navigation">
+        <button id="toggle" class="btn-octicon p-2 m-0 text-white" type="button">
+            <i class="fa fa-bars"></i>
+        </button>
+        <div class="title flex-1 d-flex flex-justify-center">
+            <a class="h4 no-underline py-1 px-2 rounded-1" href="{{ site.baseurl }}/">{{ site.title }}</a>
+        </div>
+    </div>
+    <div class="content p-3 p-sm-5">
+        {% include class/_breadcrumbs.liquid %}
+        <hr>
+        <div role="main" itemscope="itemscope" itemtype="http://schema.org/Article">
+            <div class="markdown-body" itemprop="articleBody">
+                {{ content }}
+            </div>
+        </div>
+        {% include class/_footer.liquid %}
+    </div>
+</div>

data/_includes/class/sidebar-wrap.liquid

@@ -0,0 +1,18 @@
+<div class="sidebar-wrap overflow-hidden">
+    <div class="sidebar height-full overflow-y-scroll overflow-x-hidden">
+        <div class="header d-flex flex-column p-3 text-center">
+            <div class="title pb-1">
+                <a class="h4 no-underline py-1 px-2 rounded-1" href="{{ site.baseurl }}/" title="{{ site.description }}">
+                    <i class="fa fa-home"></i> {{ site.title }}
+                </a>
+            </div>
+            <span class="version">{{ docs.latest_release.name }}</span>
+            <form class="search pt-2" action="{{ site.baseurl }}/search.html" method="get" autocomplete="off">
+                <input class="form-control input-block input-sm" type="text" name="q" placeholder="{{ __.search_docs | default: 'Search docs...' }}">
+            </form>
+        </div>
+        <div class="toctree py-2" data-spy="affix" role="navigation" aria-label="main navigation">
+            {% include class/_toctree.liquid %}
+        </div>
+    </div>
+</div>

data/_includes/extend/list.liquid

@@ -6,10 +6,10 @@
 {%- 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 }}]({{ dir.url | relative_url }})
+{% include reset/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
 
 {%- for item in workdir_files %}
-{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
+{% include reset/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}