jekyll-rtd-theme 0.1.1 → 0.1.7

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: a12e67932cfe2e811f10cbe9a3e7bf276f47b06cbd21f37e6975689b9ed2bf65
-  data.tar.gz: 40448cc7793251a98c3d0e22f7d5a7d9534be8ebf7df216ef246f8529a433cf3
+  metadata.gz: 4dc19b8440dd2ed5d05e227af867ca52c58efc39a3640f10c3a69e209d038556
+  data.tar.gz: 3f3c62f5541bb6243060d6451c43da375fae232b5d3432e95c8bf05135a64914
 SHA512:
-  metadata.gz: 8fde10bac64b04ce72638df78452ee1b5fdb35fe9abd8041899f12a6a417471712af7ec79462eb8406b6fbbe4101a6101e1e1ca2ecad3ce962fab8e6ac76a205
-  data.tar.gz: ffd8272abdb7b7079803171cfffe4814e54b553ad620ba3e441565c392c75c1556773c35404f5009ba0f0f769179a68fd262a07aea78f7c8f2d26a5787bad027
+  metadata.gz: 5dc0bf6face01e8b48ee5a7a125b23f2f60bf75a0079c857d3e8b569f112d2ca125c69b866bb74fa72e277038f054c7801b5b033fc84a753ca49d446b0776723
+  data.tar.gz: ac4ff74d87393b52578a45aecbd4a22894cad693120decac835d969c88266b5ed0f78aa8a665122636a7f57481607b2cee0dd1e542afacc44d99760b59c4ac10

data/README.md

@@ -1,49 +1,43 @@
 # jekyll-rtd-theme
