jekyll-theme-bas-style-kit 0.2.3 → 0.3.0.pre.rc1

data/_config.yml

@@ -1,38 +1,79 @@
 # This file is **NOT** a standard Jekyll config file. 
 # 
-# It is used to define config options for use by the BAS Style Kit Jekyll Theme, which will be merged together with 
-# individual website options at runtime using the Jekyll Data plugin.
+# It is used to define default config options for this theme.
+# These settings will be merged with site specific settings at runtime, site specific settings override these defaults.
 
-# If any of these options are set within a site's config file, it will override the values defined here.
+# Additional config options are defined using the Jekyll Data plugin, under the `site.data.bsk_jekyll_vars` namespace.
+# E.g. `site.data.bsk_jekyll_vars.bsk_attributes.bsk_version` gives the version of the BAS Style Kit this theme uses.
 
 # Plugins (required by this theme)
+#
 
-gems:
+plugins:
   - jekyll-data
+  - jekyll-tidy
 
-# Set default permalink format
+# Build settings
+#
 
+# Set default permalink format
 permalink: pretty
 
-# Set default development phase
-
-phase: live
-
-# Set default layout
+# Site settings
+#
 
+# Set default layout - the empty `path` acts as a wildcard targetting all files in the site
 defaults:
   -
     scope:
-      path: "" # an empty string here means all files in the project
+      path: ''
     values:
-      layout: "default"
+      layout: 'bas-style-kit/bsk--standard'
 
-# Set default related sites
+# Theme settings
+#
 
-nav_related_sites:
-  -
-    name: BAS Home
-    href: https://www.bas.ac.uk
-  - 
-    name: Discover BAS data
-    href: https://data.bas.ac.uk
+bas_style_kit_jekyll_theme:
+  feature_flags:
+    site:
+      back_to_top_anchor: true
+      standard_header: true
+      standard_footer: true
+    standard_header:
+      cookie_notice: true
+      site_navigation: true
+      development_phase: true
+    standard_footer:
+      divider: true
+      ogl: true
+      legal_policies: true
+  attributes:
+    container: fixed
+    head_title:
+      # Used when `page.title` isn't set
+      default: 'site title'
+      # Appended to either `page.title` or `head_title.default` - e.g. ` - Site Foo`
+      appended: !!null
+    head_description: 'site description'
+    site_brand:
+        text: 'site title'
+        img: !!null
+        img_size: !!null
+        href: '/'
+    site_development_phase: 'alpha'
+    site_feedback_href: '/feedback.html'
+    site_analytics: 
+      id: !!null
+
+    # These settings aren't usually changed
+    head_favicon: 'data:;base64,iVBORw0KGgo='
+    site_back_to_top_target_href: '#site-top'
+    site_footer:
+      ogl:
+        href: 'http://www.nationalarchives.gov.uk/doc/open-government-licence'
+        img: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/img/logos-symbols/ogl-symbol-inverse-transparent-32.png'
+        text_version: 'v3.0'
+      legal_policies:
+        copyright_href: '/legal/copyright.html'
+        cookies_href: '/legal/copyright.html'
+        privacy_href: '/legal/privacy.html'

data/_data/bas-style-kit/bsk-css.yml

@@ -0,0 +1,5 @@
+---
+-
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/css/bas-style-kit.min.css'
+    integrity: 'sha256-yuFC35HZoRiUo5Gkp630hHWFrnmDpoYFsh54qYo2HPc='
+    type: 'remote'

data/_data/bas-style-kit/bsk-js.yml

@@ -0,0 +1,13 @@
+---
+-
+    href: 'https://cdn.web.bas.ac.uk/js-libs/jquery-3.3.1.min.js'
+    integrity: 'sha256-FgpCb/KJQlLNfOu91ta32o/NMZxltwRo8QtmkMRdAu8='
+    type: 'remote'
+-
+    href: 'https://cdn.web.bas.ac.uk/js-libs/js.cookie-2.1.3.min.js'
+    integrity: 'sha256-EareStqgZTnMUqLWtDkCa3SldvB8NPBY8u5C6ZUMWRc='
+    type: 'remote'
+-
+    href: 'https://cdn.web.bas.ac.uk/bas-style-kit/0.3.0/js/bas-style-kit.min.js'
+    integrity: 'sha256-QbuFUcH4HIGWW9ch0hO/j+GkhxP4QNdWWGyHE9lIlc8='
+    type: 'remote'

