jekyll-rtd-theme 0.0.1 → 0.1.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: b521c31a74a8b5cb44c0d3076147eeffd5936e35546c538bca7e387266b10b70
-  data.tar.gz: 745953b1e33fa06382bdba5f83270b5f460cd67a2fc6ae0fe019a6faae62d4d2
+  metadata.gz: 38dce7565904ba703d3b6870eec6338eaefd2e4b5526bde0390503c91b4de99b
+  data.tar.gz: d5e3c38ee7c3ce55a1ed7fc8c90aa842ea1568ce8f2effba21a90443ce51621f
 SHA512:
-  metadata.gz: 7890471c507de5450db98acc060b6c5552e1cd1e8933cbeb3e5b7884631386713d891abe044a2e561909f4d9ab40b9d0e48ab021061f701f0bd10afc9bcf6241
-  data.tar.gz: aaa3a9796c18dd81efab2f1e2f1f0f6ba69cba7e3eb6a7851175e4edbeac7dc796c7e0106b81063aa78fee78b3306dd058ebe87fd71fda7002c7d397a3935a4c
+  metadata.gz: fc3a218caea7780ce30300ccd4a35dc463daaeb3a1a85ad307b95d1b753f48c32cca9b731cbe05efda2f2600ad83684019eb3a41a1957944e26750eaf2c3142b
+  data.tar.gz: 07a279a1eab91ee5be3c0aa007b9f175f916cf431436f0aae9ba422519d7e32aca4e366e44d0d7750a9900e721fb204a83e883b1a2e0d5201aecab5850251b46

data/README.md

@@ -1,16 +1,30 @@
 # jekyll-rtd-theme