-![gh-pages](https://github.com/rundocs/jekyll-rtd-theme/workflows/gh-pages/badge.svg)
-[![Gem Version](https://img.shields.io/gem/v/jekyll-rtd-theme)][gem]
-[![Gem Downloads](https://img.shields.io/gem/dt/jekyll-rtd-theme)][gem]
-[![Users](https://img.shields.io/endpoint?url=https://rundocs-analytics.glitch.me/shields)](https://github.com/rundocs/analytics)
-[![Jsdelivr hits](https://data.jsdelivr.com/v1/package/gh/rundocs/static/badge)](https://cdn.jsdelivr.net/gh/rundocs/static/)
-[![CodeFactor](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme)
-
-Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_theme styles
-
-## Installation
-There are two ways to install: as a gem-based theme, as a remote theme (GitHub Pages compatible)
-
-#### Gem-based method
-1. Add the following to your github repository's `Gemfile`
-    ```ruby
-    source "https://rubygems.org"
-
-    gem "jekyll-rtd-theme"
-
-    gem "github-pages", group: :jekyll_plugins
-    ```
-2. Add the following to your github repository's `_config.yml`
-    ```yml
-    theme: jekyll-rtd-theme
-    ```
-
-#### Remote theme method
-1. Add the following to your site's `_config.yml`
-    ```yml
-    remote_theme: rundocs/jekyll-rtd-theme
-    ```
-2. Remove any other `theme` or `remote_theme` entry
-
+[![](https://github.com/rundocs/jekyll-rtd-theme/workflows/CI/badge.svg)][repository]
+[![](https://img.shields.io/gem/v/jekyll-rtd-theme)][rubygem]
+[![](https://img.shields.io/gem/dt/jekyll-rtd-theme)][rubygem]
+[![](https://data.jsdelivr.com/v1/package/gh/rundocs/jekyll-rtd-theme/badge)][cdn]
+[![](https://www.codefactor.io/repository/github/rundocs/jekyll-rtd-theme/badge)][codefactor]
+[![](https://img.shields.io/badge/featured%20on-JekyllThemes-red.svg)](https://jekyll-themes.com)
+
+Just another documentation theme compatible with GitHub Pages, based on sphinx_rtd_theme
+
+![][demo]
+
+## Notable features
+- Write documents directly, like docsify!
+- Only need one file `_config.yml` to configure site
+- Bundled as a "theme gem" for easier installation/upgrading.
+- Compatible with GitHub Pages.
+- Optimized for search engines with support for Open Graph data.
+- Optimized for search engines with `robots.txt` and `sitemap.xml`.
+- Search engine support
+- Commenting support
+- Google,Baidu,CNZZ Analytics support.
+- UI localized text in English(default), Chinese(中文)
+- And many features waiting for you to discover.
 
 ## Roadmap
 See the [open issues][issues] for a list of proposed features (and known issues).
 
+## Documents
+For full documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
 
-## Contributing
-1. Clone down the theme's repository (`git clone https://github.com/rundocs/jekyll-rtd-theme.git`)
-2. `cd` into the theme's directory
-3. Run `bundle` to install the necessary dependencies
-4. Run `bundle exec jekyll server` to start the preview server
-5. Visit [`http://localhost:4000`](http://localhost:4000) in your browser to preview the theme
+## The License
+The theme is available as open source under the terms of the [MIT License][license].
 
 
-[gem]: https://rubygems.org/gems/jekyll-rtd-theme
+[repository]: https://github.com/rundocs/jekyll-rtd-theme
 [issues]: https://github.com/rundocs/jekyll-rtd-theme/issues
+[license]: https://github.com/rundocs/jekyll-rtd-theme/blob/master/LICENSE
+[site]: https://rundocs.github.io/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
+[demo]: https://user-images.githubusercontent.com/68011645/88376699-87980500-cdd0-11ea-8900-7bab8c811bc9.png

data/_includes/{versions.liquid → addons.liquid}

@@ -1,13 +1,13 @@
 <div class="rst-versions" data-toggle="rst-versions" role="note" aria-label="versions">
     <span class="rst-current-version" data-toggle="rst-current-version">
         <span class="fa fa-book"> {{ site.title }}</span>
-        {{ commit }}
+        {% if site.addons_commit %}{{ commit }}{% endif %}
         <span class="fa fa-caret-down"></span>
     </span>
     <div class="rst-other-versions">
-        {%- assign addons = "github,gems,analytics" | split: "," -%}
-        {% for name in addons -%}
-            {% include addons/source/{{ name }}.liquid %}
+        {%- assign items = site.addons | default: addons -%}
+        {% for item in items -%}
+            {% include addons/source/{{ item }}.liquid %}
         {% endfor -%}
         <hr>
         <small>

data/_includes/addons/comments/disqus.liquid

@@ -0,0 +1,10 @@
+{% if site.disqus %}
+<div id="disqus_thread" class="articleComments"></div>
+<script>
+    (function(script) {
+        script.src = "https://{{ site.disqus }}.disqus.com/embed.js";
+        script.setAttribute("data-timestamp", +new Date());
+        document.head.appendChild(script);
+    })(document.createElement("script"));
+</script>
+{% endif %}

data/_includes/addons/source/github.liquid

@@ -1,12 +1,6 @@
 <dl>
     <dt>{{ __github }}</dt>
-    {%- if jekyll.environment == "production" -%}
-        <dd><a href="{{ site.github.repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-        <dd><a href="{{ site.github.zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-        <dd><a href="{{ site.github.issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
-    {%- else -%}
-        <dd><a href="#"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
-        <dd><a href="#"><i class="fa fa-download"></i> {{ __download }}</a></dd>
-        <dd><a href="#"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
-    {%- endif -%}
+    <dd><a href="{{ repository_url }}"><i class="fa fa-github"></i> {{ __homepage }}</a></dd>
+    <dd><a href="{{ zip_url }}"><i class="fa fa-download"></i> {{ __download }}</a></dd>
+    <dd><a href="{{ issues_url }}"><i class="fa fa-question-circle-o"></i> {{ __issues }}</a></dd>
 </dl>

data/_includes/assets/js/script.js

@@ -59,6 +59,7 @@ $(document).ready(function() {
         $.getJSON("{{ site.baseurl }}/data.json", search);
     }
     admonition();
+    anchors.add();
     SphinxRtdTheme.Navigation.reset = reset;
     SphinxRtdTheme.Navigation.enable(true);
 });

data/_includes/breadcrumbs.liquid

@@ -1,33 +1,37 @@
 <div role="navigation" aria-label="breadcrumbs navigation">
     <ul class="wy-breadcrumbs">
-        <li><a href="{{ site.baseurl }}/" class="icon icon-home"></a>&raquo;</li>
-        {% case page.url %}
-            {% when "/search.html" %}
+        <li>
+            <a href="{{ site.baseurl }}/" class="icon icon-home"></a><i class="fa fa-angle-double-right"></i>
+        </li>
+        {%- case page.url -%}
+            {%- when "/search.html" %}
                 <li>{{ __search }}</li>
-            {% when "/404.html" %}
+            {%- when "/404.html" %}
                 <li>{{ __404 }}</li>
-            {% else %}
-                {% assign blocks = page.path | split: "/" %}
-                {% assign length = blocks | size %}
-                {% if page.dir == page.url and page.url != "/" %}
-                    {% assign length = blocks | size | minus: 1 %}
-                {% endif %}
-                {% for block in blocks limit: length %}
-                    {% if forloop.last %}
-                        <li>{{ page.title }}</li>
-                    {% else %}
-                        {% capture href %}{{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block | append: "/" }}{% endfor %}{% endcapture %}
-                        <li><a href="{{ href }}">{{ block | capitalize }}</a> &raquo;</li>
-                    {% endif %}
-                {% endfor %}
-        {% endcase %}
-        <li class="wy-breadcrumbs-aside">
-            {%- if jekyll.environment == "production" -%}
-                <a href="{% github_edit_link %}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
             {%- else -%}
-                <a href="#" class="fa fa-github" target="_blank"> {{ __edit }}</a>
-            {%- endif -%}
-        </li>
+                {%- assign blocks = page.path | split: "/" -%}
+                {%- assign length = blocks | size -%}
+                {%- if page.dir == page.url and page.url != "/" -%}
+                    {%- assign length = blocks | size | minus: 1 -%}
+                {%- endif -%}
+                {%- for block in blocks limit: length -%}
+                    {%- if forloop.last %}
+                        <li>{{ page.title }}</li>
+                    {%- else -%}
+                        {%- capture href -%}
+                            {{ site.baseurl }}/{% for block in blocks limit: forloop.index %}{{ block | append: "/" }}{% endfor %}
+                        {%- endcapture %}
+                        <li>
+                            <a href="{{ href }}">{{ block | split: "." | last | capitalize }}</a><i class="fa fa-angle-double-right"></i>
+                        </li>
+                    {%- endif -%}
+                {%- endfor -%}
+        {%- endcase %}
+        {%- if site.edit -%}
+            <li class="wy-breadcrumbs-aside">
+                <a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
+            </li>
+        {%- endif -%}
     </ul>
     <hr>
 </div>

data/_includes/extend/list.liquid

@@ -0,0 +1,15 @@
+{%- include reset/html.liquid -%}
+{%- include reset/workspace.liquid -%}
+
+{%- assign base = page.dir | append: "temp/" | split: "/" | size -%}
+{%- assign size = workspace_level | minus: base -%}
+{%- assign size_p1 = size | plus: 1 -%}
+
+{%- assign dir = html_pages | where: "url", workspace | first %}
+{% include extend/tabs.liquid size=size %}- [{{ dir.title | default: dir.url }}]({{ site.baseurl | append: dir.url }})
+
+{%- for item in workspace_files %}
+{% include extend/tabs.liquid size=size_p1 %}- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+{%- endfor -%}
+
+{%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}

data/_includes/extend/tabs.liquid

@@ -0,0 +1,2 @@
+{%- assign tab = "    " -%}
+{%- for temp in (1..include.size) %}{{ tab }}{% endfor -%}

data/_includes/{toctree_ln.liquid → extend/toctree.liquid}

@@ -15,12 +15,15 @@
         {%- endcapture %}
         <li class="toctree-l{{ level }} {{ current }}">
             <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
+                {%- if item.sort -%}
+                    {{ item.sort }}.
+                {%- endif %}
                 {{ item.title | default: item.url }}
             </a>
         </li>
     {%- endfor -%}
     {%- for workspace in workspace_dirs -%}
         {%- assign level = workspace | append: "temp/" | split: "/" | size | minus: 3 %}
-        <li class="toctree-l{{ level }}">{% include toctree_ln.liquid %}</li>
+        <li class="toctree-l{{ level }}">{% include extend/toctree.liquid %}</li>
     {%- endfor -%}
 </ul>

data/_includes/footer.liquid

@@ -14,14 +14,21 @@
         </div>
     {%- endif -%}
     <hr>
-    <div role="contentinfo" class="copyright">
-        <p>
-            <i class="fa fa-copyright"></i> {{ __copyright }}
-            {{ site.time | date: "%Y" }},
-            {{ site.copyright | default: site.github.owner_name }}
-            <span class="commit">
-                {{ __revision }} <code>{{ commit }}</code>
-            </span>
-        </p>
-    </div>
+    {%- if site.copyright -%}
+        <div role="contentinfo" class="copyright">
+            <p>
+                <i class="fa fa-copyright"></i> {{ __copyright }}
+                {% if site.copyright.since -%}
+                    {{ site.copyright.since | append: "-" }}
+                {%- endif -%}
+                {{ site.time | date: "%Y" }},
+                {{ author }}
+                {% if site.copyright.revision -%}
+                    <span class="commit">
+                        {{ __revision }} <code>{{ commit }}</code>
+                    </span>
+                {%- endif -%}
+            </p>
+        </div>
+    {%- endif -%}
 </footer>

data/_includes/list.liquid

@@ -0,0 +1,10 @@
+{%- include reset/html.liquid -%}
+{%- include reset/workspace.liquid workspace=page.dir -%}
+
+{%- for item in workspace_files %}
+- [{{ item.title | default: item.url }}]({{ site.baseurl | append: item.url }})
+{%- endfor -%}
+
+{%- if include.all -%}
+    {%- for workspace in workspace_dirs %}{% include extend/list.liquid %}{% endfor -%}
+{%- endif -%}

data/_includes/reset/html.liquid

@@ -1,5 +1,6 @@
 {%- assign html_pages = site.html_pages
     | sort: "path"
+    | sort: "sort"
     | where_exp: "item", "item.url != '/404.html'"
     | where_exp: "item", "item.url != '/search.html'" -%}
 {%- assign html_dirs  = html_pages

data/_includes/reset/snippets.liquid

@@ -1,3 +1,11 @@
-{%- assign  site_style = '@import "style.scss";' -%}
-{%- assign  site_fluid = '@import "fluid.scss";' -%}
-{%- capture site_script %}{% include assets/js/script.js %}{% endcapture -%}
+{%- capture site_style -%}
+    @import "style.scss";
+    @import "rougify/{{ site.rougify | default: 'github' }}.scss";
+    {%- if site.fluid -%}
+        @import "fluid.scss";
+    {%- endif -%}
+{%- endcapture -%}
+
+{%- capture site_script %}
+    {% include assets/js/script.js %}
+{%- endcapture -%}

data/_includes/reset/variables.liquid

@@ -1,8 +1,28 @@
 {%- assign description = content | strip_html | split: " " | join: " " | escape | truncate: 150 -%}
-{%- assign author = site.github.owner_name -%}
-{%- assign commit = site.github.build_revision | slice: 0, 7 -%}
 {%- assign schema_url = page.url | absolute_url | xml_escape -%}
 {%- assign schema_lastmod = site.time | date_to_xmlschema -%}
-{%- assign npm = "https://cdn.jsdelivr.net/npm" -%}
-{%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/static" -%}
-{%- assign rouge_style = site.rouge_style | default: "github" -%}
+{%- assign version = "0.1.7" -%}
+
+{%- if site.debug -%}
+    {%- assign cdn = site.baseurl -%}
+{%- else -%}
+    {%- assign cdn = "https://cdn.jsdelivr.net/gh/rundocs/jekyll-rtd-theme@" | append: version -%}
+{%- endif -%}
+
+{%- if jekyll.environment == "production" -%}
+    {%- assign author = site.author | default: site.github.owner_name -%}
+    {%- assign commit = site.github.build_revision | slice: 0, 7 -%}
+    {%- assign repository_url = site.github.repository_url -%}
+    {%- assign issues_url = site.github.issues_url -%}
+    {%- assign zip_url = site.github.zip_url -%}
+    {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
+{%- else -%}
+    {%- assign author = site.author | default: "[author]" -%}
+    {%- assign commit = "[commit]" -%}
+    {%- assign repository_url = "#" -%}
+    {%- assign issues_url = "#" -%}
+    {%- assign zip_url = "#" -%}
+    {%- assign github_edit_link = "#" -%}
+{%- endif -%}
+
+{%- assign addons = "github, gems, analytics" | split: ", " -%}

data/_includes/{toctree_l1.liquid → toctree.liquid}

@@ -14,4 +14,4 @@
     {%- endfor %}
 </ul>
 
-{%- for workspace in workspace_dirs %}{% include toctree_ln.liquid %}{% endfor -%}
+{%- for workspace in workspace_dirs %}{% include extend/toctree.liquid %}{% endfor -%}

data/_layouts/default.liquid

@@ -5,6 +5,15 @@ layout: plugins/compress
 {%- include reset/start.liquid -%}
 
 <!DOCTYPE html>
+
+<!--
+    {% if site.remote_theme -%}
+        remote_theme: {{ site.remote_theme }}, based on v{{ version }}
+    {%- else -%}
+        theme: {{ site.theme | default: "jekyll-rtd-theme, based on" }} v{{ version }}
+    {%- endif %}
+-->
+
 <html class="writer-html5" lang="{{ lang }}">
 
 <head>
@@ -15,7 +24,7 @@ layout: plugins/compress
     <meta name="description" content="{{ description }}">
     <meta name="author" content="{{ author }}">
     <meta name="revised" content="{{ commit }}">
-    <meta name="generator" content="Jekyll v{{ jekyll.version }}">
+    <meta name="generator" content="jekyll-rtd-theme v{{ version }}">
     <!-- custom meta -->
     {% for meta in site.meta -%}
         <meta name="{{ meta.first }}" content="{{ meta.last }}">
@@ -33,18 +42,15 @@ layout: plugins/compress
     {%- endif -%}
     <link rel="canonical" href="{{ schema_url }}">
     <!-- theme -->
-    <link rel="stylesheet" href="{{ cdn }}/css/theme.css">
-    <link rel="stylesheet" href="{{ cdn }}/css/rouge/{{ rouge_style }}.css">
-    <style>{{ site.style | default: site_style | scssify }}</style>
-    {%- if site.fluid -%}
-        <style>{{ site_fluid | scssify }}</style>
-    {%- endif %}
+    <link rel="stylesheet" href="{{ cdn }}/assets/css/theme.css">
+    <style>{{ site_style | scssify }}</style>
     <!-- icon -->
-    <link rel="icon" href="{{ site.baseurl }}/assets/favicon.png">
+    <link rel="icon" type="image/svg+xml" href="{{ site.baseurl }}/assets/favicon.svg">
     <!-- script -->
-    <script src="{{ npm }}/jquery/dist/jquery.min.js"></script>
-    <script src="{{ cdn }}/js/theme.js"></script>
-    <script>{{ site.script | default : site_script }}</script>
+    <script src="{{ cdn }}/assets/js/jquery.min.js"></script>
+    <script src="{{ cdn }}/assets/js/theme.js"></script>
+    <script src="{{ cdn }}/assets/js/anchor.min.js"></script>
+    <script>{{ site_script }}</script>
 </head>
 
 <body class="wy-body-for-nav">
@@ -53,13 +59,17 @@ layout: plugins/compress
         <nav data-toggle="wy-nav-shift" class="wy-nav-side">
             <div class="wy-side-scroll">
                 <div class="wy-side-nav-search">
-                    <a href="{{ site.baseurl }}/" class="icon icon-home">
-                        {{ site.title }}
-                    </a>
+                    {% if site.logo %}
+                        <a href="{{ site.baseurl }}/">
+                            <img src="{{ site.baseurl }}/{{ site.logo }}" class="logo" alt="{{ site.title }}">
+                        </a>
+                    {% else %}
+                        <a href="{{ site.baseurl }}/" class="icon icon-home"> {{ site.title }}</a>
+                    {% endif %}
                     {% include searchbox.liquid %}
                 </div>
                 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-                    {% include toctree_l1.liquid %}
+                    {% include toctree.liquid %}
                 </div>
                 {%- if site.embed -%}
                 <div class="wy-embed-wrap">
@@ -85,14 +95,14 @@ layout: plugins/compress
                                 <div class="section">{{ content }}</div>
                             {%- endif %}
                         </div>
-                        <div class="articleComments"></div>
+                        {% include addons/comments/disqus.liquid %}
                     </div>
                     {% include footer.liquid %}
                 </div>
             </div>
         </section>
     </div>
-    {%- include versions.liquid -%}
+    {%- if site.addons %}{% include addons.liquid %}{% endif %}
     <!-- analytics -->
     {%- include addons/analytics/baidu.liquid -%}
     {%- include addons/analytics/cnzz.liquid -%}