linaro-jekyll-theme 4.1.6 → 4.2.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ba99ea2174690abd62fbfc32fada2fd23d43a78829ac065bfabd0eb6dc60fb04
-  data.tar.gz: bd3417fb52aee72a77e98cd94878ef8995d3f82fbd2c348cfdffa01ac13f8fbe
+  metadata.gz: fab8bda675a0245790de866e06a17402ab42cb4f26fd1f2505dfa6f0603ee3eb
+  data.tar.gz: 594172c96c574de0b37870e659327d296047a2cfd83ebb142ece2555083212d0
 SHA512:
-  metadata.gz: 17beace2c5d9b39f83cf421438327dc237a2d0309ef2909ac7812ece45c5dec882172c4ca20550ebeabaa1eabce8cf36e9537a8bf870863c606c1602f914ffa3
-  data.tar.gz: deb7690192801b58d37581473b955d3d082cb9a7b788d69f8403b35f5db40b79fe1aa0785c04dab19f40822ed77f9f0a7ee27b15afadf3d8b51919db6ce8fe26
+  metadata.gz: bb89de18aad2eebfb88630c4f68603d6c79404e3607eb66c8d9745323578f78d3c90bd16dade1cf2a9f67383cc53daf73ebaaed041ee7e677028e9634be6f10c
+  data.tar.gz: 37011c5e78abd009f29e51bbab2b066437d2148a6b1320982235b44c2313a8df4bc2aed9da5296de5c2564279dbd88ddebf7d9daff2ac317ab5b05fedac1fa08

data/_config.yml

@@ -33,6 +33,7 @@ plugins:
   - japr
   - jekyll_picture_tag
   - jekyll-tidy
+  - jekyll-toc
 collections:
   authors:
     output: true
@@ -107,10 +108,19 @@ google_analytics:
 social_media_share_image: /assets/images/social-media-image.png
 # Set the default favicon
 favicon: /assets/images/favicon.png
+# Toggle the animated navbar dropdown feature
+# Navbar dropdowns will open on hover
+hover_nav_dropdowns: true
+# Set the class used to animate dropdowns e.g. fade-up / fade-down
+nav_dropdowns_animation_class: fade-down
+# The bootstrap breakpoint at which the navbars will expand
+nav_expand_breakpoint: lg
 # Site Name - your brand name
 name: Jumbo Jekyll Theme
 # The blog filler element
 blog_filler_element: blog/blog_filler_element.html
+# Breadcrumb banner image
+breadcrumb_banner: /assets/images/breadcrumb-banner.png
 # Placeholder avatar
 avatar_placeholder: /assets/images/avatar-placeholder.jpg
 # Blog Post Image Placholder
@@ -188,3 +198,13 @@ asset_pipeline:
   compress: true
   output_path: assets/js
   gzip: false
+# jekyll-toc
+toc:
+  min_level: 1
+  max_level: 6
+  ordered_list: false
+  no_toc_section_class: no_toc_section
+  list_class: list-group docs_nav sticky-top
+  sublist_class: "list-group"
+  item_class: toc-entry
+  item_prefix: toc-

data/_data/nav.yml

@@ -2,6 +2,11 @@ universal_nav: true
 search:
   enabled: true
   label: Linaro
+expand_breakpoint: lg
+brand:
+  # custom_include: nav/brand.html
+  path: /assets/images/Linaro-Logo.svg
+  alt: Linaro logo
 pages:
   - title: Features
     options:
@@ -25,9 +30,12 @@ pages:
             url: /flow/
           - text: Post
             url: /post/
+          - url: /documentation-page/
+            text: Documentation Page
   - options:
       - text: Overview
         url: /engineering/
+        external: true
       - text: Artificial Intelligence
         url: /engineering/artificial-intelligence/
       - text: Autonomous Vehicles
@@ -49,7 +57,13 @@ pages:
           - text: Power Management
             url: /engineering/core/arm-power-management/
           - text: Power Management EAS
