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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15185d69e5df3312de8226fdf843da12d6f1cbc754a0b439c0be998be05fe524
-  data.tar.gz: ede7f10389e609983db0b3429ad717366016205c4c19447fe2db68056596d7b1
+  metadata.gz: 71e0be728a36e78ef8a38db4242292a0981347013258726fb82074c3d38fdc0d
+  data.tar.gz: e41c8381aa8cf0af5780449b0567f222d3a8959a00c5a73aa51daf028f99e1c7
 SHA512:
-  metadata.gz: 1dc680274eb05e270130ec057f902794f53b622af56dfe222d194d53d0fc90e3598c16d52c0b7cf84b71f53406d81fd480be150f06c54ee3228a9fbafae49037
-  data.tar.gz: 611d1d5a0752e19bb708b55f3f878a1747f447e5348f7b8b98265befe6af025482275b5babfe042e7e7d21cda4140d6a900208fae9ba0f2fe2287a8a6553e70d
+  metadata.gz: ed35e6eff3b3b0ab73924527a16f52adea7f7ba95845f51e43def520b8136d3bc9c88594921a7b0b93875c75a0aa9c1b69efb3bba18e431ca344aac1c5574726
+  data.tar.gz: 40b26d3027d9f8f379a284cc3025c51c4740346921439aec81d4d87df114b633db7644badf7cc7ef2f90bb307aa52beb326495175ef797a0804da6ad78b0ce07

data/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020 RunDocs
+Copyright (c) 2020 RunDocs & contributors
 
 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,9 +1,23 @@
 # jekyll-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]
+![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=v2)
+![jsDelivr](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)
 
-Opinionated github flavored documentation theme for open source projects
+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
 
@@ -13,31 +27,63 @@ 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
+## Options
+
+```yml
+title: Your awesome title
+lang: # default: en
+description: Write an awesome description for your new site here
+
+readme_index:
+  with_frontmatter: true
+
+## 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:
 
-- 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)
+# 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
+```
+
+## Writing
+
+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

data/_includes/addons/analytics.liquid

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

data/_includes/addons/github.liquid

@@ -1,18 +1,21 @@
 <dl>
-    <dt>{{ site.data.translate.github | default: "GitHub" }}</dt>
+    <dt>{{ __.github | default: "GitHub" }}</dt>
     <dd>
