jekyll-rtd-theme 1.1.4 → 2.0.0.pre.beta1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 23a52d768800e6af7ea1d5c4c35a91cee56046bade55174bcc0eb4d31e9ed676
-  data.tar.gz: 3d005a4cb29f27c512492cccfcdc9da428303af00df3f2ba5a7f3bc3a22e5c07
+  metadata.gz: 9d5f271a444c19902ca9cef4a2a5861863fa6afa932326101d2a4d1a3db4b8d3
+  data.tar.gz: 78baf17dd546c3717a466a51862545ed22f980c935bf5b40243027f7ce98b184
 SHA512:
-  metadata.gz: 022acda52128c5ced54cb84635fd067ff26ed77c99a8bc4e50762ba40d3769104d739e82ad08f56958b802f8eed716407c7d1e094cdcec75c7e3c264791cf0a8
-  data.tar.gz: 68f91d2be6fb03d1c00b2d29c84acd297c4539478a6b1622fbf69dee85a71b91d8ea1326d98e1687b6676621bba2027e2e858602bb24f8333eaaa0a6bc7815c5
+  metadata.gz: aebf7861d009713ce800cb0fdef796ec33b53c743bcfbfd139a0589f3c7c46dfc15229bbd626946057a448a3bd4a1791c4f39278e7baf3749ac6d99c159281ff
+  data.tar.gz: '09f541286274d91918604f15439f9d4faeff580cf5a798322d2be370e6f5d85e73758c936fe5c104f35cc386d60b3e71ede3f7cdc81df9f84503d1f69b88ab26'

data/README.md

@@ -1,39 +1,56 @@
 # 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 documentation theme for open source projects, with few options, just use it!
+
+# Waiting for your contribution 2.0
 
 ## 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
-
-## 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).
-
-[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
+## Options
+
+```yml
+title: Your awesome title
+lang: en
+description: Write an awesome description for your new site here
+
+# plugin options
+readme_index:
+  with_frontmatter: true
+
+
+# optional settings
+meta:
+  key1: value1
+  key2: value2
+  .
+  .
+  .
+
+google:
+  gtag:
+  adsense:
+
+mermaid:
+  custom: # mermaid link
+  initialize: # mermaid options
+
+
+# optional plugins
+plugins:
+  - jemoji
+  - jekyll-avatar
+  - jekyll-mentions
+```
+
+## The license
+
+The theme is available as open source under the terms of the MIT License

data/_includes/assets/defaults.liquid

@@ -0,0 +1,69 @@
+{%- include assets/site_pages.liquid -%}
+{%- include assets/i18n.liquid -%}
+
+{%- comment %} variables {% endcomment -%}
+{%- assign version = "2.0.0-beta1" -%}
+{%- 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 and page.url != page.dir -%}
+        {%- assign next = item -%}
+    {%- endif %}
+{%- endfor -%}

data/_includes/assets/i18n.liquid

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

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/{reset → assets}/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/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 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{% 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'}}" 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/{extend/toctree.liquid → class/_toctree.extend.liquid}

@@ -1,16 +1,13 @@
-{%- include reset/workdir.liquid %}
+{%- include assets/workdir.liquid %}
 
 {% 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 flex-items-baseline" href="{{ dir.url | relative_url }}">{{ dir.title | default: dir.url }}</a>
 {%- endif -%}
 
 <ul>
@@ -20,13 +17,10 @@
         {%- 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 }}" data-sort="{{ item.sort }}">
-            <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 }}
@@ -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 class/_toctree.extend.liquid %}</li>
     {%- endfor -%}
 </ul>

data/_includes/class/_toctree.liquid

@@ -0,0 +1,23 @@
+{%- include assets/workdir.liquid %}
+
+{% comment %} list the root files {% endcomment %}
+<ul>
+    {%- for item in workdir_files -%}
+        {%- assign level = item.dir | append: "temp" | replace_first: "/", "" | split: "/" | size -%}
+        {%- capture current -%}
+            {%- if page.url == item.url %}current{% endif -%}
+        {%- endcapture %}
+        <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 }}
+                {%- endif -%}
+            </a>
+        </li>
+    {%- endfor %}
+</ul>
+
+{% comment %} list the root dirs {% endcomment %}
+{%- for workdir in workdir_dirs %}{% include class/_toctree.extend.liquid %}{% endfor -%}

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 class/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/addons/analytics.liquid

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

data/_includes/class/addons/github.liquid

@@ -0,0 +1,21 @@
+<dl>
+    <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>