jekyll-rtd-theme 2.0.0 → 2.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: c7edf3a08d7fcdb1e47fc9908c848c566c7cf6e9d3cdd40ec5460f7b2f6dbc76
-  data.tar.gz: ee4a7e4bfffc1c4474c7c66603d8a99fae38700be2cf73d902659a7fc7846fb2
+  metadata.gz: de113ba870917abb9b9ebe794243fee857482bfd8f537f69725e3b7485c9cb08
+  data.tar.gz: 55860f67065f64c2706311774cefe8f4b5c586275252940ec28c954874ecec38
 SHA512:
-  metadata.gz: 38a9a3d37323615eae67b06231f384a3d872ea85face47c7fe0ebe26043adde70fb2ab209c458a50d08f41acbe1cbd4d3edabe79c2fac82600d5ae6017d41a3c
-  data.tar.gz: dd8344fcf25d95be4f321a0627c90c012c6370d24ede3f96234818fc5857f673960c10753cf16215c007784d60ff81d91ab09ba6b3c525fcb2668804bab54296
+  metadata.gz: 6383d8a918ca354d8ba5000b3a7eb9869f3ec24396230fa823ca818bfc7c173d08fc614ce5b84da57ff885df2ad1cd653d098aa4bd4ed786578188c651b15487
+  data.tar.gz: 7f65f1bdbbf80c1a79cc0f368155ff4bf9ec8c432982e47c2c7019e5487f1c689907887d5f62444327ee5c0c235757a6b6d1628e16485b70cd0f9a13a1c85f21

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)
+![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 standard document theme for open source projects, with few options, just use it!
+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
 
@@ -17,21 +31,16 @@ You can [generate](https://github.com/rundocs/starter-slim/generate) with the sa
 
 ```yml
 title: Your awesome title
-lang: en
+lang: # default: en
 description: Write an awesome description for your new site here
 
-# plugin options
 readme_index:
   with_frontmatter: true
 
-
-# optional settings
+## optional settings ##
 meta:
   key1: value1
   key2: value2
-  .
-  .
-  .
 
 google:
   gtag:
@@ -39,17 +48,39 @@ google:
 
 mermaid:
   custom: # mermaid link
-  initialize: # mermaid options
-
-
-# optional plugins
+  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
+## Writing
 
 Document writing specifications, please refer to [rundocs.io](https://rundocs.io) for details
 

data/_includes/addons/analytics.liquid

@@ -1,10 +1,10 @@
 <dl>
     <dt>{{ __.statistics | default: "Statistics" }}</dt>
     <dd>
-        <a href="https://github.com/rundocs/analytics" target="_blank">
+        <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/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/class/_breadcrumbs.liquid

@@ -27,7 +27,7 @@
                 {%- endfor -%}
         {%- endcase -%}
     </ul>
-    <a class="edit" href="{% github_edit_link %}" title="{{ __.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/class/_toctree.liquid

@@ -1,4 +1,4 @@
-{%- include rest/workdir.liquid %}
+{%- include reset/workdir.liquid %}
 
 {% comment %} list the root files {% endcomment %}
 <ul>
@@ -10,9 +10,9 @@
         <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 }}
+                    {{ item.sort }}. {{ item.title | default: item.name }}
                 {%- else -%}
-                    {{ item.title | default: item.url }}
+                    {{ item.title | default: item.name }}
                 {%- endif -%}
             </a>
         </li>

data/_includes/class/content-wrap.liquid

@@ -3,8 +3,8 @@
         <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 no-underline d-flex flex-justify-center">
-            <a class="h4 py-1 px-2 rounded-1" href="{{ site.baseurl }}/">{{ site.title }}</a>
+        <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">

data/_includes/class/sidebar-wrap.liquid

@@ -1,12 +1,12 @@
 <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 no-underline">
-                <a class="h4 py-1 px-2 rounded-1" href="{{ site.baseurl }}/" title="{{ site.description }}">
+            <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 text-gray">{{ docs.latest_release.name }}</span>
+            <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>

data/_includes/extend/list.liquid

@@ -1,15 +1,15 @@
-{%- include rest/site_pages.liquid -%}
-{%- include rest/workdir.liquid -%}
+{%- include reset/site_pages.liquid -%}
+{%- include reset/workdir.liquid -%}
 
 {%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
 {%- assign size = workdir_level | minus: base -%}
 {%- assign size_p1 = size | plus: 1 -%}
 
 {%- assign dir = site_pages | where: "url", workdir | first %}
-{% include rest/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 rest/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

@@ -1,11 +1,11 @@
-{%- include rest/workdir.liquid %}
+{%- include reset/workdir.liquid %}
 
 {% 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 %}
-    <a class="caption d-block text-uppercase no-wrap px-2" href="{{ dir.url | relative_url }}">
+    <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 %}
@@ -25,9 +25,9 @@
         <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 }}
+                    {{ 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

@@ -1,8 +1,8 @@
-{%- include rest/site_pages.liquid -%}
-{%- include rest/workdir.liquid workdir=page.dir -%}
+{%- include reset/site_pages.liquid -%}
+{%- 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/{head → node}/links.liquid

@@ -1,3 +1,7 @@
+{%- 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 }}">
 
@@ -12,5 +16,9 @@
 {% 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">

data/_includes/{head → node}/script.liquid

@@ -1,11 +1,9 @@
 <script>
     window.ui = {
+        collect: new URL("{{ collect }}?v={{ version }}&lang={{ lang }}"),
         title: "{{ site.title }}",
-        lang: "{{ site.lang }}",
-        version: "{{ version }}",
         baseurl: "{{ site.baseurl }}",
         i18n: {
-            search_docs: "{{ __.search_docs | default: 'Search Docs' }}",
             search_results: "{{ __.search_results | default: 'Search Results' }}",
             search_results_found: "{{ __.search_results_found | default: 'Search finished, found # page(s) matching the search query.' }}",
             search_results_not_found: "{{ __.search_results_not_found | default: 'Your search did not match any documents, please make sure that all characters are spelled correctly!' }}"
@@ -13,4 +11,9 @@
     };
 </script>
 <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+
+{%- if custom_script.size > 0 -%}
+    <script>{{ custom_script }}</script>
+{%- endif -%}
+
 <script src="{{ cdn }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/reset/content.liquid

@@ -0,0 +1,5 @@
+{%- assign content = content
+    | replace: "’", "'"
+    | replace: "“", '"'
+    | replace: "”", '"'
+    | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}

data/_includes/reset/defaults.liquid

@@ -0,0 +1,11 @@
+{%- include reset/site_pages.liquid -%}
+{%- include reset/i18n.liquid -%}
+{%- include reset/version.liquid -%}
+
+{%- include reset/variables.liquid -%}
+
+{%- include reset/content.liquid -%}
+
+{%- include reset/navigation.liquid -%}
+{%- include reset/title.liquid -%}
+{%- include reset/description.liquid -%}

data/_includes/reset/description.liquid

@@ -0,0 +1,6 @@
+{%- assign description = content
+    | strip_html
+    | split: " "
+    | join: " "
+    | escape
+    | truncate: 150 -%}

data/_includes/reset/navigation.liquid

@@ -0,0 +1,20 @@
+{%- include reset/workdir.liquid workdir=page.dir -%}
+
+{% comment %} prev and next {% endcomment %}
+{%- 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 -%}
+        {%- assign next = item -%}
+    {%- endif %}
+{%- endfor -%}

data/_includes/reset/title.liquid

@@ -0,0 +1,18 @@
+{%- 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.name
+            | append: " · "
+            | append: site.title | truncate: 110 -%}
+{%- endcase -%}

data/_includes/reset/variables.liquid

@@ -0,0 +1,31 @@
+{%- comment %} variables {% endcomment -%}
+{%- assign collect = "https://rundocs-analytics.glitch.me/collect" -%}
+{%- 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 %} 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 %} custom {% endcomment %}
+{%- capture custom_scss -%}
+    {%- include assets/custom.scss -%} {{- site.scss -}}
+{%- endcapture -%}
+
+{%- capture custom_script -%}
+    {%- include assets/custom.js -%} {{- site.script -}}
+{%- endcapture -%}

data/_includes/reset/version.liquid

@@ -0,0 +1 @@
+{%- assign version = "2.0.5" -%}

data/_includes/shortcodes/danger.liquid

@@ -1,9 +1,9 @@
-<div class="admonition danger box-shadow mb-3">
+<div class="admonition danger mb-4">
     <div class="title px-2 py-1">
         <i class="fa fa-exclamation-circle"></i>
         {{ __.danger | default: "Danger" }}
     </div>
-    <div class="content p-2">
+    <div class="content px-2 py-3">
         {{ codes | markdownify | strip_newlines -}}
     </div>
 </div>