jekyll-rtd-theme 2.0.5 → 2.0.10

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: de113ba870917abb9b9ebe794243fee857482bfd8f537f69725e3b7485c9cb08
-  data.tar.gz: 55860f67065f64c2706311774cefe8f4b5c586275252940ec28c954874ecec38
+  metadata.gz: 12353811eacbf4378796c0318fbaf537b7fdac63f737395d529c53ce129d4190
+  data.tar.gz: e70e90269735276e5514d097966cf6a0ef20b7381a44d272d1e29d41cb3c943e
 SHA512:
-  metadata.gz: 6383d8a918ca354d8ba5000b3a7eb9869f3ec24396230fa823ca818bfc7c173d08fc614ce5b84da57ff885df2ad1cd653d098aa4bd4ed786578188c651b15487
-  data.tar.gz: 7f65f1bdbbf80c1a79cc0f368155ff4bf9ec8c432982e47c2c7019e5487f1c689907887d5f62444327ee5c0c235757a6b6d1628e16485b70cd0f9a13a1c85f21
+  metadata.gz: b2d2b4c98f5eb9dbd6782505259dc9f59bb1273e27e9a2a6c37f2922f4b0a6eb1470a01612303cd16f811c7f7d9d145fdff35b6c1fca1f84aaf1cf189a2e4992
+  data.tar.gz: 9f204037d08ece1891e1f5275c0d17ef00144245d5e60d2fbe1c23562e51e820502056583e1f4e44399be016c57b2e09c142cd22b10c9133ff654190967e6371

data/README.md

@@ -1,23 +1,16 @@
 # jekyll-rtd-theme
 