-        <a href="{{ site.github.repository_url }}">
-            <i class="fa fa-github"></i> {{ site.data.translate.homepage | default: "HomePage" }}
+        <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="{{ site.github.issues_url }}">
-            <i class="fa fa-question-circle-o"></i> {{ site.data.translate.issues | default: "Issues" }}
+        <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="{{ site.github.zip_url }}">
-            <i class="fa fa-download"></i> {{ site.data.translate.download | default: "Download" }}
+        <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,11 +1,11 @@
 self.addEventListener("activate", function (event) {
-  let cacheWhitelist = ["rundocs-{{ version }}"];
+  const current = ["rundocs-{{ version }}"];
 
   event.waitUntil(
     caches.keys().then(function (keyList) {
       return Promise.all(
         keyList.map(function (key) {
-          if (cacheWhitelist.indexOf(key) === -1) {
+          if (current.indexOf(key) === -1) {
             return caches.delete(key);
           }
         })
@@ -15,11 +15,7 @@ self.addEventListener("activate", function (event) {
 });
 
 self.addEventListener("fetch", function (e) {
-  if (
-    /^https:\/\/cdn\.jsdelivr\.net\/gh\/rundocs\/jekyll-rtd-theme@.+/.exec(
-      e.request.url
-    )
-  ) {
+  if (e.request.url.match("rundocs/jekyll-rtd-theme@{{ version }}")) {
     e.respondWith(
       caches.match(e.request).then(function (resp) {
         if (resp !== undefined) {

data/_includes/{breadcrumbs.liquid → class/_breadcrumbs.liquid}

@@ -1,17 +1,23 @@
 <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>
+            <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">{{ site.data.translate.search | default: "Search" }}</li>
+                <li class="breadcrumb-item" aria-current="page">
+                    {{ __.search | default: "Search" }}
+                </li>
             {%- when "/404.html" -%}
-                <li class="breadcrumb-item" aria-current="page">404</li>
+                <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 %}>
+                    <li class="breadcrumb-item" {% if forloop.last %}aria-current="page"{% endif %}>
                         {%- if forloop.last -%}
                             {{ page.name }}
                         {%- else -%}
@@ -21,7 +27,7 @@
                 {%- endfor -%}
         {%- endcase -%}
     </ul>
-    <a class="edit" href="{% github_edit_link %}" title="{{ site.data.translate.edit | default: 'Edit on GitHub'}}" target="_blank">
+    <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/{footer.liquid → class/_footer.liquid}

@@ -5,14 +5,14 @@
             <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" }}
+                        <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">
-                        {{ site.data.translate.next | default: "Next" }} <i class="fa fa-arrow-circle-right"></i>
+                        {{ __.next | default: "Next" }} <i class="fa fa-arrow-circle-right"></i>
                     </a>
                 {%- endif -%}
             </div>
@@ -24,13 +24,18 @@
 
 <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 }}
+    {%- 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>
-    {{ 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 }}
+    {{ __.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}

@@ -8,11 +8,11 @@
             {%- 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 {{ current }}" href="{{ item.url | relative_url }}">
-                {%- if item.sort and site.show_sorted != false -%}
-                    {{ item.sort }}. {{ item.title | default: item.url }}
+            <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
+                {%- if item.sort -%}
+                    {{ item.sort }}. {{ item.title | default: item.name }}
                 {%- else -%}
-                    {{ item.title | default: item.url }}
+                    {{ item.title | default: item.name }}
                 {%- endif -%}
             </a>
         </li>

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.name }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}

data/_includes/extend/toctree.liquid

@@ -5,9 +5,13 @@
 
 {%- if workdir_level == 2 %}
     {% comment %} display the root sub-directory as "p.caption" {% endcomment %}
-    <p class="caption text-uppercase no-wrap px-2 mb-0">{{ dir.title | default: dir.url }}</p>
+    <a class="caption d-block text-uppercase no-wrap px-2 py-0" href="{{ dir.url | relative_url }}">
+        {{ dir.title | default: dir.url }}
+    </a>
 {%- else %}
-    <a class="d-flex" 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>
@@ -19,11 +23,11 @@
         {%- endcapture %}
 
         <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 }}
+            <a class="d-flex flex-items-baseline {{ current }}" href="{{ item.url | relative_url }}">
+                {%- if item.sort -%}
+                    {{ item.sort }}. {{ item.title | default: item.name }}
                 {%- else -%}
-                    {{ item.title | default: item.url }}
+                    {{ item.title | default: item.name }}
                 {%- endif -%}
             </a>
         </li>

data/_includes/list.liquid

@@ -2,7 +2,7 @@
 {%- include reset/workdir.liquid workdir=page.dir -%}
 
 {%- for item in workdir_files %}
-- [{{ item.title | default: item.url }}]({{ item.url | relative_url }})
+- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
 {%- endfor -%}
 
 {%- if include.all -%}

data/_includes/node/links.liquid

@@ -0,0 +1,24 @@
+{%- comment %} dns-prefetch {% endcomment %}
+<link rel="dns-prefetch" href="https://rundocs-analytics.glitch.me">
+<link rel="dns-prefetch" href="https://cdn.jsdelivr.net">
+
+{%- 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">
+
+{%- if custom_scss.size > 0 -%}
+    <style>{{ custom_scss | scssify | strip_newlines }}</style>
+{%- endif -%}
+
+{% comment %} icon {% endcomment %}
+<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">