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

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 15185d69e5df3312de8226fdf843da12d6f1cbc754a0b439c0be998be05fe524
-  data.tar.gz: ede7f10389e609983db0b3429ad717366016205c4c19447fe2db68056596d7b1
+  metadata.gz: 9d5f271a444c19902ca9cef4a2a5861863fa6afa932326101d2a4d1a3db4b8d3
+  data.tar.gz: 78baf17dd546c3717a466a51862545ed22f980c935bf5b40243027f7ce98b184
 SHA512:
-  metadata.gz: 1dc680274eb05e270130ec057f902794f53b622af56dfe222d194d53d0fc90e3598c16d52c0b7cf84b71f53406d81fd480be150f06c54ee3228a9fbafae49037
-  data.tar.gz: 611d1d5a0752e19bb708b55f3f878a1747f447e5348f7b8b98265befe6af025482275b5babfe042e7e7d21cda4140d6a900208fae9ba0f2fe2287a8a6553e70d
+  metadata.gz: aebf7861d009713ce800cb0fdef796ec33b53c743bcfbfd139a0589f3c7c46dfc15229bbd626946057a448a3bd4a1791c4f39278e7baf3749ac6d99c159281ff
+  data.tar.gz: '09f541286274d91918604f15439f9d4faeff580cf5a798322d2be370e6f5d85e73758c936fe5c104f35cc386d60b3e71ede3f7cdc81df9f84503d1f69b88ab26'

data/README.md

@@ -1,9 +1,11 @@
 # 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)
+![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 documentation theme for open source projects, with few options, just use it!
+
+# Waiting for your contribution 2.0
 
 ## Quick start
 
@@ -13,31 +15,42 @@ 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: en
+description: Write an awesome description for your new site here
+
+# plugin options
+readme_index:
+  with_frontmatter: true
 
-- 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
+# optional settings
+meta:
+  key1: value1
+  key2: value2
+  .
+  .
+  .
 
-For full documentation, please refer to our website ([rundocs.io](https://rundocs.io/)) for details
+google:
+  gtag:
+  adsense:
 
-### test
+mermaid:
+  custom: # mermaid link
+  initialize: # mermaid options
 
-- 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)
+
+# optional plugins
+plugins:
+  - jemoji
+  - jekyll-avatar
+  - jekyll-mentions
+```
 
 ## 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/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/{breadcrumbs.liquid → class/_breadcrumbs.liquid}

@@ -1,13 +1,19 @@
 <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 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 -%}
@@ -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'}}" 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/{extend/toctree.liquid → class/_toctree.extend.liquid}

@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid %}
+{%- include assets/workdir.liquid %}
 
 {% comment %} display the directory name {% endcomment %}
 {%- assign dir = site_pages | where: "url", workdir | first -%}
@@ -7,7 +7,7 @@
     {% 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>
 {%- 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,8 +19,8 @@
         {%- 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 -%}
+            <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 }}
@@ -32,6 +32,6 @@
     {% comment %} list dirs {% endcomment %}
     {%- for workdir in workdir_dirs -%}
         {%- assign level = workdir | append: "temp" | replace_first: "/", "" | split: "/" | size | minus: 2 %}
-        <li class="toc level-{{ level }}">{% include extend/toctree.liquid %}</li>
+        <li class="toc level-{{ level }}">{% include class/_toctree.extend.liquid %}</li>
     {%- endfor -%}
 </ul>

data/_includes/{toctree.liquid → class/_toctree.liquid}

@@ -1,4 +1,4 @@
-{%- include reset/workdir.liquid %}
+{%- include assets/workdir.liquid %}
 
 {% comment %} list the root files {% endcomment %}
 <ul>
@@ -8,8 +8,8 @@
             {%- 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 -%}
+            <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 }}
@@ -20,4 +20,4 @@
 </ul>
 
 {% comment %} list the root dirs {% endcomment %}
-{%- for workdir in workdir_dirs %}{% include extend/toctree.liquid %}{% endfor -%}
+{%- 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/{addons → class/addons}/analytics.liquid

@@ -1,8 +1,8 @@
 <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" }}:
+            {{ __.total_visits | default: "Total visits" }}:
             <span id="counter">
                 <span class="progress"></span>
             </span>

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>

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 no-underline d-flex flex-justify-center">
+            <a class="h4 py-1 px-2 rounded-1" href="{{ site.baseurl }}/">{{ site.title }}</a>
+        </div>
+    </div>
+    <div class="content p-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 d-flex flex-column 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 }}">
+                    <i class="fa fa-home"></i> {{ site.title }}
+                </a>
+            </div>
+            <span class="version text-gray">{{ 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/head/links.liquid

@@ -0,0 +1,16 @@
+{%- 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">
+
+{% comment %} icon {% endcomment %}
+<link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/favicon.svg">

data/_includes/head/metadata.liquid

@@ -0,0 +1,21 @@
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1, user-scalable=no">
+<meta name="description" content="{{ description }}">
+<meta name="revised" content="{{ docs.build_revision }}">
+<meta name="author" content="{{ author }}">
+<meta name="generator" content="jekyll-rtd-theme v{{ version }}">
+
+{%- comment %} custom {% endcomment %}
+{% for meta in site.meta -%}
+    <meta name="{{ meta.first }}" content="{{ meta.last }}">
+{% endfor -%}
+
+{% comment %} https://ogp.me {% endcomment %}
+<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/head/script.extension.liquid

@@ -0,0 +1,24 @@
+{%- comment %} mermaid {% endcomment -%}
+{%- if content contains '<code class="language-mermaid">' -%}
+    {%- if site.mermaid.custom -%}
+        <script src="{{ site.mermaid.custom }}"></script>
+    {%- else -%}
+        <script src="{{ cdn }}/assets/js/mermaid.min.js"></script>
+    {%- endif %}
+    <script>
+        mermaid.initialize({% if site.mermaid.initialize %}{{ site.mermaid.initialize | jsonify }}{% else %}{}{% endif %});
+    </script>
+{%- endif %}
+
+{% comment %} Google Analytics {% endcomment %}
+{%- 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 -%}