-![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=v2)
+![CI](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg?branch=develop)
 ![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, but everything!
+Just another documentation theme compatible with GitHub Pages
 
 ## 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
+- [github-pages](https://github.com/github/pages-gem) ([dependency versions](https://pages.github.com/versions/))
 
 ## Quick start
 
@@ -27,20 +20,43 @@ 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/)
 
+## Usage
+
+Documentation that can guide how to create with Github pages, please refer to [rundocs.io](https://rundocs.io) for details
+
+## Features
+
+- Shortcodes (Toasts card, mermaid)
+- Pages Plugins (emoji, gist, avatar, mentions)
+- Auto generate sidebar
+- [Attribute List Definitions](https://kramdown.gettalong.org/syntax.html#attribute-list-definitions) (Primer/css utilities, Font Awesome 4)
+- Service worker (caches)
+- SEO (404, robots.txt, sitemap.xml)
+- Canonical Link (Open Graph, Twitter Card, Schema data)
+
 ## Options
 
-```yml
-title: Your awesome title
-lang: # default: en
-description: Write an awesome description for your new site here
+| name          | default value        | description       |
+| ------------- | -------------------- | ----------------- |
+| `title`       | repo name            |                   |
+| `description` | repo description     |                   |
+| `url`         | user domain or cname |                   |
+| `baseurl`     | repo name            |                   |
+| `lang`        | `en`                 |                   |
+| `direction`   | `auto`               | `ltr` or `rtl`    |
+| `highlighter` | `rouge`              | Cannot be changed |
 
+```yml
+# folders sort
 readme_index:
   with_frontmatter: true
 
-## optional settings ##
 meta:
   key1: value1
   key2: value2
+  .
+  .
+  .
 
 google:
   gtag:
@@ -50,13 +66,9 @@ mermaid:
   custom: # mermaid link
   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:
@@ -65,6 +77,8 @@ translate:
   warning:
   # 404
   not_found:
+  # copyright
+  revision:
   # search
   searching:
   search:
@@ -73,17 +87,12 @@ translate:
   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

data/_includes/README.md

@@ -0,0 +1,9 @@
+# Document Statement
+
+## templates
+
+Template files for this theme
+
+## common
+
+Some common variables and code snippets are designed to be shared by multiple themes

data/_includes/common/assets/data.liquid

@@ -0,0 +1,3 @@
+{%- include common/rest/site_pages.liquid -%}
+
+{{- site_pages | jsonify -}}

data/_includes/common/assets/robots.liquid

@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: {{ "sitemap.xml" | absolute_url }}

data/_includes/common/assets/sitemap.liquid

@@ -0,0 +1,12 @@
+{%- include common/rest/site_pages.liquid -%}
+
+<?xml version="1.0" encoding="UTF-8"?>
+<urlset xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
+    {%- for page in site_pages -%}
+        <url>
+            <loc>{{ page.url | absolute_url | xml_escape }}</loc>
+            <priority>{{ page.content | size | divided_by: 2048.0 | times: 10 | ceil | divided_by: 10.0 | at_least: 0.1 | at_most: 1.0 }}</priority>
+            <lastmod>{{ site.time | date_to_xmlschema }}</lastmod>
+        </url>
+    {%- endfor %}
+</urlset>

data/_includes/{assets → common/assets}/sw.caches.js

@@ -1,5 +1,5 @@
 self.addEventListener("activate", function (event) {
-  const current = ["rundocs-{{ version }}"];
+  const current = ["{{ theme_alias }}"];
 
   event.waitUntil(
     caches.keys().then(function (keyList) {
@@ -15,7 +15,7 @@ self.addEventListener("activate", function (event) {
 });
 
 self.addEventListener("fetch", function (e) {
-  if (e.request.url.match("rundocs/jekyll-rtd-theme@{{ version }}")) {
+  if (e.request.url.match("{{ theme_alias }}")) {
     e.respondWith(
       caches.match(e.request).then(function (resp) {
         if (resp !== undefined) {
@@ -26,7 +26,7 @@ self.addEventListener("fetch", function (e) {
           })
             .then(function (resp) {
               let clone = resp.clone();
-              caches.open("rundocs-{{ version }}").then(function (cache) {
+              caches.open("{{ theme_alias }}").then(function (cache) {
                 cache.put(e.request, clone);
               });
               return resp;

data/_includes/common/core/_list.liquid

@@ -0,0 +1,15 @@
+{%- include common/rest/site_pages.liquid -%}
+{%- include common/rest/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 common/rest/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ dir.url | relative_url }})
+
+{%- for item in workdir_files %}
+{% include common/rest/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
+{%- endfor -%}
+
+{%- for workdir in workdir_dirs %}{% include common/core/_list.liquid %}{% endfor -%}

data/_includes/common/core/list.liquid

@@ -0,0 +1,10 @@
+{%- include common/rest/site_pages.liquid -%}
+{%- include common/rest/workdir.liquid workdir=page.dir -%}
+
+{%- for item in workdir_files %}
+- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
+{%- endfor -%}
+
+{%- if include.all -%}
+    {%- for workdir in workdir_dirs %}{% include common/core/_list.liquid %}{% endfor -%}
+{%- endif -%}

data/_includes/common/google_adsense.liquid

@@ -0,0 +1,3 @@
+{%- if site.google.adsense -%}
+    <script data-ad-client="{{ site.google.adsense }}" async src="https://pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script>
+{%- endif -%}

data/_includes/common/google_gtag.liquid

@@ -0,0 +1,11 @@
+{%- if site.google.gtag -%}
+    <script async src="https://www.googletagmanager.com/gtag/js?id={{ site.google.gtag }}"></script>
+    <script>
+        window.dataLayer = window.dataLayer || [];
+        function gtag() {
+            dataLayer.push(arguments);
+        }
+        gtag("js", new Date());
+        gtag("config", "{{ site.google.gtag }}");
+    </script>
+{%- endif -%}

data/_includes/common/links.liquid

@@ -0,0 +1,26 @@
+{%- comment %} dns-prefetch {% endcomment %}
+<link rel="dns-prefetch" href="https://cdn.jsdelivr.net">
+
+{%- comment %} canonical link {% endcomment -%}
+{%- if prev -%}
+    <link rel="prev" href="{{ prev.url | absolute_url }}">
+{%- endif -%}
+
+{%- if next -%}
+    <link rel="next" href="{{ next.url | absolute_url }}">
+{%- endif -%}
+
+<link rel="canonical" href="{{ schema_surl }}">
+
+{%- comment %} favicon icon {% endcomment -%}
+<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/assets/images/favicon.svg">
+{%- comment %} alternate {% endcomment -%}
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-16x16.png" sizes="16x16">
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-32x32.png" sizes="32x32">
+<link rel="icon" type="image/png" href="{{ site.baseurl }}/assets/images/favicon-96x96.png" sizes="96x96">
+
+{%- comment %} safari {% endcomment -%}
+<link rel="mask-icon" href="{{ site.baseurl }}/assets/images/favicon.svg" color="{{ theme_color }}">
+
+{%- comment %} apple-touch-icon {% endcomment -%}
+<link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/images/apple-touch-icon-300x300.jpg">

data/_includes/common/mermaid.liquid

@@ -0,0 +1,10 @@
+{%- if content contains '<code class="language-mermaid">' -%}
+    {%- if site.mermaid.custom -%}
+        <script src="{{ site.mermaid.custom }}"></script>
+    {%- else -%}
+        <script src="{{ base }}/assets/js/mermaid.min.js"></script>
+    {%- endif %}
+    <script>
+        mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
+    </script>
+{%- endif %}

data/_includes/common/metadata.liquid

@@ -0,0 +1,12 @@
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=5, user-scalable=no">
+<meta name="description" content="{{ description }}">
+<meta name="revised" content="{{ docs.build_revision }}">
+<meta name="author" content="{{ author }}">
+<meta name="generator" content="{{ generator }} v{{ version }}">
+
+{%- for meta in site.meta -%}
+    <meta name="{{ meta.first }}" content="{{ meta.last }}">
+{%- endfor -%}
+
+<meta name="theme-color" content="{{ theme_color }}">

data/_includes/common/opengraph.liquid

@@ -0,0 +1,8 @@
+<meta property="og:title" content="{{ title }}">
+<meta property="og:description" content="{{ description }}">
+<meta property="og:locale" content="{{ lang }}">
+<meta property="og:url" content="{{ schema_surl }}">
+<meta property="og:type" content="article">
+<meta property="article:author" content="{{ author }}">
+<meta property="article:published_time" content="{{ schema_date }}">
+<meta property="article:modified_time" content="{{ schema_modi }}">

data/_includes/{reset → common/rest}/content.liquid

@@ -2,4 +2,5 @@
     | replace: "’", "'"
     | replace: "“", '"'
     | replace: "”", '"'
+    | replace: "<script", '<script async'
     | replace: "highlighter-rouge", "highlighter-rouge notranslate" -%}

data/_includes/common/rest/defaults.liquid

@@ -0,0 +1,7 @@
+{%- include common/rest/site_pages.liquid -%}
+{%- include common/rest/i18n.liquid -%}
+{%- include common/rest/variables.liquid -%}
+{%- include common/rest/content.liquid -%}
+{%- include common/rest/nav.liquid -%}
+{%- include common/rest/title.liquid -%}
+{%- include common/rest/description.liquid -%}

data/_includes/{reset/navigation.liquid → common/rest/nav.liquid}

@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid workdir=page.dir -%}
+{%- include common/rest/workdir.liquid workdir=page.dir -%}
 
 {% comment %} prev and next {% endcomment %}
 {%- assign index = 0 -%}

data/_includes/{reset → common/rest}/variables.liquid

@@ -1,14 +1,24 @@
 {%- comment %} variables {% endcomment -%}
-{%- assign collect = "https://rundocs-analytics.glitch.me/collect" -%}
+{%- assign version = theme_alias | split: "@" | last -%}
 {%- 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 -%}
 
+{%- comment %} defaults {% endcomment -%}
+{%- assign direction = site.direction | default: "auto" -%}
 {%- assign lang = site.lang | default: "en" -%}
 {%- assign author = docs.owner.name | default: docs.owner_name -%}
 
+{%- capture generator -%}
+    {%- if site.remote_theme -%}
+        {{- theme_alias | split: "@" | first -}}
+    {%- else -%}
+        {{- theme_alias | split: "@" | first | split: "/" | last -}}
+    {%- endif -%}
+{%- endcapture -%}
+
 {%- comment %} schema {% endcomment -%}
 {%- assign schema_date = page.date | default: rest_created_at | date_to_xmlschema -%}
 {%- assign schema_modi = site.time | date_to_xmlschema -%}
@@ -16,16 +26,7 @@
 
 {% comment %} debug {% endcomment %}
 {%- if site.debug -%}
-    {%- assign cdn = site.baseurl -%}
+    {%- assign base = site.baseurl -%}
 {%- else -%}
-    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+    {%- assign base = "https://cdn.jsdelivr.net/gh/" | append: theme_alias -%}
 {%- 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/{node → common}/script.liquid

@@ -1,6 +1,5 @@
 <script>
     window.ui = {
-        collect: new URL("{{ collect }}?v={{ version }}&lang={{ lang }}"),
         title: "{{ site.title }}",
         baseurl: "{{ site.baseurl }}",
         i18n: {
@@ -10,10 +9,3 @@
         }
     };
 </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/common/twitter_cards.liquid

@@ -0,0 +1,6 @@
+<meta name="twitter:title" content="{{ title }}">
+<meta name="twitter:description" content="{{ description }}">
+<meta name="twitter:card" content="summary">
+<meta name="twitter:site" content="@{{ author }}">
+<meta name="twitter:url" content="{{ schema_surl }}">
+<meta name="twitter:creator" content="@{{ generator }} v{{ version }}">

data/_includes/list.liquid

@@ -1,10 +1 @@
-{%- include reset/site_pages.liquid -%}
-{%- include reset/workdir.liquid workdir=page.dir -%}
-
-{%- for item in workdir_files %}
-- [{{ item.title | default: item.name }}]({{ item.url | relative_url }})
-{%- endfor -%}
-
-{%- if include.all -%}
-    {%- for workdir in workdir_dirs %}{% include extend/list.liquid %}{% endfor -%}
-{%- endif -%}
+{%- include common/core/list.liquid -%}

data/_includes/rest/defaults.liquid

@@ -0,0 +1,2 @@
+{%- assign theme_alias = "rundocs/jekyll-rtd-theme@2.0.10" -%}
+{%- assign theme_color = "#2980b9" -%}

data/_includes/rest/script.liquid

@@ -0,0 +1,7 @@
+<script src="{{ base }}/assets/js/jquery.min.js"></script>
+
+{%- if site.script.size > 0 -%}
+    <script>{{ site.script }}</script>
+{%- endif -%}
+
+<script src="{{ base }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/rest/styles.liquid

@@ -0,0 +1,5 @@
+<link rel="stylesheet" href="{{ base }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
+
+{%- if site.scss.size > 0 -%}
+    <style>{{ site.scss | scssify | strip_newlines }}</style>
+{%- endif -%}

data/_includes/shortcodes/danger.liquid

@@ -1,6 +1,6 @@
-<div class="admonition danger mb-4">
+<div class="toasts danger mb-4">
     <div class="title px-2 py-1">
-        <i class="fa fa-exclamation-circle"></i>
+        <i class="fa fa-exclamation-triangle"></i>
         {{ __.danger | default: "Danger" }}
     </div>
     <div class="content px-2 py-3">