-            url: /engineering/core/arm-power-management/eas/
+            options:
+              - text: Flow
+                url: /flow/
+              - text: Post
+                url: /post/
+              - url: /documentation-page/
+                text: Documentation Page
           - text: Power Management Farm
             url: /engineering/core/arm-power-management/pmwg-farm/
           - text: Security
@@ -67,7 +81,8 @@ pages:
       - text: Multimedia
         url: /engineering/multimedia/
     title: Engineering
-  - title: Membership
-    url: /membership/
+  - title: View on GitHub
+    url: https://www.github.com/linaro-marketing/linaro-jekyll-theme
+    external: true
   - url: /blog/
     title: Blog

data/_data/picture.yml

@@ -155,3 +155,9 @@ markup_presets:
     fallback_format: webp
     fallback_width: 400
     widths: [400]
+  breadcrumb_banner:
+    markup: data_picture
+    attributes:
+      img: 'class="lazyload breadcrumb_image"'
+    formats: [webp, original]
+    widths: [1000, 1200, 2000]

data/_data/sticky_tab_bar.yml

@@ -0,0 +1,24 @@
+pages:
+  # - list:
+  #     - title: Blog
+  #       url: /blog/
+  #       sub-pages: true
+  #     - title: Flow Layout
+  #       url: /flow/
+  #       right: true
+  #   urls: [/, /flow/]
+  - list:
+      - title: Documentation Example
+        url: /documentation-page/
+        sub-pages: true
+      - title: Getting Started
+        url: /flow/
+    urls: [/documentation-page/]
+  - list:
+      - title: __current_page__
+        url: __current_page__
+        sub-pages: true
+      - title: Getting Started
+        url: /flow/
+    sub-pages-enabled: true
+    urls: [/]

data/_includes/blog/post_search_fess.html

@@ -0,0 +1,11 @@
+{% assign data = include.object.payload %}
+<div class="col col-12 ">
+    <div id="post_search" data-search-label="{{data.search_label}}">
+        <input class="form-control form-control-lg" id="search-input" type="text"
+            placeholder="Search {{site.categories[data.category].size}} posts..." />
+        <a class="close_search" href="#">
+            X <span class="sr-only">Clear Search</span>
+        </a>
+        <ul class="list-unstyled p-3" id="results-container"></ul>
+    </div>
+</div>

data/_includes/components/breadcrumb.html

@@ -1,10 +1,13 @@
 {% assign page-url = page.url | split: "/" %}
 {% assign iterator = 2 %}
 {% assign breadcrumb-path = "/" %}
-<nav aria-label="breadcrumb" id="breadcrumb">
+<nav aria-label="breadcrumb" {% if site.breadcrumb_banner %}class="breadcrumb_bg"{% endif %}id="breadcrumb">
+    {% if site.breadcrumb_banner %}
+        {% picture breadcrumb_banner {{site.breadcrumb_banner}} --alt "Breadcrumb banner" %}
+    {% endif %}
     <div class="container">
         <h1>{{page.title}}</h1>
-        <ol class="breadcrumb" itemscope itemtype="http://schema.org/BreadcrumbList">
+        <ol class="breadcrumb mb-0"" itemscope itemtype="http://schema.org/BreadcrumbList">
             <li itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"
             class="breadcrumb-item">
                 <a itemprop="item" href="/">

data/_includes/components/cookie_manager.html

@@ -27,7 +27,7 @@
         <div class="col col-12 col-sm-3">
             <div class="df-switch">
                 <button type="button" class="btn btn-lg btn-toggle active" disabled data-toggle="button" aria-pressed="false"
-                    autocomplete="off">
+                    autocomplete="off" aria-label="Toggle Necessary Cookies">
                     <div class="inner-handle"></div>
                     <div class="handle"></div>
                 </button>
@@ -62,7 +62,7 @@
         <div class="col col-12 col-sm-3">
             <div class="df-switch">
                 <button id="analytics_toggle" type="button" class="btn btn-lg btn-toggle" data-toggle="button" aria-pressed="false"