data/_data/bas-style-kit/bsk-vars.yml

@@ -0,0 +1,3 @@
+---
+theme_version: "0.3.0"
+bsk_version: "0.3.0"

data/_data/menus.yml

@@ -0,0 +1,19 @@
+---
+# The name of this file is a convention set by the Jekyll Menus plugin
+# Source: https://github.com/forestryio/jekyll-menus
+
+site_navigation_primary: []
+
+site_navigation_secondary:
+  - url: '#'
+    title: Part of British Antarctic Survey
+    identifier: site_navigation_launcher
+    weight: 50
+
+site_navigation_launcher:
+  - url: 'https://www.bas.ac.uk'
+    title: BAS Home
+    weight: 1
+  - url: 'https://data.bas.ac.uk'
+    title: Discover BAS Data
+    weight: 100

data/_includes/bas-style-kit/body.html

@@ -0,0 +1,3 @@
+<body>
+    {{ content }}
+</body>

data/_includes/bas-style-kit/bsk-body--analytics-script.html

@@ -0,0 +1,9 @@
+{% if site.bas_style_kit_jekyll_theme.attributes.site_analytics.id %}
+    <script async src="https://www.googletagmanager.com/gtag/js?id=GA_TRACKING_ID"></script>
+    <script>
+    window.dataLayer = window.dataLayer || [];
+    function gtag(){dataLayer.push(arguments);}
+    gtag('js', new Date());
+    gtag('config', '{{ site.bas_style_kit_jekyll_theme.attributes.site_analytics.id }}', { 'anonymize_ip': true });
+    </script>
+{% endif %}

data/_includes/bas-style-kit/bsk-body--back-to-top.html

@@ -0,0 +1,2 @@
+<div id="site-top"></div>
+<a class="bsk-sr-only bsk-sr-only-focusable" href="#site-content">Skip to main content</a> 

data/_includes/bas-style-kit/bsk-body--core-scripts.html

@@ -0,0 +1,8 @@
+{% for script in site.data.bas-style-kit.bsk-js %}
+    <script {% if script.type == 'remote' %}src="{{ script.href }}"{% elsif script.type == 'local' %}src="{{ script.href | prepend: site.baseurl }}"{% endif %} {% if script.integrity %}integrity="{{ script.integrity }}" crossorigin="anonymous"{% endif %}></script>
+{% endfor %}
+{% for script in page.body_js_files %}
+    <script {% if script.type == 'remote' %}src="{{ script.href }}"{% elsif script.type == 'local' %}src="{{ script.href | prepend: site.baseurl }}"{% endif %} {% if script.integrity %}integrity="{{ script.integrity }}" crossorigin="anonymous"{% endif %}></script>
+{% endfor %}
+
+{% include bas-style-kit/bsk-body--analytics-script.html %}

data/_includes/bas-style-kit/bsk-body--standard-footer.html

@@ -0,0 +1,16 @@
+<footer class="site-footer">
+    <div class="bsk-footer bsk-footer-default">
+        <div class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %}">
+            {% include bas-style-kit/bsk-footer--contents.html %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.divider == true %}
+                <div role="separator" class="bsk-footer-divider"></div>
+            {% endif %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.ogl == true %}
+                {% include bas-style-kit/bsk-footer--ogl.html %}
+            {% endif %}
+            {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_footer.legal_policies == true %}
+                {% include bas-style-kit/bsk-footer--legal-policies.html %}
+            {% endif %}
+        </div>
+    </div>
+</footer>

data/_includes/bas-style-kit/bsk-body--standard-header.html

@@ -0,0 +1,17 @@
+{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}
+    {% assign bsk_attributes_container_class = "bsk-container" %}
+{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}
+    {% assign bsk_attributes_container_class = "bsk-container-fluid" %}
+{% endif %}
+
+<header class="site-header">
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_header.cookie_notice == true %}
+        {% include bas-style-kit/bsk-header--cookie-notice.html %}
+    {% endif %}
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_header.site_navigation == true %}
+        {% include bas-style-kit/bsk-header--site-navigation.html %}
+    {% endif %}
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.standard_header.development_phase == true %}
+        {% include bas-style-kit/bsk-header--development-phase.html %}
+    {% endif %}
+</header>

data/_includes/bas-style-kit/bsk-body--standard.html

