jekyll-docs-theme 0.1.2 → 1.0.0.pre.beta.1

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4731715e2e8530826dec2bb48c5f1abc7834b8cbca7e5bd266aa9a9a3896cb
-  data.tar.gz: 11af0028253c5e2efd4b231021136ab08ba52acfda55ca735f8003087c711eed
+  metadata.gz: 735e7eb3a1c0aaad66ab888846e1fbc0d075bde327236a25f08fb09ef1ed4201
+  data.tar.gz: 2921a56d61b4ef0eb601206f15fba9c3aaee9c194d57fc947dd0760c0f9a9178
 SHA512:
-  metadata.gz: 4483808e72ba1e00b795f630d0d108189e03a3eb2614c2ad2c7d8b1ddf322e7d492479c9391fe62225d362d23a8aea63fea92bd227d8e8871f9aa37f8bb6bb6d
-  data.tar.gz: dfaa428350430c4c3c555da3b11e6f1a1f33797e5287d7bd635c56c3c3e03c6afff85e865a7b3d7e9785af051b582a484a2606f2841394cd6e74e9cfda391ec7
+  metadata.gz: 7d5599be5e985d2b095e37ac218e8d3da11e2c3907b3d2df1c5b081308d0124b2df79a6e0a9710234e530a633a42d42cf4aab96bdcfacd7b985c5941a7ae2926
+  data.tar.gz: 02f64ec5948d018a8b7065201403c2fa009542c2f598ecff89202433c5a9c7e7e7a87f0a9920afd7ef0984b20f4bc652a30e540eb3b9dfb310c3df007d0e0f5f

data/LICENSE.md

@@ -1,21 +1,25 @@
 The MIT License (MIT)
+=====================
 
-Copyright (c) 2014 Damien Sorel
+Copyright © 2020 Vladimir "allejo" Jimenez
 
-Permission is hereby granted, free of charge, to any person obtaining a copy
-of this software and associated documentation files (the "Software"), to deal
-in the Software without restriction, including without limitation the rights
-to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
-copies of the Software, and to permit persons to whom the Software is
-furnished to do so, subject to the following conditions:
+Permission is hereby granted, free of charge, to any person
+obtaining a copy of this software and associated documentation
+files (the "Software"), to deal in the Software without
+restriction, including without limitation the rights to use,
+copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the
+Software is furnished to do so, subject to the following
+conditions:
 
-The above copyright notice and this permission notice shall be included in all
-copies or substantial portions of the Software.
+The above copyright notice and this permission notice shall be
+included in all copies or substantial portions of the Software.
 
-THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
-IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
-FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
-AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
-LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
-OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
-SOFTWARE.
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
+OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
+NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
+HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
+WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
+FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
+OTHER DEALINGS IN THE SOFTWARE.

data/README.md

@@ -1,46 +1,19 @@
 # Jekyll Docs Theme
 