+[![](https://github.com/rundocs/jekyll-rtd-theme/workflows/gh-pages/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]
 
-Just another Jekyll theme for GitHub Pages
+Just another Jekyll theme for GitHub Pages based on ReadtheDocs's sphinx_rtd_theme styles
+
+![][demo]
 
 ## Roadmap
 See the [open issues][issues] for a list of proposed features (and known issues).
 
-## 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
+
+## Documents
+For complete documentation, see: [https://rundocs.github.io/jekyll-rtd-theme][site]
+
+## The License
+The theme is available as open source under the terms of the [MIT License][license].
 
 
-[issues]: https://github.com/rundocs/jekyll-rtd-theme/issues
+[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/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,32 +1,34 @@
 <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 %}
+            {%- 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 %}
+                    {%- 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 %}
         <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 -%}
+            <a href="{{ github_edit_link }}" class="fa fa-github" target="_blank"> {{ __edit }}</a>
         </li>
     </ul>
     <hr>

data/_includes/footer.liquid

@@ -18,7 +18,7 @@
         <p>
             <i class="fa fa-copyright"></i> {{ __copyright }}
             {{ site.time | date: "%Y" }},
-            {{ site.copyright | default: site.github.owner_name }}
+            {{ author }}
             <span class="commit">
                 {{ __revision }} <code>{{ commit }}</code>
             </span>

data/_includes/list.liquid

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

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,26 @@
 {%- 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.5" -%}
+
+{%- 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 -%}
+
+{%- 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 issues_url = site.github.issues_url -%}
+    {%- assign zip_url = site.github.zip_url -%}
+    {%- capture github_edit_link %}{% github_edit_link %}{% endcapture -%}
+{%- else -%}
+    {%- assign issues_url = "#" -%}
+    {%- assign zip_url = "#" -%}
+    {%- assign github_edit_link = "#" -%}
+{%- endif -%}
+
+{%- assign addons = site.addons | default: "github, gems, analytics" -%}

data/_includes/reset/workspace.liquid

@@ -0,0 +1,17 @@
+{%- assign workspace = include.workspace | default: "/" -%}
+{%- assign workspace_level = workspace | append: "temp/" | split: "/" | size | minus: 1 -%}
+{%- assign workspace_files = html_files | where_exp: "item", "item.dir == workspace" -%}
+
+{%- capture items -%}
+    {%- for item in html_dirs -%}
+        {%- assign current_m1 = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
+        {%- if workspace_level == current_m1 -%}
+            {%- assign temp = workspace | append: "@@" -%}
+            {%- assign dir = item.dir | replace: workspace, temp | split: "@@" | first -%}
+            {%- if workspace == dir -%}
+                {{ item.dir }}|
+            {%- endif -%}
+        {%- endif -%}
+    {%- endfor -%}
+{%- endcapture -%}
+{%- assign workspace_dirs = items | split: "|" -%}

data/_includes/toctree_l1.liquid

@@ -0,0 +1,17 @@
+{%- include reset/workspace.liquid %}
+
+<ul>
+    {%- for item in workspace_files -%}
+        {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 1 -%}
+        {%- capture current -%}
+            {%- if page.url == item.url %}current{% endif -%}
+        {%- endcapture %}
+        <li class="toctree-l{{ level }} {{ current }}">
+            <a class="reference internal {{ current }}" href="{{ site.baseurl | append: item.url }}">
+                {{ item.title | default: item.url }}
+            </a>
+        </li>
+    {%- endfor %}
+</ul>
+
+{%- for workspace in workspace_dirs %}{% include toctree_ln.liquid %}{% endfor -%}

data/_includes/toctree_ln.liquid

@@ -0,0 +1,29 @@
+{%- include reset/workspace.liquid %}
+
+{%- assign dir = html_pages | where: "url", workspace | first -%}
+{%- if workspace_level == 2 %}
+    <p class="caption"><span class="caption-text">{{ dir.title | default: dir.url }}</span></p>
+{%- else %}
+    <a class="reference internal" href="{{ site.baseurl | append: dir.url }}">{{ dir.title | default: dir.url }}</a>
+{%- endif -%}
+
+<ul>
+    {%- for item in workspace_files -%}
+        {%- assign level = item.dir | append: "temp/" | split: "/" | size | minus: 2 -%}
+        {%- capture current -%}
+            {%- if page.url == item.url %}current{% endif -%}
+        {%- 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>
+    {%- endfor -%}
+</ul>

data/_includes/versions.liquid

@@ -5,9 +5,9 @@
         <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 = addons | split: ", " -%}
+        {% for item in items -%}
+            {% include addons/source/{{ item }}.liquid %}
         {% endfor -%}
         <hr>
         <small>

data/_layouts/default.liquid

@@ -33,18 +33,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">
@@ -59,7 +56,7 @@ layout: plugins/compress
                     {% include searchbox.liquid %}
                 </div>
                 <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
-                    {% include sidebar.liquid %}
+                    {% include toctree_l1.liquid %}
                 </div>
                 {%- if site.embed -%}
                 <div class="wy-embed-wrap">

data/_layouts/plugins/compress.liquid

@@ -1,4 +1,4 @@
-{%- if site.compress == false -%}
+{%- if site.debug.compress == false -%}
     {{ content }}
 {%- else -%}
     {%- assign items = content | split: "<pre" -%}

data/_sass/rougify/base16.dark.scss

@@ -0,0 +1,78 @@
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight, .highlight .w {
+  color: #d0d0d0;
+  background-color: #151515;
+}
+.highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
+  color: #505050;
+}
+.highlight .cp {
+  color: #f4bf75;
+}
+.highlight .nt {
+  color: #f4bf75;
+}
+.highlight .o, .highlight .ow {
+  color: #d0d0d0;
+}
+.highlight .p, .highlight .pi {
+  color: #d0d0d0;
+}
+.highlight .gi {
+  color: #90a959;
+}
+.highlight .gd {
+  color: #ac4142;
+}
+.highlight .gh {
+  color: #6a9fb5;
+  background-color: #151515;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
+  color: #aa759f;
+}
+.highlight .kc {
+  color: #d28445;
+}
+.highlight .kt {
+  color: #d28445;
+}
+.highlight .kd {
+  color: #d28445;
+}
+.highlight .s, .highlight .sa, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
+  color: #90a959;
+}
+.highlight .sr {
+  color: #75b5aa;
+}
+.highlight .si {
+  color: #8f5536;
+}
+.highlight .se {
+  color: #8f5536;
+}
+.highlight .nn {
+  color: #f4bf75;
+}
+.highlight .nc {
+  color: #f4bf75;
+}
+.highlight .no {
+  color: #f4bf75;
+}
+.highlight .na {
+  color: #6a9fb5;
+}
+.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
+  color: #90a959;
+}
+.highlight .ss {
+  color: #90a959;
+}

data/_sass/rougify/base16.light.scss

@@ -0,0 +1,77 @@
+.highlight table td { padding: 5px; }
+.highlight table pre { margin: 0; }
+.highlight, .highlight .w {
+  color: #303030;
+}
+.highlight .err {
+  color: #151515;
+  background-color: #ac4142;
+}
+.highlight .c, .highlight .ch, .highlight .cd, .highlight .cm, .highlight .cpf, .highlight .c1, .highlight .cs {
+  color: #505050;
+}
+.highlight .cp {
+  color: #f4bf75;
+}
+.highlight .nt {
+  color: #f4bf75;
+}
+.highlight .o, .highlight .ow {
+  color: #d0d0d0;
+}
+.highlight .p, .highlight .pi {
+  color: #d0d0d0;
+}
+.highlight .gi {
+  color: #90a959;
+}
+.highlight .gd {
+  color: #ac4142;
+}
+.highlight .gh {
+  color: #6a9fb5;
+  background-color: #151515;
+  font-weight: bold;
+}
+.highlight .k, .highlight .kn, .highlight .kp, .highlight .kr, .highlight .kv {
+  color: #aa759f;
+}
+.highlight .kc {
+  color: #d28445;
+}
+.highlight .kt {
+  color: #d28445;
+}
+.highlight .kd {
+  color: #d28445;
+}
+.highlight .s, .highlight .sa, .highlight .sb, .highlight .sc, .highlight .dl, .highlight .sd, .highlight .s2, .highlight .sh, .highlight .sx, .highlight .s1 {
+  color: #90a959;
+}
+.highlight .sr {
+  color: #75b5aa;
+}
+.highlight .si {
+  color: #8f5536;
+}
+.highlight .se {
+  color: #8f5536;
+}
+.highlight .nn {
+  color: #f4bf75;
+}
+.highlight .nc {
+  color: #f4bf75;
+}
+.highlight .no {
+  color: #f4bf75;
+}
+.highlight .na {
+  color: #6a9fb5;
+}
+.highlight .m, .highlight .mb, .highlight .mf, .highlight .mh, .highlight .mi, .highlight .il, .highlight .mo, .highlight .mx {
+  color: #90a959;
+}
+.highlight .ss {
+  color: #90a959;
+}