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

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/masthead.html

@@ -0,0 +1,13 @@
+{% capture alignment_class -%}
+    {%- if page.homepage -%}
+        text-{{ site.ui.masthead.align.homepage | default: 'center' }}
+    {%- else -%}
+        text-{{ site.ui.masthead.align.page | default: 'left' }}
+    {%- endif -%}
+{%- endcapture %}
+<div class="site-masthead mb-5 py-5 {{ alignment_class }}">
+    <div class="container">
+        {% include masthead/title.html %}
+        {% include masthead/buttons.html %}
+    </div>
+</div>

data/_includes/masthead/button.html

@@ -0,0 +1,11 @@
+<a
+    href="{{ include.url }}"
+    class="site-masthead__button mx-2 mb-2"
+>
+    {% include fa-icon.html
+         icon=include.icon
+         brand=include.brand
+         class="mr-1"
+    %}
+    {{ include.title }}
+</a>

data/_includes/masthead/buttons.html

@@ -0,0 +1,30 @@
+{% if page.homepage %}
+    <div class="mt-4 mb-0">
+        {% if site.project.download_url %}
+            {% capture button_text -%}
+                {{ site.project.download_text | default: 'Download' }}
+            {%- endcapture %}
+
+            {% include masthead/button.html
+                 url=site.project.download_url
+                 icon="download"
+                 title=button_text
+            %}
+        {% endif %}
+
+        {% for link in site.links.homepage %}
+            {% include masthead/button.html
+                   url=link.url
+                   icon=link.icon
+                   title=link.title
+                   brand=link.brand
+            %}
+        {% endfor %}
+    </div>
+
+    {% if site.project.version %}
+        <p class="site-masthead__version my-0">
+            Latest release v{{ site.project.version }}
+        </p>
+    {% endif %}
+{% endif %}

data/_includes/masthead/title.html

@@ -0,0 +1,7 @@
+<h1 class="site-masthead__title mb-1">{{ page.title | default: site.name }}</h1>
+
+{% if page.description %}
+    <p class="site-masthead__description mb-0">
+        {{ page.description }}
+    </p>
+{% endif %}

data/_includes/navigation.html

@@ -1,32 +1,50 @@
-<header class="navbar navbar-static-top bs-docs-nav" id="top">
+<header class="navbar navbar-expand-md navbar-custom" id="top">
     <div class="container">
-        <div class="navbar-header" role="banner">
-            <button class="navbar-toggle" type="button" data-toggle="collapse" data-target=".bs-navbar-collapse">
-                <span class="sr-only">Toggle navigation</span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-                <span class="icon-bar"></span>
-            </button>
-            <a class="navbar-brand" href="{{ 'index.html' | relative_url }}">{{ site.name }}</a>
-        </div>
-        <nav class="collapse navbar-collapse bs-navbar-collapse" role="navigation">
-            <ul class="nav navbar-nav">
+        <a class="navbar-brand" href="{{ '/' | relative_url }}">{{ site.name }}</a>
+
+        <button
+            class="navbar-toggler"
+            type="button"
+            data-toggle="collapse"
+            data-target="#navbarSupportedContent"
+            aria-controls="navbarSupportedContent"
+            aria-expanded="false"
+            aria-label="Toggle navigation"
+        >
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+            <span class="icon-bar"></span>
+        </button>
+
+        <nav class="navbar-collapse collapse" role="navigation" id="navbarSupportedContent">
+            <ul class="navbar-nav">
                 {% assign sorted_pages = site.pages | sort: "name" %}
                 {% for p in sorted_pages %}
-                    {% if p.isHome != true and p.hide != true and p.title !=  %}
-                        <li {% if page.title == p.title %}class="active"{% endif %}>
-                            <a href="{{ p.url | relative_url }}">{{ p.title }}</a>
+                    {% if p.isHome != true and p.hide != true and p.title %}
+                        <li class="nav-item {% if page.title == p.title %}active{% endif %}">
+                            <a
+                                class="nav-link"
+                                href="{{ p.url | relative_url }}"
+                            >
+                                {{ p.title }}
+                            </a>
                         </li>
                     {% endif %}
                 {% endfor %}
             </ul>
-            <ul class="nav navbar-nav navbar-right">
+            <ul class="navbar-nav ml-auto">
                 {% for p in site.links.header %}
-                    <li>
-                        <a href="{{ p.url }}">{{ p.title }}</a>
+                    <li class="nav-item {% if page.title == p.title %}active{% endif %}">
+                        <a
+                            class="nav-link"
+                            href="{{ p.url }}"
+                        >
+                            {% include fa-icon.html icon=p.icon brand=p.brand %}
+                            {{ p.title }}
+                        </a>
                     </li>
                 {% endfor %}
             </ul>
         </nav>
     </div>
-</header>
+</header>

data/_includes/toc.html