-> This is a [Jekyll theme](https://github.com/allejo/jekyll-docs-theme) based on [mistic100's modification](https://github.com/mistic100/jekyll-bootstrap-doc) of the official Bootstrap documentation from a few years back.
+A Jekyll theme inspired by Bootstrap's official documentation theme from a few years back. This theme started off by stealing all of Bootstrap Docs' CSS and being used in [mistic100's theme](https://github.com/mistic100/jekyll-bootstrap-doc). This theme has since be rewritten from scratch and remains solely inspired by the original design.
 
-Jekyll Docs Theme is provided as a theme for writing documentation for your projects instead of having a single large README file or several markdown files stored in a not so user-friendly manner.
+This theme is designed for writing documentation websites instead of having large unmaintainable README files or several markdown files inside of a folder in a repository.
 
-This theme is still in development but is kept fairly stable; just note, there are a lot things yet to come.
+## Screenshots
 
-![Theme Screenshot](https://raw.githubusercontent.com/allejo/jekyll-docs-theme/master/screenshot.png)
+**Light Mode**
 
-## Installation
+![Theme Screenshot](./screenshot.png)
 
-Fork this project
+**DarkMode**
 
--or-
-
-Add this line to your Jekyll site's Gemfile:
-
-```ruby
-gem "jekyll-docs-theme"
-```
-
-And add this line to your Jekyll site's `_config.yml`:
-
-```yaml
-theme: jekyll-docs-theme
-```
-
-And then execute:
-
-    $ bundle
-
-Or install it yourself as:
-
-    $ gem install jekyll-docs-theme
-
-## Development
-
-To set up your environment to develop this theme, run `bundle install`.
-
-To develop on this theme, run `bundle exec jekyll serve` and open your browser at `http://localhost:4000`.
+![Theme Screenshot](./screenshot-dark.png)
 
 ## License
 
-The theme is available as open source under the terms of the [MIT License](http://opensource.org/licenses/MIT).
-
+The theme is available as open source under the terms of the [MIT License](./LICENSE.md).

data/_includes/anchor_headings.html

@@ -0,0 +1,109 @@
+{% capture headingsWorkspace %}
+  {% comment %}
+    Version 1.0.5
+      https://github.com/allejo/jekyll-anchor-headings
+
+    "Be the pull request you wish to see in the world." ~Ben Balter
+
+    Usage:
+      {% include anchor_headings.html html=content %}
+
+    Parameters:
+      * html          (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+    Optional Parameters:
+      * beforeHeading (bool)   : false  - Set to true if the anchor should be placed _before_ the heading's content
+      * anchorAttrs   (string) :  ''    - Any custom HTML attributes that will be added to the `<a>` tag; you may NOT use `href`, `class` or `title`
+      * anchorBody    (string) :  ''    - The content that will be placed inside the anchor; the `%heading%` placeholder is available
+      * anchorClass   (string) :  ''    - The class(es) that will be used for each anchor. Separate multiple classes with a space
+      * anchorTitle   (string) :  ''    - The `title` attribute that will be used for anchors
+      * h_min         (int)    :  1     - The minimum header level to build an anchor for; any header lower than this value will be ignored
+      * h_max         (int)    :  6     - The maximum header level to build an anchor for; any header greater than this value will be ignored
+      * bodyPrefix    (string) :  ''    - Anything that should be inserted inside of the heading tag _before_ its anchor and content
+      * bodySuffix    (string) :  ''    - Anything that should be inserted inside of the heading tag _after_ its anchor and content
+
+    Output:
+      The original HTML with the addition of anchors inside of all of the h1-h6 headings.
+  {% endcomment %}
+
+  {% assign minHeader = include.h_min | default: 1 %}
+  {% assign maxHeader = include.h_max | default: 6 %}
+  {% assign beforeHeading = include.beforeHeading %}
+  {% assign nodes = include.html | split: '<h' %}
+
+  {% capture edited_headings %}{% endcapture %}
+
+  {% for _node in nodes %}
+    {% capture node %}{{ _node | strip }}{% endcapture %}
+
+    {% if node == "" %}
+      {% continue %}
+    {% endif %}
+
+    {% assign nextChar = node | replace: '"', '' | strip | slice: 0, 1 %}
+    {% assign headerLevel = nextChar | times: 1 %}
+
+    <!-- If the level is cast to 0, it means it's not a h1-h6 tag, so let's see if we need to fix it -->
+    {% if headerLevel == 0 %}
+      <!-- Split up the node based on closing angle brackets and get the first one. -->
+      {% assign firstChunk = node | split: '>' | first %}
+
+      <!-- If the first chunk does NOT contain a '<', that means we've broken another HTML tag that starts with 'h' -->
+      {% unless firstChunk contains '<' %}
+        {% capture node %}<h{{ node }}{% endcapture %}
+      {% endunless %}
+
+      {% capture edited_headings %}{{ edited_headings }}{{ node }}{% endcapture %}
+      {% continue %}
+    {% endif %}
+
+    {% assign _workspace = node | split: '</h' %}
+    {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+    {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+    {% assign html_id = _idWorkspace[0] %}
+
+    {% capture _hAttrToStrip %}{{ _workspace[0] | split: '>' | first }}>{% endcapture %}
+    {% assign header = _workspace[0] | replace: _hAttrToStrip, '' %}
+
+    <!-- Build the anchor to inject for our heading -->
+    {% capture anchor %}{% endcapture %}
+
+    {% if html_id and headerLevel >= minHeader and headerLevel <= maxHeader %}
+      {% capture anchor %}href="#{{ html_id }}"{% endcapture %}
+
+      {% if include.anchorClass %}
+        {% capture anchor %}{{ anchor }} class="{{ include.anchorClass }}"{% endcapture %}
+      {% endif %}
+
+      {% if include.anchorTitle %}
+        {% capture anchor %}{{ anchor }} title="{{ include.anchorTitle | replace: '%heading%', header }}"{% endcapture %}
+      {% endif %}
+
+      {% if include.anchorAttrs %}
+        {% capture anchor %}{{ anchor }} {{ include.anchorAttrs }}{% endcapture %}
+      {% endif %}
+
+      {% capture anchor %}<a {{ anchor }}>{{ include.anchorBody | replace: '%heading%', header | default: '' }}</a>{% endcapture %}
+
+      <!-- In order to prevent adding extra space after a heading, we'll let the 'anchor' value contain it -->
+      {% if beforeHeading %}
+        {% capture anchor %}{{ anchor }} {% endcapture %}
+      {% else %}
+        {% capture anchor %} {{ anchor }}{% endcapture %}
+      {% endif %}
+    {% endif %}
+
+    {% capture new_heading %}
+      <h{{ _hAttrToStrip }}
+        {{ include.bodyPrefix }}
+        {% if beforeHeading %}
+          {{ anchor }}{{ header }}
+        {% else %}
+          {{ header }}{{ anchor }}
+        {% endif %}
+        {{ include.bodySuffix }}
+      </h{{ _workspace | last }}
+    {% endcapture %}
+    {% capture edited_headings %}{{ edited_headings }}{{ new_heading }}{% endcapture %}
+  {% endfor %}
+{% endcapture %}{% assign headingsWorkspace = '' %}{{ edited_headings | strip }}

data/_includes/fa-icon.html

@@ -0,0 +1,13 @@
+{% if include.icon %}
+    {% capture fa_prefix -%}
+        {%- if include.brand -%}
+            fab
+        {%- else -%}
+            fas
+        {%- endif -%}
+    {%- endcapture -%}
+    <i
+        class="{{ fa_prefix }} fa-{{ include.icon }} fa-fw {{ include.class }}"
+        aria-hidden="true"
+    ></i>
+{% endif %}

data/_includes/footer/content-post.html

@@ -0,0 +1,4 @@
+{% comment %}
+    This file was intentionally left blank so that it can be overriden by theme
+    developers. This file is loaded AFTER the footer's main body is loaded.
+{% endcomment %}

data/_includes/footer/content-pre.html

@@ -0,0 +1,4 @@
+{% comment %}
+    This file was intentionally left blank so that it can be overriden by theme
+    developers. This file is loaded BEFORE the footer's main body is loaded.
+{% endcomment %}

data/_includes/footer/content.html

@@ -0,0 +1,137 @@
+<div class="container">
+    {% if site.social %}
+        <div class="site-footer__social-links">
+            <ul class="list-inline mb-2">
+                {% if site.social.github.user and site.social.github.repo %}
+                    <li class="list-inline-item">
+                        <iframe
+                            class="github-btn"
+                            src="https://ghbtns.com/github-btn.html?user={{ site.social.github.user }}&amp;repo={{ site.social.github.repo }}&amp;type=watch&amp;count=true"
+                            width="90"
+                            height="20"
+                            title="Star on GitHub"
+                        ></iframe>
+                    </li>
+                    <li class="list-inline-item">
+                        <iframe
+                            class="github-btn"
+                            src="https://ghbtns.com/github-btn.html?user={{ site.social.github.user }}&amp;repo={{ site.social.github.repo }}&amp;type=fork&amp;count=true"
+                            width="90"
+                            height="20"
+                            title="Fork on GitHub"
+                        ></iframe>
+                    </li>
+                {% endif %}
+                {% if site.social.twitter.enabled %}
+                    <li class="list-inline-item">
+                        <a
+                            href="https://twitter.com/share"
+                            class="twitter-share-button"
+                            data-url="{{ site.github.url }}"
+                            data-count="horizontal"
+                            data-via="{{ site.social.twitter.via }}"
+                            data-text="{{ site.name }}"
+                            data-hashtags="{{ site.social.twitter.hash }}"
+                        >
+                            Tweet
+                        </a>
+                    </li>
+                {% endif %}
+                {% if site.twitter.account %}
+                    <li class="list-inline-item">
+                        <a
+                            href="https://twitter.com/{{ site.social.twitter.account }}"
+                            class="twitter-follow-button"
+                            data-show-count="true"
+                        >
+                            Follow @{{ site.social.twitter.account }}
+                        </a>
+                    </li>
+                {% endif %}
+                {% if site.facebook.enabled %}
+                    <li class="list-inline-item">
+                        <div
+                            class="fb-like"
+                            data-href="{{ site.github.url }}"
+                            data-layout="button_count"
+                            data-action="like"
+                            data-show-faces="false"
+                            data-share="true"
+                        ></div>
+                    </li>
+                {% endif %}
+                {% if site.facebook.profileUrl %}
+                    <li class="list-inline-item">
+                        <div
+                            class="fb-follow"
+                            data-href="{{ site.social.facebook.profileUrl }}"
+                            data-layout="button_count"
+                            data-show-faces="false"
+                        ></div>
+                    </li>
+                {% endif %}
+            </ul>
+        </div>
+    {% endif %}
+
+    <div class="site-footer__body">
+        <div class="row align-items-center">
+            <div class="col-md-5">
+                {% if site.links.footer %}
+                    <ul class="site-footer__links text-left list-inline mb-0">
+                        {% for link in site.links.footer %}
+                            <li class="list-inline-item">
+                                <a
+                                    href="{{ link.url }}"
+                                    class="site-footer__link"
+                                >
+                                    {% include fa-icon.html
+                                         icon=link.icon
+                                         brand=link.brand
+                                    %}
+                                    <span>{{ link.title }}</span>
+                                </a>
+                            </li>
+                        {% endfor %}
+                    </ul>
+                {% endif %}
+            </div>
+
+            <div class="col-md-7 text-left text-md-right">
+                {% if site.license %}
+                    <div class="site-footer__summary">
+                        {% assign software_and_docs = site.license.software and site.license.docs %}
+                        {% assign one_or_the_other = site.license.software or site.license.docs %}
+
+                        <p class="mb-0">
+                            {%- if site.license.software -%}
+                                Licensed under
+
+                                {% if site.license.software_url -%}<a href="{{ site.license.software_url }}" target="_blank">{%- endif -%}
+                                    {{ site.license.software }}
+                                {%- if site.license.software_url -%}</a>{%- endif -%}
+                            {%- endif -%}
+
+                            {%- if site.license.docs -%}
+                                {%- if one_or_the_other -%}
+                                    , documentation under
+                                {%- else -%}
+                                    Documentation under
+                                {%- endif %}
+
+                                {% if site.license.docs_url -%}<a href="{{ site.license.docs_url }}">{%- endif -%}
+                                    {{ site.license.docs }}
+                                {%- if site.license.docs_url -%}</a>{%- endif -%}
+                            {%- endif -%}
+                        </p>
+
+                        <p class="mb-0">
+                            Documentation template by <a href="http://getbootstrap.com">Bootstrap team</a>, generated with
+                            <a href="https://github.com/allejo/jekyll-docs-theme">Jekyll Docs Theme</a>
+                        </p>
+                    </div>
+                {% endif %}
+            </div>
+        </div>
+    </div>
+</div>

data/_includes/footer/full.html

@@ -0,0 +1,13 @@
+<footer class="site-footer border-top mt-4 py-4 text-center" role="contentinfo">
+    {% include footer/content-pre.html %}
+    {% include footer/content.html %}
+    {% include footer/content-post.html %}
+</footer>
+
+{% include footer/scripts-pre.html %}
+{% include footer/scripts.html %}
+{% include footer/scripts-post.html %}
+
+{% if site.analytics.google %}
+    {% include google-analytics.html %}
+{% endif %}

data/_includes/footer/scripts-post.html

@@ -0,0 +1,4 @@
+{% comment %}
+    This file was intentionally left blank so that it can be overriden by theme
+    developers. This file is loaded AFTER the theme's JavaScript files are loaded.
+{% endcomment %}

data/_includes/footer/scripts-pre.html

@@ -0,0 +1,4 @@
+{% comment %}
+    This file was intentionally left blank so that it can be overriden by theme
+    developers. This file is loaded BEFORE the theme's JavaScript files are loaded.
+{% endcomment %}

data/_includes/footer/scripts.html

@@ -0,0 +1,48 @@
+<!-- Bootstrap Related Dependencies -->
+<script
+    src="https://cdnjs.cloudflare.com/ajax/libs/jquery/3.4.1/jquery.slim.js"
+    integrity="sha256-BTlTdQO9/fascB1drekrDVkaKd9PkwBymMlHOiG+qLI=" crossorigin="anonymous"
+></script>
+<script
+    src="https://cdnjs.cloudflare.com/ajax/libs/popper.js/1.16.1/popper.min.js"
+    integrity="sha256-O17BxFKtTt1tzzlkcYwgONw4K59H+r1iI8mSQXvSf5k=" crossorigin="anonymous"
+></script>
+<script
+    src="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.4.1/js/bootstrap.min.js"
+    integrity="sha256-WqU1JavFxSAMcLP2WIOI+GB2zWmShMI82mTpLDcqFUg=" crossorigin="anonymous"
+></script>
+
+{% include internal/variables.html %}
+{% if site_ui_header_trianglify %}
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/d3/3.4.11/d3.min.js"></script>
+    <script src="https://cdnjs.cloudflare.com/ajax/libs/trianglify/0.1.2/trianglify.min.js"></script>
+    <script>
+        let uiColors = [];
+
+        {% if site_ui_mode == 'auto' -%}
+            if (window.matchMedia && window.matchMedia('(prefers-color-scheme: dark)').matches) {
+                uiColors = [
+                    "{{ site_ui_header_dark_color1 }}",
+                    "{{ site_ui_header_dark_color2 }}",
+                ];
+            } else {
+                uiColors = [
+                    "{{ site_ui_header_light_color1 }}",
+                    "{{ site_ui_header_light_color2 }}",
+                ];
+            }
+        {%- elsif site_ui_mode == "dark" -%}
+            uiColors = [
+                "{{ site_ui_header_dark_color1 }}",
+                "{{ site_ui_header_dark_color2 }}",
+            ];
+        {%- else -%}
+            uiColors = [
+                "{{ site_ui_header_light_color1 }}",
+                "{{ site_ui_header_light_color2 }}",
+            ];
+        {%- endif %}
+    </script>
+{% endif %}
+
+<script src="{{ '/assets/js/docs.js' | relative_url }}"></script>