jekyll-rtd-theme 1.1.3 → 2.0.0.pre.beta

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 17d21728bc57e4cf176a94b347ec1fa282bc3330a2fb1fafd4fae290a81c6f9a
-  data.tar.gz: 5b7a0c810f57c8c819e5eb204e05fb9a364c7ab917b8a261c3764b060901cac1
+  metadata.gz: 15185d69e5df3312de8226fdf843da12d6f1cbc754a0b439c0be998be05fe524
+  data.tar.gz: ede7f10389e609983db0b3429ad717366016205c4c19447fe2db68056596d7b1
 SHA512:
-  metadata.gz: 25d5137a9c12bfcae20f06eccf5a63f6468be384a7e8e3d2449da2d6a042a0f57a4aef8e5238ff69328103ae85328b5f5382360de935ae712c3b2ad2082777b7
-  data.tar.gz: c98a582a2bf2f770e4d167242983832fdb3443a74d7428deee6db8cf809f04dacb8b24862e439e25ffff83cd34035ff0283a56017419312797a3b99488d15c44
+  metadata.gz: 1dc680274eb05e270130ec057f902794f53b622af56dfe222d194d53d0fc90e3598c16d52c0b7cf84b71f53406d81fd480be150f06c54ee3228a9fbafae49037
+  data.tar.gz: 611d1d5a0752e19bb708b55f3f878a1747f447e5348f7b8b98265befe6af025482275b5babfe042e7e7d21cda4140d6a900208fae9ba0f2fe2287a8a6553e70d

data/README.md

@@ -1,23 +1,20 @@
 # 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)][repository]
+[![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]
 
-<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 documentation theme for open source projects
 
 ## 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
@@ -27,10 +24,17 @@ You can [generate](https://github.com/rundocs/starter-slim/generate) with the sa
 - Just need one file `_config.yml` to configure site
 
 ## Documents
-For full documentation, please refer to [rundocs.io](https://rundocs.io/), You can also view [the theme related tests documentation](https://rundocs.github.io/jekyll-rtd-theme)
 
-## License
-The theme is available as open source under the terms of the [MIT License](https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE).
+For full documentation, please refer to our website ([rundocs.io](https://rundocs.io/)) for details
+
+### 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)
+
+## 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

data/_includes/addons/analytics.liquid

@@ -1,8 +1,11 @@
 <dl>
-    <dt>{{ __statistics }}</dt>
+    <dt>{{ site.data.translate.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>
+            {{ site.data.translate.total_visits | default: "Total visits" }}:
+            <span id="counter">
+                <span class="progress"></span>
+            </span>
         </a>
     </dd>
 </dl>

data/_includes/addons/github.liquid

@@ -1,6 +1,18 @@
 <dl>
-    <dt>{{ __github }}</dt>
-    <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-    <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-    <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
+    <dt>{{ site.data.translate.github | default: "GitHub" }}</dt>
+    <dd>
+        <a href="{{ site.github.repository_url }}">
+            <i class="fa fa-github"></i> {{ site.data.translate.homepage | default: "HomePage" }}
+        </a>
+    </dd>
+    <dd>
+        <a href="{{ site.github.issues_url }}">
+            <i class="fa fa-question-circle-o"></i> {{ site.data.translate.issues | default: "Issues" }}
+        </a>
+    </dd>
+    <dd>
+        <a href="{{ site.github.zip_url }}">
+            <i class="fa fa-download"></i> {{ site.data.translate.download | default: "Download" }}
+        </a>
+    </dd>
 </dl>

data/_includes/assets/sw.caches.js

@@ -0,0 +1,43 @@
+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);
+          }
+        })
+      );
+    })
+  );
+});
+
+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/breadcrumbs.liquid

@@ -1,43 +1,27 @@
-<div role="navigation" aria-label="breadcrumbs navigation">
-    <ul class="wy-breadcrumbs">
-        <li>
-            <a href="{{ site.baseurl }}/" class="icon icon-home"></a><i class="fa fa-angle-double-right"></i>
+<div class="navigation-top d-flex flex-justify-between">
+    <ul class="breadcrumb" role="navigation" aria-label="breadcrumbs navigation">
+        <li class="breadcrumb-item">
+            <a href="{{ site.baseurl }}/" title="{{ site.github.source.branch }}"><i class="fa fa-home"></i></a>
         </li>
         {%- case page.url -%}