-                    autocomplete="off">
+                    autocomplete="off" aria-label="Toggle Necessary Cookies">
                     <div class="inner-handle"></div>
                     <div class="handle"></div>
                 </button>

data/_includes/components/jumbotron.html

@@ -5,15 +5,21 @@
         {% for slide in page.jumbotron.slider %}
         <div class="item d-flex align-items-center owl-slide {% if forloop.first %}active{% endif %}">
              {% if slide.image %}
-                {% assign image_path = slide.image  %}
-                {% picture header_slider_image {{image_path}} %}
+                {% assign image_path = slide.image %}
+                {% if slide.image_alt %}
+                    {% capture image_alt %}{{slide.image_alt}}{% endcapture%}
+                {% else %}
+                    {% if slide.title %}{% assign alt_title = slide.title %}{% else %}{% assign alt_title = page.title %}{% endif %}
+                    {% capture image_alt %}{{alt_title}} slider header background{% endcapture%}
+                {% endif %}
+                {% picture header_slider_image {{image_path}} --alt {{image_alt}} %}
             {% endif %}
             <div class="container {% if slide.inner_class %}{{slide.inner_class}}{% endif %}">
                 <div class="inner_content_wrapper">
                 {% if slide.inner-image %}
                     <img class="d-inline-block lazyload"
                         src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="
-                        data-src="{{slide.inner-image}}" alt="Slide {{forloop.index}} inner image" />
+                        data-src="{{slide.inner-image}}" alt="Slide {{forloop.index}}" />
                 {% endif %}
                 {% if slide.title %}
                     <h1 class=" {% if slide.title-class %}{{slide.title-class}}{% endif %}">
@@ -47,7 +53,13 @@
 {% if page.jumbotron.image %}background_image{% endif%} {% if page.jumbotron.class %}{{page.jumbotron.class}}{% endif %}">
     {% if page.jumbotron.image %}
         {% assign image_path = page.jumbotron.image  %}
-        {% picture header_image {{image_path}} %}
+        {% if page.jumbotron.image_alt %}
+            {% capture image_alt %}{{page.jumbotron.image_alt}}{% endcapture%}
+        {% else %}
+            {% if page.jumbotron.title %}{% assign alt_title = page.jumbotron.title %}{% else %}{% assign alt_title = page.title %}{% endif %}
+            {% capture image_alt %}{{alt_title}} header background{% endcapture%}
+        {% endif %}
+        {% picture header_image {{image_path}} --alt {{alt_title}} %}
     {% endif %}
     {% if page.jumbotron.video %}
         <video autoplay muted preload="none" poster="{{page.jumbotron.video.poster}}" playsinline loop id="jumbotronVideo">
@@ -64,7 +76,14 @@
     {% endif %}
     <div class="container {% if page.jumbotron.inner_class %}{{page.jumbotron.inner_class}}{% endif %}">
             <div class="inner_content_wrapper">
-            <h1 class="">{{page.jumbotron.title}}</h1>
+            {% if page.jumbotron.inner-image %}
+                <img class="d-inline-block lazyload"
+                    src="data:image/gif;base64,R0lGODlhAQABAAAAACH5BAEKAAEALAAAAAABAAEAAAICTAEAOw=="
+                    data-src="{{page.jumbotron.inner-image}}" alt="Header inner image" />
+            {% endif %}
+            {% if page.jumbotron.title %}
+                <h1 {% if page.jumbotron.title-class %}class="{{page.jumbotron.title-class}}"{% endif %}>{{page.jumbotron.title}}</h1>
+            {% endif %}
             {% if page.jumbotron.description %}
             <p class="lead">
                 {{page.jumbotron.description }}

data/_includes/components/sticky_tab_bar.html

