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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: d69e021f3df96ab3b9714d64e1d216601712e009ddb08aed35d7e7837e4ef86c
-  data.tar.gz: cf6b6baace1113759c0cffc4b1e097ae02f0369ec8d094a52ad500846aba4d8f
+  metadata.gz: 15185d69e5df3312de8226fdf843da12d6f1cbc754a0b439c0be998be05fe524
+  data.tar.gz: ede7f10389e609983db0b3429ad717366016205c4c19447fe2db68056596d7b1
 SHA512:
-  metadata.gz: dc8d4eb1046e999f051855a27c521a043786df3d5961270fa6e1841d353875e96a02d2e0c0d5d4e329e14ba2448d62ce90fb99b54cb2a93b548bb9eb1f58a01e
-  data.tar.gz: a942afc0ac6fe9511159571c5235814a3579ac7058fd5376fc57588de94a56101bd9f49080122168b710b0db35a7d482990b14a616a0db802c796bfb5cb5d72f
+  metadata.gz: 1dc680274eb05e270130ec057f902794f53b622af56dfe222d194d53d0fc90e3598c16d52c0b7cf84b71f53406d81fd480be150f06c54ee3228a9fbafae49037
+  data.tar.gz: 611d1d5a0752e19bb708b55f3f878a1747f447e5348f7b8b98265befe6af025482275b5babfe042e7e7d21cda4140d6a900208fae9ba0f2fe2287a8a6553e70d

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 RunDocs & contributors
+Copyright (c) 2020 RunDocs
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

data/README.md

@@ -1,85 +1,43 @@
 # jekyll-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)
