jekyll-docs-theme 0.1.2 → 1.0.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 3b4731715e2e8530826dec2bb48c5f1abc7834b8cbca7e5bd266aa9a9a3896cb
-  data.tar.gz: 11af0028253c5e2efd4b231021136ab08ba52acfda55ca735f8003087c711eed
+  metadata.gz: 6155786d6966e01616f439ee62437733b19ca5fc3ea34f3af550ce35a4ba1540
+  data.tar.gz: 1a1dc9ba4548deafb0ca775b0b2df913917bb370fc40d9ca7aa571e94e12127b
 SHA512:
-  metadata.gz: 4483808e72ba1e00b795f630d0d108189e03a3eb2614c2ad2c7d8b1ddf322e7d492479c9391fe62225d362d23a8aea63fea92bd227d8e8871f9aa37f8bb6bb6d
-  data.tar.gz: dfaa428350430c4c3c555da3b11e6f1a1f33797e5287d7bd635c56c3c3e03c6afff85e865a7b3d7e9785af051b582a484a2606f2841394cd6e74e9cfda391ec7
+  metadata.gz: f8fdb3fd9ed50b075bb0992700115557cc986756df750607be8afa3df0b0d10b358114175b449cbb9bd209eb71db1c02f884e1c55f7aab61976f5ed36aeff1b5
+  data.tar.gz: c3695c99de8ebcfeb51a042f84a4f21b7afed0e6eda2bbeb7336e7ed9e64398b9f57d2721ec29b98fe91ee8efcb4ab1aefa899763e7954202102a15e53d39b42

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,23 @@
 # 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.