-            {%- when "/search.html" %}
-                <li>{{ __search }}</li>
-            {%- when "/404.html" %}
-                <li>{{ __404 }}</li>
+            {%- when "/search.html" -%}
+                <li class="breadcrumb-item" aria-current="page">{{ site.data.translate.search | default: "Search" }}</li>
+            {%- when "/404.html" -%}
+                <li class="breadcrumb-item" aria-current="page">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 %}
-                        <li>{{ page.title }}</li>
-                    {%- else -%}
-                        {%- capture href -%}
-                            {{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block | append: "/" }}{% endfor %}
-                        {%- endcapture %}
-                        <li>
-                            <a href="{{ href }}">
-                                {%- if block == lang -%}
-                                    {{ block }}
-                                {%- else -%}
-                                    {{ block | capitalize }}
-                                {%- endif -%}
-                            </a><i class="fa fa-angle-double-right"></i>
-                        </li>
-                    {%- endif -%}
+                {%- for block in blocks -%}
+                    <li class="breadcrumb-item" {% if forloop.last %}aria-current{% 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 %}
-        {%- if site.edit and site.github_metadata != false -%}
-            <li class="wy-breadcrumbs-aside">
-                <a href="{{ github_edit_link }}" class="fa fa-edit" target="_blank"></a>
-            </li>
-        {%- endif -%}
+        {%- endcase -%}
     </ul>
-    <hr>
+    <a class="edit" href="{% github_edit_link %}" title="{{ site.data.translate.edit | default: 'Edit on GitHub'}}" target="_blank">
+        <i class="fa fa-edit"></i>
+    </a>
 </div>

data/_includes/extend/toctree.liquid

@@ -2,15 +2,12 @@
 
 {% comment %} display the directory name {% endcomment %}
 {%- assign dir = site_pages | where: "url", workdir | first -%}
-{%- if site_lang != lang -%}
-    {% comment %} current in language directory (level-1) {% endcomment %}
-    {%- assign workdir_level = workdir_level | minus: 1 -%}
-{%- endif -%}
+
 {%- if workdir_level == 2 %}
     {% comment %} display the root sub-directory as "p.caption" {% endcomment %}
-    <p class="caption"><span class="caption-text">{{ dir.title | default: dir.url }}</span></p>
+    <p class="caption text-uppercase no-wrap px-2 mb-0">{{ dir.title | default: dir.url }}</p>
 {%- else %}
-    <a class="reference internal" href="{{ dir.url | relative_url }}">{{ dir.title | default: dir.url }}</a>
+    <a class="d-flex" href="{{ dir.url | relative_url }}">{{ dir.title | default: dir.url }}</a>
 {%- endif -%}
 
 <ul>
@@ -20,12 +17,9 @@
         {%- capture current -%}
             {%- if page.url == item.url %}current{% endif -%}
         {%- endcapture %}
-        {%- if site_lang != lang -%}
-            {%- assign level = level | minus: 1 -%}
-        {%- endif -%}
 
-        <li class="toctree-l{{ level }} {{ current }}">
-            <a class="reference internal {{ current }}" href="{{ item.url | relative_url }}">
+        <li class="toc level-{{ level }} {{ current }}" data-sort="{{ item.sort }}" data-level="{{ level }}">
+            <a class="d-flex {{ current }}" href="{{ item.url | relative_url }}">
                 {%- if item.sort and site.show_sorted != false -%}
                     {{ item.sort }}. {{ item.title | default: item.url }}
                 {%- else -%}