@@ -0,0 +1,76 @@
+{% if page.sticky_tab_bar.first %}
+    {% assign tab-list = page.sticky_tab_bar %}
+{% else %}
+    {% assign sub-nav-tabs = site.data.sticky_tab_bar.pages %}
+{% endif %}
+{% if sub-nav-tabs %}
+    {% assign page-base =  page.url | split:'/' %}
+    {% for each in sub-nav-tabs %}
+        {% for each-url in each.urls %}
+            {% if each-url == page.url %}
+                {% if each.list %}
+                    {% assign tab-list = each.list %}
+                {% endif %}
+            {% elsif each.sub-pages-enabled %}
+                {% if page.url contains each-url %}
+                    {% assign tab-list = each.list %}
+                {% endif %}
+            {% endif %}
+        {% endfor %}
+        {% if each.custom-include %}
+            {% assign custom-include = each.custom-include %}
+        {% endif %}
+    {% endfor %}
+{% endif %}
+{% if tab-list %}
+<div class="tabbed-area non-sticky-nav" id="tabbed-nav-bar"><!-- Nav tabs Wrapper-->
+    <nav class="navbar navbar-expand-lg navbar-light bg-light {% if site.hover_nav_dropdowns %}hover_animated{% endif %}" role="navigation"><!-- Nav -->
+        <div class="container">
+            <a class="navbar-brand d-block d-lg-none" id="sub-navigation-header" href="#"></a><!-- Navbar Brand -->
+            <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#tabbed-nav-bar-collapse"
+             aria-controls="tabbed-nav-bar-collapse" aria-expanded="false" aria-label="Toggle navigation">
+             <span class="icon-bar"></span>
+             <span class="icon-bar"></span>
+             <span class="icon-bar"></span>
+             <span class="sr-only">Toggle navigation</span>
+            </button>
+            <div class="collapse navbar-collapse" id="tabbed-nav-bar-collapse"><!-- Navbar Collapse -->
+                <ul class="nav nav-pills flex-column flex-lg-row tabbed-nav w-100" id="tab-row" role="tablist">
+                    {% for tab in tab-list %}
+                        {% if tab.options %}
+                            <li class="nav-item dropdown">
+                                <a class="nav-link dropdown-toggle" data-toggle="dropdown" href="#" role="button" aria-haspopup="true" aria-expanded="false">
+                                    {{tab.title}}
+                                </a>
+                                <div class="dropdown-menu {% if site.nav_dropdowns_animation_class %}{{site.nav_dropdowns_animation_class}}{% endif %}">
+                                    {% for option in tab.options %}
+                                        <a class="dropdown-item" href="{{option.url}}">{{option.title}}</a>
+                                    {% endfor %}
+                                </div>
+                            </li>
+                        {% else %}
+                            <li role="presentation" 
+                            class=" nav-item tabbed-nav-btn {% if tab.right %}pull-right{% endif %}">
+                                <a href="{% if tab.url == '__current_page__' %}{{page.url}}{% else %}{{tab.url}}{% endif %}" 
+                                class="nav-link {% if tab.url == '__current_page__'%}active{% elsif page.url == tab.url or tab.sub-pages and page.url contains tab.url or tab.active %}active{% endif %}"
+                                aria-controls="overview" role="link">
+                                    {% if tab.title == "__current_page__" %}
+                                        {{page.title}}
+                                    {% else %}
+                                        {{tab.title}}
+                                    {% endif %}
+                                </a>
+                            </li>
+                        {% endif %}
+                    {% endfor %}
+                    
+                </ul>
+            </div>
+        </div>
+    </nav>
+</div>
+{% elsif custom-include %}
+    {% include {{custom-include}}.html %}
+{% else %}
+No content found - please add to _data/sticky_tab_bar.yml. More information available <a href="/jekyll/includes/sticky-tab-bar/">here</a>.
+{% endif %}

data/_includes/nav/nav.html

@@ -6,9 +6,16 @@
 {% if current_page_url == "/" %}
     {% assign current_page_url  = "do-no-set"%}
 {% endif %}
-<nav class="navbar navbar-expand-md navbar-light bg-light" id="main-navigation">
+{% assign nav_expand_point = site.nav_expand_breakpoint %}
+<nav class="navbar navbar-expand-{{nav_expand_point}} navbar-light bg-light {% if site.hover_nav_dropdowns %}hover_animated{% endif %}" id="main-navigation">
     <div class="container">