@@ -0,0 +1,15 @@
+<body>
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.site.back_to_top_anchor == true %}
+        {% include bas-style-kit/bsk-body--back-to-top.html %}
+    {% endif %}
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_header == true %}
+        {% include bas-style-kit/bsk-body--standard-header.html %}
+    {% endif %}
+    <main class="{% if site.bas_style_kit_jekyll_theme.attributes.container == 'fixed' %}bsk-container{% elsif site.bas_style_kit_jekyll_theme.attributes.container == 'fluid' %}bsk-container-fluid{% endif %}" id="site-content">
+        {{ content }}
+    </main>
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.site.standard_footer == true %}
+        {% include bas-style-kit/bsk-body--standard-footer.html %}
+    {% endif %}
+    {% include bas-style-kit/bsk-body--core-scripts.html %}
+</body>

data/_includes/bas-style-kit/bsk-body.html

@@ -0,0 +1,9 @@
+<body>
+    {% if site.bas_style_kit_jekyll_theme.feature_flags.site.back_to_top_anchor == True %}
+        {% include bas-style-kit/bsk-body--back-to-top.html %}
+    {% endif %}
+    <main id="site-content">
+        {{ content }}
+    </main>
+    {% include bas-style-kit/bsk-body--core-scripts.html %}
+</body>

data/_includes/bas-style-kit/bsk-footer--legal-policies.html

@@ -0,0 +1,8 @@
+<div class="bsk-footer-policy-links">
+    © {{site.time | date: "%Y"}} NERC BAS
+    <ul class="bsk-list-inline">
+        <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}"> Cookies</a></li>
+        <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.copyright_href }}"> Copyright</a></li>
+        <li><a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.privacy_href }}"> Privacy</a></li>
+    </ul>
+</div>

data/_includes/bas-style-kit/bsk-footer--ogl.html

@@ -0,0 +1,9 @@
+<div class="bsk-footer-ogl">
+    <a class="bsk-ogl-symbol" rel="license" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href }}">
+        <img alt="Open Government Licence symbol" src="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.img }}" />
+    </a>
+    <div class="bsk-ogl-text">
+        This website is licensed under the 
+        <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.href }}">Open Government Licence {{ site.bas_style_kit_jekyll_theme.attributes.site_footer.ogl.text_version }}</a>
+        , except where otherwise stated</div>
+</div>

data/_includes/bas-style-kit/bsk-head--core-meta.html

@@ -0,0 +1,4 @@
+<meta charset="utf-8">
+<meta name="viewport" content="width=device-width, initial-scale=1, shrink-to-fit=no">
+<meta http-equiv="x-ua-compatible" content='ie=edge'>
+<!-- The above 3 meta tags *must* come first in the head -->

data/_includes/bas-style-kit/bsk-head--core-styles.html

@@ -0,0 +1,6 @@
+{% for style in site.data.bas-style-kit.bsk-css %}
+    <link rel="stylesheet" {% if style.type == 'remote' %}href="{{ style.href }}"{% elsif style.type == 'local' %}href="{{ style.href | prepend: site.baseurl }}"{% endif %} {% if style.integrity %}integrity="{{ style.integrity }}" crossorigin="anonymous"{% endif %}>
+{% endfor %}
+{% for style in page.body_css_files %}
+    <link rel="stylesheet" {% if style.type == 'remote' %}href="{{ style.href }}"{% elsif style.type == 'local' %}href="{{ style.href | prepend: site.baseurl }}"{% endif %} {% if style.integrity %}integrity="{{ style.integrity }}" crossorigin="anonymous"{% endif %}>
+{% endfor %}

data/_includes/bas-style-kit/bsk-head--favicon.html

@@ -0,0 +1,2 @@
+<!-- Favicon and app icons -->
+{% if site.bas_style_kit_jekyll_theme.attributes.head_favicon %}<link rel="icon" href="{{ site.bas_style_kit_jekyll_theme.attributes.head_favicon }}">{% endif %}

data/_includes/bas-style-kit/bsk-head--seo-meta.html

@@ -0,0 +1,4 @@
+<!-- Recommended meta tags for SEO -->
+{% if page.title %}<title>{{ page.title }}{% if site.bas_style_kit_jekyll_theme.attributes.head_title.appended %}{{ site.bas_style_kit_jekyll_theme.attributes.head_title.appended }}{% endif %}</title>
+{% elsif site.bas_style_kit_jekyll_theme.attributes.head_title.default %}<title>{{ site.bas_style_kit_jekyll_theme.attributes.head_title.default }}</title>{% endif %}
+{% if site.bas_style_kit_jekyll_theme.attributes.head_description %}<meta name="description" content="{{ site.bas_style_kit_jekyll_theme.attributes.head_description }}">{% endif %}