@@ -38,9 +32,6 @@
     {% comment %} list dirs {% endcomment %}
     {%- for workdir in workdir_dirs -%}
         {%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
-        {%- if site_lang != lang -%}
-            {%- assign level = level | minus: 1 -%}
-        {%- endif -%}
-        <li class="toctree-l{{ level }}">{% include extend/toctree.liquid %}</li>
+        <li class="toc level-{{ level }}">{% include extend/toctree.liquid %}</li>
     {%- endfor -%}
 </ul>

data/_includes/footer.liquid

@@ -1,37 +1,36 @@
-<footer>
+{% comment %} prev and next {% endcomment %}
+{%- if page.url != "/search.html" and page.url != "/404.html" -%}
     {%- if next or prev -%}
-        <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
-            {%- if next -%}
-                <a href="{{ next.url | relative_url }}" class="btn btn-neutral float-right" title="{{ next.title }}" accesskey="n" rel="next">
-                    {{- __next }} <span class="fa fa-arrow-circle-right"></span>
-                </a>
-            {%- endif -%}
-            {%- if prev -%}
-                <a href="{{ prev.url | relative_url }}" class="btn btn-neutral  float-left" title="{{ prev.title }}" accesskey="p" rel="prev">
-                    <span class="fa fa-arrow-circle-left"></span> {{ __previous -}}
-                </a>
-            {%- endif -%}
-        </div>
-    {%- endif -%}
-    <hr>
-    {%- if site.copyright -%}
-        <div role="contentinfo" class="copyright">
-            <p>
-                <i class="fa fa-copyright"></i> {{ __copyright }}
-                {% if site.copyright.since -%}
-                    {{ site.copyright.since | append: "-" }}
+        <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> {{ site.data.translate.previous | default: "Previous" }}
+                    </a>
                 {%- endif -%}
-                {{ site.time | date: "%Y" }},
-                {{ author }}
-                {% if site.copyright.revision and site.github_metadata != false -%}
-                    <span class="commit">
-                        {{ __revision }} <code>{{ commit }}</code>
-                    </span>
+            </div>
+            <div class="next">
+                {%- if next -%}
+                    <a href="{{ next.url | relative_url }}" class="btn" title="{{ next.title }}" accesskey="n" rel="next">
+                        {{ site.data.translate.next | default: "Next" }} <i class="fa fa-arrow-circle-right"></i>
+                    </a>
                 {%- endif -%}
-            </p>
+            </div>
         </div>
     {%- endif -%}
-    <div role="contentinfo" class="copyright rundocs">
-        <p>Powered by <a href="https://rundocs.io">rundocs.io</a> using the jekyll docs theme <a href="https://rundocs.github.io/jekyll-rtd-theme">jekyll-rtd-theme</a></p>
-    </div>
-</footer>
+{%- endif -%}
+
+<hr>
+
+<div class="copyright text-center text-gray" role="contentinfo">
+    <i class="fa fa-copyright"></i>
+    {%- if site.rundocs.since %}{{ site.rundocs.since }}-{% endif -%}
+    {{- site.time | date: "%Y" }},
+    <a class="text-gray" href="{{ site.github.owner_url }}" target="_blank">
+        {{ site.github.owner_name }}
+    </a>
+    {{ site.data.translate.revision | default: "Revision" }}
+    <a class="text-gray" href="{{ site.github.repository_url }}/commit/{{ site.github.build_revision }}" title="{{ site.github.build_revision }}" target="_blank">
+        {{ site.github.build_revision | slice: 0, 7 }}
+    </a>
+</div>

data/_includes/reset/defaults.liquid

@@ -1,17 +1,9 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign version = "1.1.3" -%}
-{%- assign addons = "github, i18n, plugins, analytics" | split: ", " -%}
+{%- assign version = "2.0.0-beta" -%}
 
 {%- assign schema_date = page.date | default: site.time | date_to_xmlschema -%}
 {%- assign schema_modi = site.time | date_to_xmlschema -%}
-{%- assign schema_surl = page.url | absolute_url | replace: 'http://', 'https://' | xml_escape -%}
-
-{% comment %} scss {% endcomment %}
-{%- capture site_scss -%}
-    @import "jekyll-rtd-theme.scss";
-    {% if site.fluid %}@import "fluid.scss";{% endif %}
-    {% include assets/custom.scss %} {{ site.scss }}
-{%- endcapture -%}
+{%- assign schema_surl = page.url | absolute_url | xml_escape -%}
 
 {% comment %} cdn {% endcomment %}
 {%- if site.debug -%}
@@ -20,28 +12,7 @@
     {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
 {%- endif -%}
 
-{% comment %} github-metadata {% endcomment %}
-{%- if site.github_metadata != false -%}
-    {%- 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 -%}
-{%- else -%}
-    {%- assign author = site.author -%}
-    {%- assign branch = "" -%}
-    {%- assign commit = "" -%}
-    {%- assign repository_url = "" -%}
-    {%- assign issues_url = "" -%}
-    {%- assign zip_url = "" -%}
-    {%- assign github_edit_link = "" -%}
-    {%- assign addons = "i18n, plugins, analytics" | split: ", " -%}
-{%- endif -%}
-
 {%- include reset/site_pages.liquid %}
-{%- include reset/i18n.liquid -%}
 
 {% comment %} title {% endcomment %}
 {%- case page.url -%}
@@ -58,11 +29,8 @@
 {% 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">' -%}
+    | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}
+
 
 {% comment %} prev and next {% endcomment %}
 {%- assign workdir_files = site_files | where_exp: "item", "item.dir == page.dir" -%}

data/_includes/reset/workdir.liquid

@@ -1,13 +1,6 @@
 {% 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 +12,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/safe/shortcodes.liquid

@@ -0,0 +1,9 @@
+{%- capture safe_list -%}
+mermaid
+note
+tip
+warning
+danger
+{%- endcapture -%}
+
+{%- assign shortcodes = safe_list | split: " " -%}

data/_includes/shortcodes/danger.liquid

@@ -0,0 +1,7 @@
+<div class="admonition danger">
+    <p class="admonition-title" ui="danger">
+        <i class="fas fa-exclamation-circle"></i>
+        <span class="progress"></span>
+    </p>
+    {{ codes | markdownify | strip_newlines -}}
+</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,7 @@
+<div class="admonition note">
+    <p class="admonition-title" ui="note">
+        <i class="fas fa-exclamation-circle"></i>
+        <span class="progress"></span>
+    </p>
+    {{ codes | markdownify | strip_newlines -}}
+</div>