+[![Gem](https://img.shields.io/gem/v/jekyll-docs-theme)](https://rubygems.org/gems/jekyll-docs-theme)
+[![GitHub release (latest by date including pre-releases)](https://img.shields.io/github/v/release/allejo/jekyll-docs-theme?include_prereleases)](https://github.com/allejo/jekyll-docs-theme/releases)
+[![GitHub license](https://img.shields.io/github/license/allejo/jekyll-docs-theme)](https://github.com/allejo/jekyll-docs-theme/blob/master/LICENSE.md)
 
-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.
+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.
 
-This theme is still in development but is kept fairly stable; just note, there are a lot things yet to come.
+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.
 
-![Theme Screenshot](https://raw.githubusercontent.com/allejo/jekyll-docs-theme/master/screenshot.png)
+## Screenshots
 
-## Installation
+**Light Mode**
 
-Fork this project
+![Theme Screenshot](./screenshot.png)
 
--or-
+**Dark Mode**
 
-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/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/umd/popper.min.js"
+    integrity="sha256-/ijcOLwFf26xEYAjW75FizKVo5tnTYiQddPZoLUHHZ8=" 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>

data/_includes/head/base.html

@@ -0,0 +1,3 @@
+<meta charset="utf-8">
+<meta http-equiv="X-UA-Compatible" content="IE=edge">
+<meta name="viewport" content="width=device-width, initial-scale=1">

data/_includes/head/content.html

@@ -0,0 +1,8 @@
+{% assign pageTitle = page.title | default: site.name ~ ' ' ~ site.project.version | escape %}
+{% assign pageDescription = page.description | page.excerpt | default: site.description %}
+
+<title>{{ pageTitle | strip_html |  escape }}</title>
+<meta name="description" content="{{ pageDescription | strip_html | normalize_whitespace | truncate: 160 | escape }}">
+
+<link rel="canonical" href="{{ page.url | replace: 'index.html', '' | absolute_url }}">
+<link rel="alternate" type="application/rss+xml" title="{{ site.title | escape }}" href="{{ '/feed.xml' | relative_url }}">

data/_includes/head/full.html

@@ -0,0 +1,9 @@
+{% include head/base.html %}
+
+{% include head/content-pre.html %}
+{% include head/content.html %}
+{% include head/content-post.html %}
+
+{% include head/stylesheets-pre.html %}
+{% include head/stylesheets.html %}
+{% include head/stylesheets-post.html %}

data/_includes/head/stylesheets.html

@@ -0,0 +1,16 @@
+<link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/twitter-bootstrap/4.4.1/css/bootstrap.min.css"
+    integrity="sha256-L/W5Wfqfa0sdBNIKN9cG6QA5F2qx4qICmU2VgLruv9Y="
+    crossorigin="anonymous"
+/>
+<link
+    rel="stylesheet"
+    href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.12.1/css/all.min.css"
+    integrity="sha256-mmgLkCYLUQbXn0B1SRqzHar6dCnv9oZFPEC1g1cwlkk="
+    crossorigin="anonymous"
+/>
+<link
+    rel="stylesheet"
+    href="{{ '/assets/css/styles.css' | relative_url }}"
+/>

data/_includes/internal/variables.html

@@ -0,0 +1,21 @@
+{%- assign site_ui_mode = site.ui.mode | default: 'auto' -%}
+
+{%- assign site_ui_brand_dark = site.ui.brand.dark | default: '#00ceff' -%}
+{%- assign site_ui_brand_light = site.ui.brand.light | default: '#a20000' -%}
+
+{%- assign site_ui_border_color_dark = site.ui.border_color.dark | default: '#5f5f5f' -%}
+{%- assign site_ui_border_color_light = site.ui.border_color.light | default: '#dee2e6' -%}
+
+{%- if site.ui.header.trianglify == true or site.ui.header.trianglify == false -%}
+    {%- assign site_ui_header_trianglify = site.ui.header.trianglify -%}
+{%- else -%}
+    {%- assign site_ui_header_trianglify = true -%}
+{%- endif -%}
+
+{%- assign site_ui_header_dark_color1 = site.ui.header.dark.color1 | default: '#062a48' -%}
+{%- assign site_ui_header_dark_color2 = site.ui.header.dark.color2 | default: '#304e67' -%}
+{%- assign site_ui_header_light_color1 = site.ui.header.light.color1 | default: '#080331' -%}
+{%- assign site_ui_header_light_color2 = site.ui.header.light.color2 | default: '#673051' -%}
+
+{%- assign site_ui_masthead_color_dark = site.ui.masthead.color.dark | default: '#fff' -%}
+{%- assign site_ui_masthead_color_light = site.ui.masthead.color.light | default: '#fff' -%}

data/_includes/jekyll-docs-theme/anchor_headings.html

@@ -0,0 +1,34 @@
+{% assign fm_anchorClass = layout.anchor_headings.anchorClass | default: page.anchor_headings.anchorClass | default: "" %}
+
+{% capture anchorClass -%}
+    {{- include.anchorClass -}}
+    {%- if fm_anchorClass -%}
+        .{{- fm_anchorClass -}}
+    {%- endif -%}
+{%- endcapture %}
+
+{% assign beforeHeading = page.anchor_headings.beforeHeading | default: layout.anchor_headings.beforeHeading | default: false %}
+{% assign anchorAttrs   = page.anchor_headings.anchorAttrs   | default: layout.anchor_headings.anchorAttrs   | default: '' %}
+{% assign anchorBody    = page.anchor_headings.anchorBody    | default: layout.anchor_headings.anchorBody    | default: "#" %}
+{% assign anchorTitle   = page.anchor_headings.anchorTitle   | default: layout.anchor_headings.anchorTitle   | default: '' %}
+{% assign h_min         = page.anchor_headings.h_min         | default: layout.anchor_headings.h_min         | default: 1 %}
+{% assign h_max         = page.anchor_headings.h_max         | default: layout.anchor_headings.h_max         | default: 6 %}
+{% assign bodyPrefix    = page.anchor_headings.bodyPrefix    | default: layout.anchor_headings.bodyPrefix    | default: '' %}
+{% assign bodySuffix    = page.anchor_headings.bodySuffix    | default: layout.anchor_headings.bodySuffix    | default: '' %}
+
+{% unless page.disable_anchors %}
+    {% include jekyll-docs-theme/vendor/anchor_headings.html
+         html=content
+         beforeHeading=beforeHeading
+         anchorAttrs=anchorAttrs
+         anchorBody=anchorBody
+         anchorClass=anchorClass
+         anchorTitle=anchorTitle
+         h_min=h_min
+         h_max=h_max
+         bodyPrefix=bodyPrefix
+         bodySuffix=bodySuffix
+    %}
+{% else %}
+    {{ content }}
+{% endunless %}