-        {% include nav/brand.html %}
+        {% if site.data.nav.brand.custom_include %}
+            {% include {{site.data.nav.brand.custom_include}} %}
+        {% else %}
+            <a class="navbar-brand" href="/">
+                <img src="{{site.data.nav.brand.path}}" alt="{{site.data.nav.brand.alt}}" height="60" class="d-inline-block align-top">
+            </a>
+        {% endif %}
         <button class="navbar-toggler collapsed" type="button" data-toggle="collapse" data-target="#navbar-collapse"
             aria-controls="navbar-collapse " aria-expanded="false" aria-label="Toggle navigation">
             <span class="icon-bar"></span>
@@ -47,15 +54,15 @@
                             {% endif %}
                         {% endfor %}
 
-                        <li  class="nav-item dropdown {{active}}">
+                        <li  class="nav-item dropdown text-center text-{{nav_expand_point}}-left {{active}}">
                             <a class="nav-link dropdown-toggle" href="#" id="dropdown-{{forloop.index}}" role="button" data-toggle="dropdown"
                                 aria-haspopup="true" aria-expanded="false">
                                 {{section.title}}
                             </a>
-                            <ul class="dropdown-menu" aria-labelledby="dropdown-{{forloop.index}}">
+                            <ul class="dropdown-menu {% if site.nav_dropdowns_animation_class %}{{site.nav_dropdowns_animation_class}}{% endif %}" aria-labelledby="dropdown-{{forloop.index}}">
                                 {% for menu_option in section.options %}
                                     {% if menu_option.options %}
-                                    <li class="dropdown-item dropdown {% if section.left %} pull-left {% endif %}">
+                                    <li class="dropdown-item dropdown text-center text-{{nav_expand_point}}-left {% if section.left %} pull-left {% endif %}">
                                         <a href="#" id="dropdown1-{{forloop.index}}" data-toggle="dropdown" aria-haspopup="true"
                                             aria-expanded="false" class="dropdown-toggle">
                                             {{menu_option.text}}
@@ -63,7 +70,7 @@
                                         <ul class="dropdown-menu" aria-labelledby="dropdown1-{{forloop.index}}">
                                         {% for sub-option in menu_option.options %}
                                             {% if sub-option.options %}
-                                                <li class="dropdown-item dropdown">
+                                                <li class="dropdown-item dropdown text-center text-{{nav_expand_point}}-left">
                                                     <a href="#" class="dropdown-toggle" id="dropdown1-1-{{forloop.index}}"
                                                     data-toggle="dropdown" aria-haspopup="true"
                                                     aria-expanded="false">
@@ -71,23 +78,23 @@
                                                     </a>
                                                     <ul class="dropdown-menu" aria-labelledby="dropdown1-1-{{forloop.index}}">
                                                         {% for sub-sub-option in sub-option.options %}
-                                                            <li >
+                                                            <li class="text-center text-{{nav_expand_point}}-left">
                                                                 <a href="{{sub-sub-option.url}}">{{sub-sub-option.text}}</a>
                                                             </li>
                                                         {% endfor %}
                                                     </ul>
                                                 </li>
                                             {% else %}
-                                                <li><a href="{{sub-option.url}}">{{sub-option.text}}</a></li>
+                                                <li class="text-center text-{{nav_expand_point}}-left"><a href="{{sub-option.url}}">{{sub-option.text}}</a></li>
                                             {% endif %}
                                         {% endfor %}
                                         </ul>
                                         </li>
                                     {% else %}
-                                        <li>
+                                        <li class="text-center text-{{nav_expand_point}}-left">
                                             <a href="{{menu_option.url}}">
                                             {{menu_option.text}}
-                                            {% if menu_option.external %}<i class="glyphicon glyphicon-new-window pull-right"></i>{% endif %}
+                                            {% if menu_option.external %}<i class="icon-link-ext-alt float-right"></i>{% endif %}
                                             </a>
                                         </li>
                                     {% endif %}