@@ -0,0 +1,87 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.6
+          https://github.com/allejo/jekyll-toc
+
+        "...like all things liquid - where there's a will, and ~36 hours to spare, there's usually a/some way" ~jaybe
+
+        Usage:
+            {% include toc.html html=content sanitize=true class="inline_toc" id="my_toc" h_min=2 h_max=3 %}
+
+        Parameters:
+            * html         (string) - the HTML of compiled markdown generated by kramdown in Jekyll
+
+        Optional Parameters:
+            * sanitize     (bool)   : false  - when set to true, the headers will be stripped of any HTML in the TOC
+            * class        (string) :   ''   - a CSS class assigned to the TOC
+            * id           (string) :   ''   - an ID to assigned to the TOC
+            * h_min        (int)    :   1    - the minimum TOC header level to use; any header lower than this value will be ignored
+            * h_max        (int)    :   6    - the maximum TOC header level to use; any header greater than this value will be ignored
+            * ordered      (bool)   : false  - when set to true, an ordered list will be outputted instead of an unordered list
+            * item_class   (string) :   ''   - add custom class(es) for each list item; has support for '%level%' placeholder, which is the current heading level
+            * baseurl      (string) :   ''   - add a base url to the TOC links for when your TOC is on another page than the actual content
+            * anchor_class (string) :   ''   - add custom class(es) for each anchor element
+
+        Output:
+            An ordered or unordered list representing the table of contents of a markdown block. This snippet will only
+            generate the table of contents and will NOT output the markdown given to it
+    {% endcomment %}
+
+    {% capture my_toc %}{% endcapture %}
+    {% assign orderedList = include.ordered | default: false %}
+    {% assign minHeader = include.h_min | default: 1 %}
+    {% assign maxHeader = include.h_max | default: 6 %}
+    {% assign nodes = include.html | split: '<h' %}
+    {% assign firstHeader = true %}
+
+    {% capture listModifier %}{% if orderedList %}1.{% else %}-{% endif %}{% endcapture %}
+
+    {% for node in nodes %}
+        {% if node == "" %}
+            {% continue %}
+        {% endif %}
+
+        {% assign headerLevel = node | replace: '"', '' | slice: 0, 1 | times: 1 %}
+
+        {% if headerLevel < minHeader or headerLevel > maxHeader %}
+            {% continue %}
+        {% endif %}
+
+        {% if firstHeader %}
+            {% assign firstHeader = false %}
+            {% assign minHeader = headerLevel %}
+        {% endif %}
+
+        {% assign indentAmount = headerLevel | minus: minHeader | add: 1 %}
+        {% 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, '' %}
+
+        {% assign space = '' %}
+        {% for i in (1..indentAmount) %}
+            {% assign space = space | prepend: '    ' %}
+        {% endfor %}
+
+        {% unless include.item_class == blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endunless %}
+
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} [{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
+    {% endfor %}
+
+    {% if include.class %}
+        {% capture my_toc %}{:.{{ include.class }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+
+    {% if include.id %}
+        {% capture my_toc %}{: #{{ include.id }}}
+{{ my_toc | lstrip }}{% endcapture %}
+    {% endif %}
+{% endcapture %}{% assign tocWorkspace = '' %}{{ my_toc | markdownify | strip }}

data/_layouts/default.html

@@ -1,15 +1,15 @@
 <!DOCTYPE html>
 <html lang="en" class="no-js">
     <head>
-        {% include head.html %}
+        {% include head/full.html %}
     </head>
 
-    <body>
+    <body data-spy="scroll" data-target="#page-toc" data-offset="0">
         {% include navigation.html %}
-        {% include jumbotron.html %}
+        {% include masthead.html %}
 
         {{ content }}
 
-        {% include footer.html %}
+        {% include footer/full.html %}
     </body>
 </html>

data/_layouts/full.html

@@ -2,8 +2,10 @@
 layout: default
 ---
 
-<div class="container bs-docs-container">
-    <div class="bs-docs-section" role="main">{{ content }}</div>
+<div class="container">
+    <div class="scope-markdown" role="main">
+        {% include anchor_headings.html html=content anchorBody="#" anchorClass="heading-anchor" %}
+    </div>
 
     {% include disqus.html %}
-</div>
+</div>

data/_layouts/page.html

@@ -3,19 +3,54 @@ layout: default
 ---
 
 <div class="container">
-    <div class="bs-docs-container row">
-        <div class="col-md-12" role="main">
-            <div class="bs-docs-section">{{ content }}</div>
-        </div>
+    <div class="row">
+        <main class="col-md-9">
+            <section class="mobile-toc border mb-3 p-3 d-md-none">
+                <div class="d-flex align-items-center">
+                    <h2 class="mb-0">Table of Contents</h2>
 
-        <div class="col-md-3 bs-docs-sidebar hidden-print" role="complementary">
-            <ul class="nav bs-docs-sidenav"></ul>
+                    <button
+                        class="js-only ml-2 toggle-toc"
+                        aria-controls="mobileTOC"
+                        aria-label="Toggle table of contents"
+                        aria-expanded="true"
+                    >
+                        <span aria-hidden="true" data-role="toggle">Hide</span>
+                    </button>
+                </div>
 
-            <a class="back-to-top" href="#top"> <i class="glyphicon glyphicon-chevron-up"></i>
-                Back to top
-            </a>
-        </div>
+                {% include toc.html
+                     html=content
+                     class="js-toc.mb-0.mt-2"
+                     id="mobileTOC"
+                     h_max=3
+                %}
+            </section>
+
+            <section class="scope-markdown">
+                {% include anchor_headings.html
+                     html=content
+                     anchorBody="#"
+                     anchorClass="heading-anchor"
+                %}
+            </section>
+        </main>
+
+        <aside class="col-md-3 d-none d-md-block hidden-print">
+            <nav id="page-toc" class="page-sidebar">
+                {% include toc.html
+                     html=content
+                     class="list-unstyled.pl-0"
+                     anchor_class="nav-link.px-3.py-1"
+                     h_max=3
+                %}
+
+                <a class="px-3 text-muted" href="#top">
+                    <small>Back to top</small>
+                </a>
+            </nav>
+        </aside>
     </div>
 
     {% include disqus.html %}
-</div>
+</div>

data/_sass/abstracts/_highlight-dark.scss

@@ -0,0 +1,136 @@
+@mixin highlight-dark-theme() {
+    // "Zenburn" Theme
+    // https://github.com/jwarby/jekyll-pygments-themes
+
+    .highlight .hll {
+        background-color:#222;
+    }
+
+    .highlight .err {
+        color:#e37170;
+        background-color:#3d3535;
+    }
+
+    .highlight .k {
+        color:#f0dfaf;
+    }
+
+    .highlight .p {
+        color:#41706f;
+    }
+
+    .highlight .cs {
+        color:#cd0000;
+        font-weight:700;
+    }
+
+    .highlight .gd {
+        color:#cd0000;
+    }
+
+    .highlight .ge {
+        color:#ccc;
+        font-style:italic;
+    }
+
+    .highlight .gr {
+        color:red;
+    }
+
+    .highlight .go {
+        color:gray;
+    }
+
+    .highlight .gs {
+        color:#ccc;
+        font-weight:700;
+    }
+
+    .highlight .gu {
+        color:purple;
+        font-weight:700;
+    }
+
+    .highlight .gt {
+        color:#0040D0;
+    }
+
+    .highlight .kc {
+        color:#dca3a3;
+    }
+
+    .highlight .kd {
+        color:#ffff86;
+    }
+
+    .highlight .kn {
+        color:#dfaf8f;
+        font-weight:700;
+    }
+
+    .highlight .kp {
+        color:#cdcf99;
+    }
+
+    .highlight .kr {
+        color:#cdcd00;
+    }
+
+    .highlight .ni {
+        color:#c28182;
+    }
+
+    .highlight .ne {
+        color:#c3bf9f;
+        font-weight:700;
+    }
+
+    .highlight .nn {
+        color:#8fbede;
+    }
+
+    .highlight .vi {
+        color:#ffffc7;
+    }
+
+    .highlight .c,.preview-zenburn .highlight .g,.preview-zenburn .highlight .cm,.preview-zenburn .highlight .cp,.preview-zenburn .highlight .c1 {
+        color:#7f9f7f;
+    }
+
+    .highlight .l,.preview-zenburn .highlight .x,.preview-zenburn .highlight .no,.preview-zenburn .highlight .nd,.preview-zenburn .highlight .nl,.preview-zenburn .highlight .nx,.preview-zenburn .highlight .py,.preview-zenburn .highlight .w {
+        color:#ccc;
+    }
+
+    .highlight .n,.preview-zenburn .highlight .nv,.preview-zenburn .highlight .vg {
+        color:#dcdccc;
+    }
+
+    .highlight .o,.preview-zenburn .highlight .ow {
+        color:#f0efd0;
+    }
+
+    .highlight .gh,.preview-zenburn .highlight .gp {
+        color:#dcdccc;
+        font-weight:700;
+    }
+
+    .highlight .gi,.preview-zenburn .highlight .kt {
+        color:#00cd00;
+    }
+
+    .highlight .ld,.preview-zenburn .highlight .s,.preview-zenburn .highlight .sb,.preview-zenburn .highlight .sc,.preview-zenburn .highlight .sd,.preview-zenburn .highlight .s2,.preview-zenburn .highlight .se,.preview-zenburn .highlight .sh,.preview-zenburn .highlight .si,.preview-zenburn .highlight .sx,.preview-zenburn .highlight .sr,.preview-zenburn .highlight .s1,.preview-zenburn .highlight .ss {
+        color:#cc9393;
+    }
+
+    .highlight .m,.preview-zenburn .highlight .mf,.preview-zenburn .highlight .mh,.preview-zenburn .highlight .mi,.preview-zenburn .highlight .mo,.preview-zenburn .highlight .il {
+        color:#8cd0d3;
+    }
+
+    .highlight .na,.preview-zenburn .highlight .nt {
+        color:#9ac39f;
+    }
+
+    .highlight .nb,.preview-zenburn .highlight .nc,.preview-zenburn .highlight .nf,.preview-zenburn .highlight .bp,.preview-zenburn .highlight .vc {
+        color:#efef8f;
+    }
+}