+[![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]
 
-Opinionated github flavored standard document theme for open source projects, with few options, but everything!
-
-## What it does?
-
-This theme(`v1`) use [sphinx-rtd-theme](https://github.com/readthedocs/sphinx_rtd_theme)'s styles
-
-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
-- Native support for mermaid chart plugin
+Opinionated github flavored documentation theme for open source projects
 
 ## Quick start
 
 ```yml
-remote_theme: rundocs/jekyll-rtd-theme@v1
+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/)
 
-## Options
-
-```yml
-title: Your awesome title
-lang: # default: en
-description: Write an awesome description for your new site here
-
-readme_index:
-  with_frontmatter: true
+## Features
 
-## optional settings ##
-meta:
-  key1: value1
-  key2: value2
+- 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
 
-google:
-  gtag:
-  adsense:
+## Documents
 
-mermaid:
-  custom: # mermaid link
-  initialize: # mermaid options, default: {}
+For full documentation, please refer to our website ([rundocs.io](https://rundocs.io/)) for details
 
-# also available via file: _include/assets/custom.scss
-scss:
+### test
 
-# 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
+- 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
+[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

data/_includes/addons/analytics.liquid

@@ -1,10 +1,10 @@
 <dl>
-    <dt>{{ __.statistics | default: "Statistics" }}</dt>
+    <dt>{{ site.data.translate.statistics | default: "Statistics" }}</dt>
     <dd>
-        <a href="https://github.com/rundocs/analytics" rel="noreferrer" target="_blank">
-            {{ __.total_visits | default: "Total visits" }}:
+        <a href="https://github.com/rundocs/analytics" target="_blank">
+            {{ site.data.translate.total_visits | default: "Total visits" }}:
             <span id="counter">
-                <span class="AnimatedEllipsis"></span>
+                <span class="progress"></span>
             </span>
         </a>
     </dd>

data/_includes/addons/github.liquid

@@ -1,21 +1,18 @@
 <dl>
-    <dt>{{ __.github | default: "GitHub" }}</dt>
+    <dt>{{ site.data.translate.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 href="{{ site.github.repository_url }}">
+            <i class="fa fa-github"></i> {{ site.data.translate.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 href="{{ site.github.issues_url }}">
+            <i class="fa fa-question-circle-o"></i> {{ site.data.translate.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 href="{{ site.github.zip_url }}">
+            <i class="fa fa-download"></i> {{ site.data.translate.download | default: "Download" }}
         </a>
     </dd>
 </dl>

data/_includes/breadcrumbs.liquid

@@ -0,0 +1,27 @@
+<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 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: "/" -%}
+                {%- 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 -%}
+    </ul>
+    <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/list.liquid

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

data/_includes/extend/toctree.liquid

@@ -2,11 +2,12 @@
 
 {% comment %} display the directory name {% endcomment %}
 {%- assign dir = site_pages | where: "url", workdir | first -%}
+
 {%- 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>
@@ -17,8 +18,8 @@
             {%- 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 }}">
+        <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 -%}
@@ -31,6 +32,6 @@
     {% comment %} list dirs {% endcomment %}
     {%- for workdir in workdir_dirs -%}
         {%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
-        <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

@@ -0,0 +1,36 @@
+{% 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> {{ site.data.translate.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">
+                        {{ site.data.translate.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>
+    {%- 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,89 +1,54 @@
-{%- comment %} Copy from v2 unless content {% endcomment -%}
-
-{%- include reset/site_pages.liquid -%}
-{%- include reset/i18n.liquid -%}
-
-{%- comment %} variables {% endcomment -%}
-{%- assign version = "1.1.8" -%}
-{%- assign docs = site.github -%}
-{%- assign rest = docs.public_repositories | where: "html_url", docs.repository_url | first -%}
+{%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
+{%- assign version = "2.0.0-beta" -%}
 
-{%- assign rest_created_at = rest.created_at | default: site.time -%}
-{%- assign rest_updated_at = rest.updated_at | default: site.time -%}
+{%- 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 | xml_escape -%}
 
-{%- assign lang = site.lang | default: "en" -%}
-{%- assign author = docs.owner.name | default: docs.owner_name -%}
+{% comment %} cdn {% endcomment %}
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
 
-{%- 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 -%}
+{%- include reset/site_pages.liquid %}
 
-{%- comment %} title {% endcomment -%}
+{% comment %} title {% endcomment %}
 {%- case page.url -%}
     {%- when "/" -%}
-        {%- assign title = site.title | append: " · " | append: site.description | truncate: 110 -%}
+        {%- assign title = site.title | append: " · " | append: site.description -%}
     {%- when "/search.html" -%}
-        {%- assign title = __.search  | default: "Search" | append: " · " | append: site.title | truncate: 110 -%}
+        {%- assign title = __search   | append: " · " | append: site.title -%}
     {%- when "/404.html" -%}
-        {%- assign title = "404"      | append: " · " | append: site.title | truncate: 110 -%}
+        {%- assign title = __404      | append: " · " | append: site.title -%}
     {%- else -%}
-        {%- assign title = page.title | default: page.url | append: " · " | append: site.title | truncate: 110 -%}
+        {%- assign title = page.title | default: page.url | append: " · " | append: site.title -%}
 {%- 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: '<pre class="highlight"><code>', '<pre class="highlight">'
-    | replace: '<pre><code', '<pre'
-    | replace: "</code></pre>", "</pre>"
-    | replace: '<code class="language-plaintext', '<code class="literal'
-    | replace: "<dl>", '<dl class="definition">'
-    | replace: "<table>", '<div class="wy-table-responsive"><table class="docutils">'
-    | replace: "</table>", '</table></div>'
+    | 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 -%}
+{%- assign _index = 0 -%}
 {%- for item in workdir_files %}
     {%- if item.url == page.url %}
-        {%- assign index = forloop.index -%}
+        {%- 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 _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 -%}
+    {%- if forloop.index == _index_next and page.url != page.dir -%}
         {%- assign next = item -%}
     {%- endif %}
 {%- endfor -%}
-
-{% comment %} custom {% endcomment %}
-{%- capture custom_script -%}
-    {%- include assets/custom.js -%}
-    {{- site.script -}}
-{%- endcapture -%}
-
-{%- capture custom_scss -%}
-    @import "theme.scss";
-    {%- include assets/custom.scss -%}
-    {{- site.scss -}}
-{%- endcapture -%}

data/_includes/reset/workdir.liquid

@@ -1,3 +1,4 @@
+{% comment %} Start from the language chapter(eg: en-us) or root(/) {% endcomment %}
 {%- assign workdir = include.workdir | default: "/" -%}
 
 {%- assign workdir_level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}

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

@@ -1,6 +1,7 @@
 <div class="admonition danger">
-    <p class="admonition-title">
-        {{ __.note | default: "Note" }}
+    <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/note.liquid

@@ -1,6 +1,7 @@
 <div class="admonition note">
-    <p class="admonition-title">
-        {{ __.note | default: "Note" }}
+    <p class="admonition-title" ui="note">
+        <i class="fas fa-exclamation-circle"></i>
+        <span class="progress"></span>
     </p>
     {{ codes | markdownify | strip_newlines -}}
 </div>

data/_includes/shortcodes/tip.liquid

@@ -1,6 +1,7 @@
 <div class="admonition tip">
-    <p class="admonition-title">
-        {{ __.note | default: "Note" }}
+    <p class="admonition-title" ui="tip">
+        <i class="fas fa-exclamation-circle"></i>
+        <span class="progress"></span>
     </p>
     {{ codes | markdownify | strip_newlines -}}
 </div>

data/_includes/shortcodes/warning.liquid

@@ -1,6 +1,7 @@
 <div class="admonition warning">
-    <p class="admonition-title">
-        {{ __.note | default: "Note" }}
+    <p class="admonition-title" ui="warning">
+        <i class="fas fa-exclamation-circle"></i>
+        <span class="progress"></span>
     </p>
     {{ codes | markdownify | strip_newlines -}}
 </div>

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

@@ -7,8 +7,8 @@
         {%- 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 }}">
+        <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 -%}