jekyll-rtd-theme 2.0.4 → 2.0.9

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 8d6d71f3df6935ef96991206b6a224cf0a36ccd595d83478253bf9167dcbc758
-  data.tar.gz: 37b55ae967ea0f8437afc6124fa73a689c18fb9efb2120a071195e5f473188cd
+  metadata.gz: 5be214b02b1f5b58f306d9eb8c3719cb8f5b5e932f60c4b78c0cba345421c184
+  data.tar.gz: c5a1e392e6c24c7b0cd4131badc6e5f2c0fd36fdbf7d7ca6ded74dd753b68725
 SHA512:
-  metadata.gz: 331dca3e55068e1a8715fcaa7986c5210ff503aef4bf6279d2af43b3ddfe2f63519d4f3d1706b62155e60cf6938bc55f1a4ba8919b9cf89db5577529a69855a9
-  data.tar.gz: e7117f6baedc395c57fe17032f2884950859c7ee7693df0ff62c7a0da44dab706eee56916f54ac68886ef8ef8f54960672d246c1760b4ceaa1721ff3715a083a
+  metadata.gz: fa9bc55a6087121fad482ad587d44358649c5e701a8d522f9d37a9ce8bc34ab55fc2b987b676adb675e738ff969b71ccce718d40ae5c6075845e2a7b97736a24
+  data.tar.gz: 1577e84f5887f5f7a2e6dc63ca48cd165c4268dcafc3eecd01bf74811b7acd648a8e9cf59f8ccc029dedac8e51f084f0b0ab5f72373ce69f95f83b98095e0b9d

data/README.md

@@ -3,21 +3,14 @@
 ![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, but everything!
+Opinionated standard documentation theme, 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
+- [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:
@@ -65,6 +81,8 @@ translate:
   warning:
   # 404
   not_found:
+  # copyright
+  revision:
   # search
   searching:
   search:
@@ -73,17 +91,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/class/_breadcrumbs.liquid

@@ -1,7 +1,7 @@
 <div class="navigation-top d-flex flex-justify-between">
     <ul class="breadcrumb" role="navigation" aria-label="breadcrumbs navigation">
         <li class="breadcrumb-item">
-            <a class="no-underline" href="{{ site.baseurl }}/">
+            <a class="no-underline" href="{{ site.baseurl }}/" title="{{ docs.source.path }}">
                 <i class="fa fa-home"></i>
             </a>
         </li>

data/_includes/class/_footer.liquid

@@ -24,18 +24,31 @@
 
 <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 }}
+    <span class="time">
+        {%- 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 -%}
+    </span>
+    <a class="text-gray" href="{{ docs.owner_url }}" rel="noreferrer" 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 class="text-gray" href="{{ docs.repository_url }}/commit/{{ docs.build_revision }}" title="{{ docs.build_revision }}" rel="noreferrer" target="_blank">
+        {{- docs.build_revision | slice: 0, 7 -}}
     </a>
+    {% unless site.url contains "rundocs.io" %}
+        <br>
+        <div class="generator">
+            Built with
+            <a href="https://jekyllrb.com" rel="noreferrer" target="_blank">Jekyll</a>
+            using a
+            <a href="https://github.com/rundocs/jekyll-rtd-theme" rel="noreferrer" target="_blank" title="{% if site.remote_theme %}remote{% endif %} theme: jekyll-rtd-theme v{{ version }}">theme</a>
+            provided by
+            <a href="https://rundocs.io" rel="noreferrer" target="_blank">RunDocs</a>.
+        </div>
+    {% endunless %}
 </div>

data/_includes/class/addons-wrap.liquid

@@ -11,16 +11,17 @@
         </div>
     </div>
     <div class="addons d-flex flex-column height-full p-2 d-none">
-        {%- assign items = "github, analytics" | split: ", " -%}
+        {%- assign items = "github" | 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 class="license f6 pb-2">
+            The
+            <a href="{{ site.baseurl }}/">software</a>
+            is under the terms of
+            <a href="{{ docs.repository_url }}">{{ docs.license.name }}</a>
+            ({{ docs.license.spdx_id }}).
         </div>
     </div>
 </div>

data/_includes/node/links.liquid

@@ -14,11 +14,20 @@
 {%- endif -%}
 
 {% comment %} theme {% endcomment %}
-<link rel="stylesheet" href="{{ cdn }}/assets/css/theme{% if site.debug.dist != false %}.min{% endif %}.css">
+<link rel="stylesheet" href="{{ base }}/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">
+{% 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="#2980b9">
+
+{% comment %} apple-touch-icon {% endcomment %}
+<link rel="apple-touch-icon" href="{{ site.baseurl }}/assets/images/apple-touch-icon-300x300.jpg">

data/_includes/node/metadata.liquid

@@ -10,7 +10,7 @@
     <meta name="{{ meta.first }}" content="{{ meta.last }}">
 {% endfor -%}
 
-{% comment %} https://ogp.me {% endcomment %}
+{% comment %} Open Graph {% endcomment %}
 <meta property="og:title" content="{{ title }}">
 <meta property="og:description" content="{{ description }}">
 <meta property="og:locale" content="{{ lang }}">
@@ -19,3 +19,11 @@
 <meta property="article:author" content="{{ author }}">
 <meta property="article:published_time" content="{{ schema_date }}">
 <meta property="article:modified_time" content="{{ schema_modi }}">
+
+{% comment %} Twitter Card {% endcomment %}
+<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="@jekyll-rtd-theme v{{ version }}">

data/_includes/node/script.extension.liquid

@@ -3,7 +3,7 @@
     {%- if site.mermaid.custom -%}
         <script src="{{ site.mermaid.custom }}"></script>
     {%- else -%}
-        <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
+        <script src="{{ base }}/assets/js/mermaid.min.js"></script>
     {%- endif %}
     <script>
         mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});