@@ -106,20 +113,23 @@
                                     {% endif %}
                                 {% endfor %}
                             {% endif %}
-                        <li class="nav-item {{active}}">
-                            <a class="nav-link" href="{{section.url}}">{{section.title}} {% if active == "active" %}<span class="sr-only">(current)</span>{% endif %}</a>
+                        <li class="nav-item text-center text-{{nav_expand_point}}-left {{active}}">
+                            <a class="nav-link" href="{{section.url}}">
+                                {{section.title}} 
+                                {% if section.external %}<i class="icon-link-ext-alt float-right"></i>{% endif %}
+                                {% if active == "active" %}<span class="sr-only">(current)</span>{% endif %}</a>
                         </li>
                     {% endif %}
                 {% endfor %}
                 {% if site.data.nav.search.enabled %}
-                <li class="nav-item dropdown search">
+                <li class="nav-item dropdown text-center text-{{nav_expand_point}}-left search">
                     <a class="nav-link dropdown-toggle" href="#" id="navbarDropdown" role="button" aria-label="Search dropdown" data-toggle="dropdown"
                         aria-haspopup="true" aria-expanded="false">
                         <i class="icon-search"></i>
                     </a>
                     <div class="dropdown-menu" aria-labelledby="navbarDropdown">
                         <form class="form-inline flex-nowrap" action="/search/" method="GET" target="_self" id="search_form">
-                            <input class="form-control border-0" name="q" type="search" placeholder="Search..." aria-label="Search">
+                            <input class="form-control border-0 flex-grow-1" name="q" type="search" placeholder="Search..." aria-label="Search">
                             <button class="btn btn-outline-primary border-0" type="submit">Search</button>
                             <input type="hidden" name="fields.label" value="{{ site.search_label }}">
                         </form>

data/_includes/nav/universal_nav.html

@@ -1,5 +1,6 @@
+{% assign nav_expand_point = site.nav_expand_breakpoint %}
 <!-- Universal NavBar-->
-<nav class="navbar navbar-expand-md navbar-dark" id="universal_nav">
+<nav class="navbar navbar-expand-{{nav_expand_point}} navbar-dark {% if site.hover_nav_dropdowns %}hover_animated{% endif %}" id="universal_nav">
     <div class="container">
         <button class="navbar-toggler collapsed ml-auto" type="button" data-toggle="collapse" data-target="#navbarSupportedContent"
             aria-controls="navbarSupportedContent" aria-expanded="false" aria-label="Toggle navigation">
@@ -18,7 +19,7 @@
                                 aria-haspopup="true" aria-expanded="false">
                                 {{item.title}}
                             </a>
-                            <div class="dropdown-menu" aria-labelledby="universalNavbarDropdown">
+                            <div class="dropdown-menu {% if site.nav_dropdowns_animation_class %}{{site.nav_dropdowns_animation_class}}{% endif %}" aria-labelledby="universalNavbarDropdown">
                                 {% for project-site in item.options %}
                                     <a class="dropdown-item {% if project-site.active %}active{% endif%}" href="{{project-site.url}}">{{project-site.title}}</a>
                                 {% endfor %}

data/_layouts/documentation.html

@@ -0,0 +1,19 @@
+---
+layout: base
+---
+{% include components/breadcrumb.html %}
+{% if page.sticky_tab_bar %} 
+    {% include components/sticky_tab_bar.html object=page %}
+{% endif %}
+<div class="container-fluid main_content" id="content_wrapper">
+  <div class="row" id="doc_content">
+    <div class="container">
+        <div class="row">
+          {% if page.toc %}
+            <div class="col col-12 col-lg-3" id="table-of-contents">{{ content | toc_only }}</div>
+          {% endif %}
+            <div class="col col-12 {% if page.toc %}col-lg-9{% endif %}"id="markdown-content">{{ content | inject_anchors }}</div>
+        </div>
+    </div>
+  </div>
+</div>