data/_includes/bas-style-kit/bsk-head.html

@@ -0,0 +1,6 @@
+<head>
+    {% include bas-style-kit/bsk-head--core-meta.html %}
+    {% include bas-style-kit/bsk-head--seo-meta.html %}
+    {% include bas-style-kit/bsk-head--favicon.html %}
+    {% include bas-style-kit/bsk-head--core-styles.html %}
+</head>

data/_includes/bas-style-kit/bsk-header--cookie-notice.html

@@ -0,0 +1,11 @@
+<div class="bsk-fix-alert-static-top-{{ site.bas_style_kit_jekyll_theme.attributes.container }}-container-wrapper">
+    <div class="{{ bsk_attributes_container_class }}">
+        <div class="bsk-alert bsk-alert-static-top bsk-alert-dismissible bsk-alert-solid bsk-alert-cookie-notice" bsk-role='cookie-notice'>
+            <button class="bsk-close" type="button" data-dismiss="alert" aria-label="Close">
+                <i class="fa fa-times" aria-hidden="true"></i>
+            </button>
+            This website uses cookies to help us make it better - 
+            <a class="bsk-alert-link" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_footer.legal_policies.cookies_href }}">find out more</a>
+        </div>
+    </div>
+</div>

data/_includes/bas-style-kit/bsk-header--development-phase.html

@@ -0,0 +1,12 @@
+{% unless site.bas_style_kit_jekyll_theme.attributes.site_development_phase == 'live-stable' %}
+    <div class="{{ bsk_attributes_container_class }}">
+        {% unless site.bas_style_kit_jekyll_theme.attributes.site_development_phase == 'experimental' %}
+            <span class="bsk-text-uppercase bsk-label bsk-label-phase-{{ site.bas_style_kit_jekyll_theme.attributes.site_development_phase }}">{{ site.bas_style_kit_jekyll_theme.attributes.site_development_phase }}</span>
+            This is a new website – your <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">feedback</a> will help us to improve it.
+        {% else %}
+            <span class="bsk-text-uppercase bsk-label bsk-label-{{ site.bas_style_kit_jekyll_theme.attributes.site_development_phase }}">{{ site.bas_style_kit_jekyll_theme.attributes.site_development_phase }}</span>
+            This website is used for testing – your <a href="{{ site.bas_style_kit_jekyll_theme.attributes.site_feedback_href }}">feedback</a> will help us to improve it.
+        {% endunless %}
+        <hr />
+    </div>
+{% endunless %}

data/_includes/bas-style-kit/bsk-header--site-navigation.html

@@ -0,0 +1,6 @@
+<nav class="bsk-navbar">
+  <div class="{{ bsk_attributes_container_class }}">
+    {% include bas-style-kit/bsk-nav--header.html %}
+    {% include bas-style-kit/bsk-nav--collapse.html %}
+  </div>
+</nav>

data/_includes/bas-style-kit/bsk-nav--collapse.html

@@ -0,0 +1,4 @@
+<div class="bsk-collapse bsk-navbar-collapse" id="navbar-collapse">
+    {% include bas-style-kit/bsk-nav-collapse--primary-navigation.html %}
+    {% include bas-style-kit/bsk-nav-collapse--secondary-navigation.html %}
+</div>

data/_includes/bas-style-kit/bsk-nav--header.html

@@ -0,0 +1,4 @@
+<div class="bsk-navbar-header">
+    {% include bas-style-kit/bsk-nav-header--collapse-trigger.html %}
+    {% include bas-style-kit/bsk-nav-header--brand.html %}
+</div>

data/_includes/bas-style-kit/bsk-nav-collapse--primary-navigation.html