data/_includes/node/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,10 @@
         }
     };
 </script>
-<script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+<script src="{{ base }}/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>
+<script src="{{ base }}/assets/js/theme{% if site.debug.dist != false %}.min{% endif %}.js"></script>

data/_includes/reset/content.liquid

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

data/_includes/reset/variables.liquid

@@ -1,11 +1,11 @@
 {%- 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 direction = site.direction | default: "auto" -%}
 {%- assign lang = site.lang | default: "en" -%}
 {%- assign author = docs.owner.name | default: docs.owner_name -%}
 
@@ -14,13 +14,6 @@
 {%- 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 -}}
@@ -29,3 +22,10 @@
 {%- capture custom_script -%}
     {%- include assets/custom.js -%} {{- site.script -}}
 {%- endcapture -%}
+
+{% comment %} debug {% endcomment %}
+{%- if site.debug -%}
+    {%- assign base = site.baseurl -%}
+{%- else -%}
+    {%- assign base = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}

data/_includes/reset/version.liquid

@@ -1 +1 @@
-{%- assign version = "2.0.4" -%}
+{%- assign version = "2.0.9" -%}

data/_includes/shortcodes/danger.liquid

@@ -1,9 +1,9 @@
-<div class="admonition danger mb-3">
+<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 p-2">
+    <div class="content px-2 py-3">
         {{ codes | markdownify | strip_newlines -}}
     </div>
 </div>

data/_includes/shortcodes/mermaid.liquid

@@ -1 +1,3 @@
-<div class="mermaid overflow-x-auto">{{ codes }}</div>
+<div class="mermaid-wrap mb-4" data-lang="{{ codes | split: ' ' | first }}">
+    <div class="mermaid overflow-x-auto p-3">{{ codes }}</div>
+</div>

data/_includes/shortcodes/note.liquid

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

data/_includes/shortcodes/tip.liquid

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

data/_includes/shortcodes/warning.liquid

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

data/_layouts/default.liquid

@@ -1,11 +1,11 @@
 ---
-layout: plugins/compress
+layout: tasks/compress
 ---
 
 {%- include reset/defaults.liquid -%}
 
 <!DOCTYPE html>
-<html lang="{{ lang }}">
+<html lang="{{ lang }}" dir="{{ direction }}">
     <head>
         {%- include node/metadata.liquid -%}
 

data/_layouts/{plugins → tasks}/compress.liquid

@@ -1,5 +1,5 @@
 ---
-layout: plugins/extension
+layout: tasks/shortcodes
 ---
 
 {%- if site.debug.compress == false -%}

data/_layouts/{plugins/extension.liquid → tasks/shortcodes.liquid}

@@ -2,7 +2,7 @@
 
 {%- assign shortcodes = "mermaid, warning, note, tip, danger" | split: ", " -%}
 
-{%- if site.debug.extension == false -%}
+{%- if site.debug.shortcodes == false -%}
     {{ content }}
 {%- else -%}
     {%- if content contains "<pre" -%}

data/_sass/_direction.scss

@@ -0,0 +1,107 @@
+html[dir="rtl"] {
+  // @primer/css/base/typography-base
+  ul,
+  ol {
+    padding-right: 0;
+  }
+
+  dd {
+    margin-right: 0;
+  }
+
+  // layout
+  .menu-sm {
+    left: unset;
+    right: -$theme-menu-width-sm;
+
+    &.shift {
+      left: unset;
+      right: 0;
+    }
+  }
+  .content-wrap {
+    &.shift {
+      left: unset;
+      right: $theme-menu-width-sm;
+    }
+  }
+
+  @include breakpoint(md) {
+    .menu-md {
+      left: unset;
+      right: 0;
+    }
+
+    .content-wrap {
+      margin-left: unset;
+      margin-right: $theme-menu-width;
+
+      &.shift {
+        left: unset;
+        right: 0;
+      }
+    }
+  }
+
+  // toctree
+  .toctree {
+    .fa {
+      margin-right: unset;
+      margin-left: 2px;
+    }
+    > ul {
+      // the first level links
+      > .toc > a {
+        padding-left: unset;
+        padding-right: $spacer-4 / 2;
+      }
+    }
+  }
+
+  // toc layout
+  .toc {
+    @for $level from 1 through 11 {
+      &.level-#{$level}.current {
+        > a {
+          padding-left: unset;
+          padding-right: $spacer-4 * ($level - 1 + 0.5);
+        }
+
+        .level-#{$level + 1} > a {
+          padding-left: unset;
+          padding-right: $spacer-4 * ($level + 0.5);
+        }
+      }
+    }
+  }
+  // markdown-body
+  .markdown-body {
+    .highlight {
+      direction: ltr;
+    }
+    blockquote {
+      border-left: none;
+      border-right: 0.25em $border-style lighten($gray-300, 5%);
+    }
+
+    ul,
+    ol {
+      padding-left: 0;
+      padding-right: 2em;
+    }
+
+    // improved checkbox
+    .task-list-item-checkbox {
+      margin-right: unset;
+      margin-left: 3px;
+    }
+  }
+
+  // font
+  .#{$fa-css-prefix}-arrow-circle-left:before {
+    content: $fa-var-arrow-circle-right;
+  }
+  .#{$fa-css-prefix}-arrow-circle-right:before {
+    content: $fa-var-arrow-circle-left;
+  }
+}