jekyll-docs-theme 0.1.2 → 1.0.0

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

@@ -0,0 +1,38 @@
+{% assign fm_class        = layout.table_of_contents.class        | default: page.table_of_contents.class        | default: "" %}
+{% assign fm_anchor_class = layout.table_of_contents.anchor_class | default: page.table_of_contents.anchor_class | default: "" %}
+
+{% capture class -%}
+    {{- include.class -}}
+    {%- if fm_class != "" -%}
+        .{{- fm_class -}}
+    {%- endif -%}
+{%- endcapture %}
+
+{% capture anchor_class %}
+    {{- include.anchor_class -}}
+    {%- if fm_anchor_class != "" -%}
+        .{{- fm_anchor_class -}}
+    {%- endif -%}
+{% endcapture %}
+
+{% assign sanitize   = page.table_of_contents.sanitize   | default: layout.table_of_contents.sanitize   | default: false %}
+{% assign h_min      = page.table_of_contents.h_min      | default: layout.table_of_contents.h_min      | default: 1 %}
+{% assign h_max      = page.table_of_contents.h_max      | default: layout.table_of_contents.h_max      | default: 3 %}
+{% assign ordered    = page.table_of_contents.ordered    | default: layout.table_of_contents.ordered    | default: false %}
+{% assign item_class = page.table_of_contents.item_class | default: layout.table_of_contents.item_class | default: '' %}
+{% assign baseurl    = page.table_of_contents.baseurl    | default: layout.table_of_contents.baseurl    | default: '' %}
+{% assign skipNoIDs  = page.table_of_contents.skipNoIDs  | default: layout.table_of_contents.skipNoIDs  | default: false %}
+
+{% include jekyll-docs-theme/vendor/toc.html
+     html=content
+     id=include.id
+     class=class
+     sanitize=sanitize
+     h_min=h_min
+     h_max=h_max
+     ordered=ordered
+     item_class=item_class
+     baseurl=baseurl
+     anchor_class=anchor_class
+     skipNoIDs=skipNoIDs
+%}

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

@@ -0,0 +1,110 @@
+{% capture headingsWorkspace %}
+  {% comment %}
+    Version 1.0.6
+      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`;
+                                          the `%heading%` placeholder is available
+      * 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 | replace: '%heading%', header }}{% 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/jekyll-docs-theme/vendor/toc.html

@@ -0,0 +1,112 @@
+{% capture tocWorkspace %}
+    {% comment %}
+        Version 1.0.11
+          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
+            * skipNoIDs    (bool)   : false  - skip headers that do not have an `id` attribute
+
+        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 skipNoIDs = include.skipNoIDs | 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 %}
+
+        {% if skipNoIDs == true %}
+            {% unless node contains "id=" %}
+                {% continue %}
+            {% endunless %}
+        {% 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 %}
+        {% assign _workspace = node | split: '</h' %}
+
+        {% assign _idWorkspace = _workspace[0] | split: 'id="' %}
+        {% assign _idWorkspace = _idWorkspace[1] | split: '"' %}
+        {% assign html_id = _idWorkspace[0] %}
+
+        {% assign _classWorkspace = _workspace[0] | split: 'class="' %}
+        {% assign _classWorkspace = _classWorkspace[1] | split: '"' %}
+        {% assign html_class = _classWorkspace[0] %}
+
+        {% if html_class contains "no_toc" %}
+            {% continue %}
+        {% endif %}
+
+        {% 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 %}
+
+        {% if include.item_class and include.item_class != blank %}
+            {% capture listItemClass %}{:.{{ include.item_class | replace: '%level%', headerLevel }}}{% endcapture %}
+        {% endif %}
+
+        {% capture anchor_body %}{% if include.sanitize %}{{ header | strip_html }}{% else %}{{ header }}{% endif %}{% endcapture %}
+        {% capture anchor_body %}{{ anchor_body | replace: "|", "\|" }}{% endcapture %}
+
+        {% if html_id %}
+            {% capture list_item %}[{{ anchor_body }}]({% if include.baseurl %}{{ include.baseurl }}{% endif %}#{{ html_id }}){% endcapture %}
+        {% else %}
+            {% capture list_item %}{{ anchor_body }}{% endcapture %}
+        {% endif %}
+
+        {% capture my_toc %}{{ my_toc }}
+{{ space }}{{ listModifier }} {{ listItemClass }} {{ list_item }}{% if include.anchor_class %}{:.{{ include.anchor_class }}}{% endif %}{% endcapture %}
+    {% endfor %}
+
+    {% if include.class and include.class != blank %}
+        {% 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/_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,62 @@
-<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">
-                {% assign sorted_pages = site.pages | sort: "name" %}
+        <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: "title" %}
                 {% 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>
+                    {% assign is_homepage = false %}
+                    {% if p.homepage == true or p.isHome == true %}
+                        {% assign is_homepage = true %}
+                    {% endif %}
+
+                    {% assign show_in_menu = true %}
+                    {% if p.show_in_menu != nil and p.show_in_menu == false %}
+                        {% assign show_in_menu = false %}
+                    {% elsif p.hide != nil and p.hide == true %}
+                        {% assign show_in_menu = false %}
+                    {% endif %}
+
+                    {% if is_homepage != true and show_in_menu == 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/sidebar/content.html

@@ -0,0 +1,10 @@
+<nav id="page-toc" class="page-sidebar">
+    {% include jekyll-docs-theme/toc.html
+         class="list-unstyled.pl-0"
+         anchor_class="nav-link.px-3.py-1"
+    %}
+
+    <a class="px-3 text-muted" href="#top">
+        <small>Back to top</small>
+    </a>
+</nav>

data/_layouts/default.html

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