@@ -0,0 +1,32 @@
+{% if site.menus.site_navigation_primary %}
+    <ul class="bsk-nav bsk-navbar-nav">
+        {% for item in site.menus.site_navigation_primary %}
+            {% if item.children %}
+                {% assign is_active = false %}
+                {% for item in item.children %}
+                    {% if page.url == item.url %}
+                        {% assign is_active = true %}
+                    {% endif %}
+                {% endfor %}
+                <li class="bsk-dropdown {% if is_active == true %}bsk-active{% endif %}">
+                    <a class="bsk-dropdown-toggle" href="#" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
+                        {{ item.title }} <span class="bsk-caret"></span>
+                    </a>
+                    <ul class="bsk-dropdown-menu">
+                        {% for item in item.children %}
+                            <li {% if page.url == item.url %}class="bsk-active"{% endif %}>
+                                {% if page.url == item.url %}<span class="bsk-sr-only">(current)</span>{% endif %}
+                                <a href="{{ item.url }}">{{ item.title }}</a>
+                            </li>
+                        {% endfor %}
+                    </ul>
+                </li>
+            {% else %}
+                <li {% if page.url == item.url %}class="bsk-active"{% endif %}>
+                    {% if page.url == item.url %}<span class="bsk-sr-only">(current)</span>{% endif %}
+                    <a href="{{ item.url }}">{{ item.title }}</a>
+                </li>
+            {% endif %}
+        {% endfor %}
+    </ul>
+{% endif %}

data/_includes/bas-style-kit/bsk-nav-collapse--secondary-navigation.html

@@ -0,0 +1,20 @@
+{% if site.menus.site_navigation_secondary %}
+    <ul class="bsk-nav bsk-navbar-nav bsk-navbar-right">
+        {% for item in site.menus.site_navigation_secondary %}
+            {% if item.children %}
+                <li class="bsk-dropdown">
+                    <a class="bsk-dropdown-toggle" href="#" data-toggle="dropdown" role="button" aria-haspopup="true" aria-expanded="false">
+                        {{ item.title }} <span class="bsk-caret"></span>
+                    </a>
+                    <ul class="bsk-dropdown-menu">
+                        {% for sub_item in item.children %}
+                            <li><a href="{{ sub_item.url }}">{{ sub_item.title }}</a></li>
+                        {% endfor %}
+                    </ul>
+                </li>
+            {% else %}
+                <li><a href="{{ item.url }}">{{ item.title }}</a></li>
+            {% endif %}
+        {% endfor %}
+    </ul>
+{% endif %}

data/_includes/bas-style-kit/bsk-nav-header--brand.html

@@ -0,0 +1,8 @@
+<a class="bsk-navbar-brand {% if site.bas_style_kit_jekyll_theme.attributes.site_brand.img %}bsk-navbar-brand-image-{{ site.bas_style_kit_jekyll_theme.attributes.site_brand.img_size }}{% endif %}" href="{{ site.bas_style_kit_jekyll_theme.attributes.site_brand.href }}">
+    {% if site.bas_style_kit_jekyll_theme.attributes.site_brand.img %}
+        <img {% if site.bas_style_kit_jekyll_theme.attributes.site_brand.text %}class="bsk-fix-navbar-brand-img-txt"{% endif %} src="{{ site.bas_style_kit_jekyll_theme.attributes.site_brand.img }}">
+    {% endif %}
+    {% if site.bas_style_kit_jekyll_theme.attributes.site_brand.text %}
+        {{ site.bas_style_kit_jekyll_theme.attributes.site_brand.text }}
+    {% endif %}
+</a>

data/_includes/bas-style-kit/bsk-nav-header--collapse-trigger.html

@@ -0,0 +1,6 @@
+<button class="bsk-navbar-toggle bsk-collapsed" type="button" data-toggle="collapse" data-target="#navbar-collapse" aria-expanded="false">
+    <span class="bsk-sr-only">Toggle navigation</span>
+    <span class="bsk-icon-bar"></span>
+    <span class="bsk-icon-bar"></span>
+    <span class="bsk-icon-bar"></span>
+</button>

data/_includes/bas-style-kit/head.html

@@ -0,0 +1 @@
+<head></head>

data/_layouts/bas-style-kit/blank.html

@@ -0,0 +1,4 @@
+---
+layout: none
+---
+{{ content }}

data/_layouts/bas-style-kit/bsk--base.html

@@ -0,0 +1,8 @@
+---
+layout: blank
+---
+<!DOCTYPE html>
+<html lang="en-GB">
+    {% include bas-style-kit/bsk-head.html %}
+    {% include bas-style-kit/bsk-body.html %}
+</html>

data/_layouts/bas-style-kit/bsk--standard.html

@@ -0,0 +1,8 @@
+---
+layout: blank
+---
+<!DOCTYPE html>
+<html lang="en-GB">
+    {% include bas-style-kit/bsk-head.html %}
+    {% include bas-style-kit/bsk-body--standard.html %}
+</html>