fenton-jekyll-boilerplate 0.0.3 → 0.0.5

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: f8a2c828a5f914d7e9e56e8245a39a2b77f44e3f22924f7cf0919ae62b005acf
-  data.tar.gz: 7e78f2f84bfcc15c4784aeabe255e04b4a8643bdfb83ac8c9fc7aacdd90de83c
+  metadata.gz: 8e62bb1bc58c9c86331a322e70bb7d8b16ce251dcc572d89361617e9f994bf53
+  data.tar.gz: 1d25e7531752be6c2690eb81843a24b1dce2a343381df86546e9bf6a0465cd40
 SHA512:
-  metadata.gz: 1ac5c044c8156b95777ce7851a020eaeb72c7dc929769f05d911b301718889866bcad742da1dfa92cafe3184fa527b462ceb59f65dcd0161742b09d3d4f3bd1a
-  data.tar.gz: a826ee42744b3bddc4e1ceda2335b413586fe407d42c08ef3cfcbedd03fb8bf80f50ca8e02187f68d3addb353320f97a99bf709d002ca1b15da7331b1021e3bc
+  metadata.gz: 37d7589c85c4853b70fff3699c32400a1ce2d7a1374804270bac303be382bedb22c7403ffaad665b631206812b7142fdd1d15479db92c4d185204981fafaeae5
+  data.tar.gz: 14a32ca59b666e353ec58d6274d02eda8eace7f4910564009eadf3a663aac6885bbb8adff82f4df3b1c6e2bcda39419fabf9146503c4d456de036a0bcb8a927d

data/_data/language.yaml

@@ -3,6 +3,9 @@
 # template:
 #   term:
 #     en: Translation
+#
+# If you are running Jekyll v4.3.0 or higher, you don't need this file in your site
+# as it will be read from the theme's _data folder
 
 skiplinks:
   skip_to_navigation:

metadata

@@ -1,14 +1,14 @@
 --- !ruby/object:Gem::Specification
 name: fenton-jekyll-boilerplate
 version: !ruby/object:Gem::Version
-  version: 0.0.3
+  version: 0.0.5
 platform: ruby
 authors:
 - Steve Fenton
 autorequire:
 bindir: bin
 cert_chain: []
-date: 2022-09-13 00:00:00.000000000 Z
+date: 2022-09-14 00:00:00.000000000 Z
 dependencies:
 - !ruby/object:Gem::Dependency
   name: jekyll
@@ -47,7 +47,6 @@ extra_rdoc_files: []
 files:
 - LICENSE
 - README.md
-- _authors/steve-fenton.md
 - _data/language.yaml
 - _includes/analytics.html
 - _includes/breadcrumbs.html
@@ -62,11 +61,6 @@ files:
 - _layouts/page.html
 - _layouts/post.html
 - _layouts/search.html
-- _plugins/article_paging.rb
-- _plugins/breadcrumbs.rb
-- _plugins/liquid_language.rb
-- _plugins/liquid_regex.rb
-- _plugins/markdown.rb
 - assets/css/code.css
 - assets/css/main.css
 - assets/css/vars.css
@@ -76,28 +70,6 @@ files:
 - assets/icons/favicon-16x16.png
 - assets/icons/favicon-32x32.png
 - assets/icons/favicon.ico
-- assets/img/2022/09/surface-accessories-700.webp
-- assets/img/2022/09/surface-accessories.webp
-- assets/img/authors/steve-fenton.webp
-- assets/img/jekyll-and-hyde.webp
-- assets/img/lighthouse-scores.webp
-- assets/js/main.js
-- assets/js/modules/animation.js
-- assets/js/modules/click-blocks.js
-- assets/js/modules/events.js
-- assets/js/modules/focus.js
-- assets/js/modules/nav-expand.js
-- assets/js/modules/nav-mobile.js
-- assets/js/modules/nav-sticky.js
-- assets/js/modules/query.js
-- assets/js/modules/resizing.js
-- assets/js/modules/string.js
-- assets/js/search.js
-- assets/svg/down.svg
-- favicon.ico
-- robots.txt
-- search.json
-- sitemap.xml
 homepage: https://jekyll.stevefenton.co.uk/
 licenses:
 - Apache-2.0

data/_authors/steve-fenton.md

@@ -1,21 +0,0 @@
----
-username: steve-fenton
-name: Steve Fenton
-location: UK
-url_full: https://www.stevefenton.co.uk/
-url_short: stevefenton.co.uk
-bio: Steve is the creator of Jekyll Boilerplate
-picture: assets/img/authors/steve-fenton.webp
-twitter: _stevefenton
-date: 2022-09-12
-nav-sitemap: true
-nav-search: true
----
-
-This is some information about Steve Fenton.
-
-Lorem ipsum dolor sit amet, consectetur adipiscing elit. Morbi sit amet elit sodales, egestas odio eu, interdum nunc. Lorem ipsum dolor sit amet, consectetur adipiscing elit. In elit odio, dapibus nec finibus sit amet, aliquam a tortor.
-
-Sed ultricies sollicitudin ipsum at bibendum. Nulla euismod erat arcu, vel convallis risus sagittis non. Fusce scelerisque arcu nec blandit dictum. In vel ultricies nisi. Vivamus pharetra, nibh sit amet semper tristique, leo sapien scelerisque risus, a pharetra tortor lectus at nisl.
-
-Vestibulum dui mauris, mattis mattis hendrerit non, aliquam non sem. Nullam orci arcu, viverra vel quam sed, dapibus porta dui. Etiam venenatis ipsum eget mi sodales lobortis. Donec varius non metus eget congue. Suspendisse quis mauris vitae lectus porttitor placerat at quis sapien.

data/_plugins/article_paging.rb

@@ -1,223 +0,0 @@
-module Paginate
-  class Pagination < Jekyll::Generator
-    # This generator is safe from arbitrary code execution.
-    safe true
-
-    # This generator should be passive with regard to its execution
-    priority :lowest
-
-    # Generate paginated pages if necessary.
-    #
-    # site - The Site.
-    #
-    # Returns nothing.
-    def generate(site)
-      if Pager.pagination_enabled?(site)
-        if template = self.class.template_page(site)
-          paginate(site, template)
-        else
-          Jekyll.logger.warn "Pagination:", "Pagination is enabled, but I couldn't find " +
-          "an index.html page to use as the pagination template. Skipping pagination."
-        end
-      end
-    end
-
-    # Paginates the blog's posts. Renders the index.html file into paginated
-    # directories, e.g.: page2/index.html, page3/index.html, etc and adds more
-    # site-wide data.
-    #
-    # site - The Site.
-    # page - The index.html Page that requires pagination.
-    #
-    # {"paginator" => { "page" => <Number>,
-    #                   "per_page" => <Number>,
-    #                   "posts" => [<Post>],
-    #                   "total_posts" => <Number>,
-    #                   "total_pages" => <Number>,
-    #                   "previous_page" => <Number>,
-    #                   "next_page" => <Number> }}
-    def paginate(site, page)
-      all_posts = site.site_payload['site']['posts'].reject { |post| post['hidden'] }
-      pages = Pager.calculate_pages(all_posts, site.config['page_size'].to_i)
-      (1..pages).each do |num_page|
-        pager = Pager.new(site, num_page, all_posts, pages)
-        if num_page > 1
-          newpage = Jekyll::Page.new(site, site.source, page.dir, page.name)
-          newpage.pager = pager
-          newpage.dir = Pager.paginate_path(site, num_page)
-          site.pages << newpage
-        else
-          page.pager = pager
-        end
-      end
-    end
-
-    # Static: Fetch the URL of the template page. Used to determine the
-    #         path to the first pager in the series.
-    #
-    # site - the Jekyll::Site object
-    #
-    # Returns the url of the template page
-    def self.first_page_url(site)
-      if page = Pagination.template_page(site)
-        page.url
-      else
-        nil
-      end
-    end
-
-    # Public: Find the Jekyll::Page which will act as the pager template
-    #
-    # site - the Jekyll::Site object
-    #
-    # Returns the Jekyll::Page which will act as the pager template
-    def self.template_page(site)
-      site.pages.select do |page|
-        Pager.pagination_candidate?(site.config, page)
-      end.sort do |one, two|
-        two.path.size <=> one.path.size
-      end.first
-    end
-
-  end
-end
-
-module Paginate
-  class Pager
-    attr_reader :page, :per_page, :posts, :total_posts, :total_pages,
-      :previous_page, :previous_page_path, :next_page, :next_page_path
-
-    # Calculate the number of pages.
-    #
-    # all_posts - The Array of all Posts.
-    # per_page  - The Integer of entries per page.
-    #
-    # Returns the Integer number of pages.
-    def self.calculate_pages(all_posts, per_page)
-      (all_posts.size.to_f / per_page.to_i).ceil
-    end
-
-    # Determine if pagination is enabled the site.
-    #
-    # site - the Jekyll::Site object
-    #
-    # Returns true if pagination is enabled, false otherwise.
-    def self.pagination_enabled?(site)
-     !site.config['page_size'].nil? &&
-       site.pages.size > 0
-    end
-
-    # Static: Determine if a page is a possible candidate to be a template page.
-    #         Page's name must be `index.html` and exist in any of the directories
-    #         between the site source and `paginate_path`.
-    #
-    # config - the site configuration hash
-    # page   - the Jekyll::Page about which we're inquiring
-    #
-    # Returns true if the
-    def self.pagination_candidate?(config, page)
-      page_dir = File.dirname(File.expand_path(remove_leading_slash(page.path), config['source']))
-      paginate_path = remove_leading_slash(config['paginate_path'])
-      paginate_path = File.expand_path(paginate_path, config['source'])
-      page.name == 'index.html' &&
-        in_hierarchy(config['source'], page_dir, File.dirname(paginate_path))
-    end
-
-    # Determine if the subdirectories of the two paths are the same relative to source
-    #
-    # source        - the site source
-    # page_dir      - the directory of the Jekyll::Page
-    # paginate_path - the absolute paginate path (from root of FS)
-    #
-    # Returns whether the subdirectories are the same relative to source
-    def self.in_hierarchy(source, page_dir, paginate_path)
-      return false if paginate_path == File.dirname(paginate_path)
-      return false if paginate_path == Pathname.new(source).parent
-      page_dir == paginate_path ||
-        in_hierarchy(source, page_dir, File.dirname(paginate_path))
-    end
-
-    # Static: Return the pagination path of the page
-    #
-    # site     - the Jekyll::Site object
-    # num_page - the pagination page number
-    #
-    # Returns the pagination path as a string
-    def self.paginate_path(site, num_page)
-      return nil if num_page.nil?
-      return Pagination.first_page_url(site) if num_page <= 1
-      format = site.config['paginate_path']
-      if format.include?(":num")
-        format = format.sub(':num', num_page.to_s)
-      else
-        raise ArgumentError.new("Invalid pagination path: '#{format}'. It must include ':num'.")
-      end
-      ensure_leading_slash(format)
-    end
-
-    # Static: Return a String version of the input which has a leading slash.
-    #         If the input already has a forward slash in position zero, it will be
-    #         returned unchanged.
-    #
-    # path - a String path
-    #
-    # Returns the path with a leading slash
-    def self.ensure_leading_slash(path)
-      path[0..0] == "/" ? path : "/#{path}"
-    end
-
-    # Static: Return a String version of the input without a leading slash.
-    #
-    # path - a String path
-    #
-    # Returns the input without the leading slash
-    def self.remove_leading_slash(path)
-      ensure_leading_slash(path)[1..-1]
-    end
-
-    # Initialize a new Pager.
-    #
-    # site     - the Jekyll::Site object
-    # page      - The Integer page number.
-    # all_posts - The Array of all the site's Posts.
-    # num_pages - The Integer number of pages or nil if you'd like the number
-    #             of pages calculated.
-    def initialize(site, page, all_posts, num_pages = nil)
-      @page = page
-      @per_page = site.config['page_size'].to_i
-      @total_pages = num_pages || Pager.calculate_pages(all_posts, @per_page)
-
-      if @page > @total_pages
-        raise RuntimeError, "page number can't be greater than total pages: #{@page} > #{@total_pages}"
-      end
-
-      init = (@page - 1) * @per_page
-      offset = (init + @per_page - 1) >= all_posts.size ? all_posts.size : (init + @per_page - 1)
-
-      @total_posts = all_posts.size
-      @posts = all_posts[init..offset]
-      @previous_page = @page != 1 ? @page - 1 : nil
-      @previous_page_path = Pager.paginate_path(site, @previous_page)
-      @next_page = @page != @total_pages ? @page + 1 : nil
-      @next_page_path = Pager.paginate_path(site, @next_page)
-    end
-
-    # Convert this Pager's data to a Hash suitable for use by Liquid.
-    #
-    # Returns the Hash representation of this Pager.
-    def to_liquid
-      {
-        'page' => page,
-        'per_page' => per_page,
-        'posts' => posts,
-        'total_posts' => total_posts,
-        'total_pages' => total_pages,
-        'previous_page' => previous_page,
-        'previous_page_path' => previous_page_path,
-        'next_page' => next_page,
-        'next_page_path' => next_page_path
-      }
-    end
-
-  end
-end

data/_plugins/breadcrumbs.rb

@@ -1,109 +0,0 @@
-module Jekyll
-  module Breadcrumbs
-    class BreadcrumbItem < Liquid::Drop
-      extend Forwardable
-
-      def initialize(side)
-        @side = side
-      end
-
-      def position
-        @side[:position]
-      end
-
-      def title
-        @side[:title]
-      end
-
-      def url
-        @side[:url]
-      end
-
-      def rootimage
-        @side[:root_image]
-      end
-     
-    end
-  end
-end
-
-module Jekyll
-  module Breadcrumbs
-    @@config = {}
-    @@siteAddress = ""
-    @@sideAddresses = {}
-
-    def self.clearAddressCache
-      @@sideAddresses = {}
-    end
-
-    def self.loadAddressCache(site)
-      clearAddressCache
-      site.documents.each { |page| addAddressItem(page.url, page['nav-title'] || page['title'] || '') } # collection files including posts
-      site.pages.each { |page| addAddressItem(page.url, page['nav-title'] || page['title'] || '') } # pages
-      site.posts.docs.each { |page| addAddressItem(page.url, page['nav-title'] || page['title'] || '') } # posts      
-    end
-
-    def self.addAddressItem(url, title)    
-      key = createAddressCacheKey(url)
-      @@sideAddresses[key] = {:url => url, :title => title}
-    end
-
-    def self.findAddressItem(path)
-      key = createAddressCacheKey(path)
-      @@sideAddresses[key] if key
-    end
-
-    def self.createAddressCacheKey(path)
-      path.chomp("/").empty? ? "/" : path.chomp("/")              
-    end
-
-    def self.buildSideBreadcrumbs(side, payload)
-      payload["breadcrumbs"] = []
-      return if side.url == @@siteAddress && root_hide === true
-
-      drop = Jekyll::Breadcrumbs::BreadcrumbItem
-      position = 0
-
-      path = side.url.chomp("/").split(/(?=\/)/)
-      -1.upto(path.size - 1) do |int|
-         joined_path = int == -1 ? "" : path[0..int].join
-         item = findAddressItem(joined_path)
-         if item 
-            position += 1
-            item[:position] = position
-            item[:root_image] = root_image
-            payload["breadcrumbs"] << drop.new(item)
-         end
-      end
-    end
-
-   # Config
-   def self.loadConfig(site)
-      config = site.config["breadcrumbs"] || {"root" => {"hide" => false, "image" => false}} 
-      root = config["root"]
-      @@config[:root_hide] = root["hide"] || false
-      @@config[:root_image] = root["image"] || false
-
-      @@siteAddress = site.config["baseurl"] || "/"
-      @@siteAddress = "/" if @@siteAddress.empty?
-    end
-
-    def self.root_hide
-      @@config[:root_hide]
-   end
-
-   def self.root_image
-      @@config[:root_image]
-   end
-  end
-end
-
-Jekyll::Hooks.register :site, :pre_render do |site, payload|
-   Jekyll::Breadcrumbs::loadConfig(site)
-  Jekyll::Breadcrumbs::loadAddressCache(site)
-end
-
-Jekyll::Hooks.register [:pages, :documents], :pre_render do |side, payload|
-  Jekyll::Breadcrumbs::buildSideBreadcrumbs(side, payload)
-end

data/_plugins/liquid_language.rb

@@ -1,38 +0,0 @@
-require 'liquid'
-
-module Jekyll
-  module Language
-    
-    @@lang = nil
-    
-    # Supplies translated text
-    #
-    # Usage: {{ 'author' | t: 'recent_articles' }}
-    def t(section, item)
-      site = @context.registers[:site]
-
-      if @@lang == nil
-        # Access this fewer times by keeping it as a module variable
-        @@lang = Jekyll.configuration({})['language']
-      end
-      
-      # Find text in the site language (for example 'fr-be')
-      text = site.data['language'][section][item][@@lang]
-
-      # Fall back to a more general version of the language (for example 'fr')
-      if text == nil and @@lang.include? '-'
-        fallback_lang = @@lang.split('-')[0];
-        text = site.data['language'][section][item][fallback_lang]
-      end
-
-      if text == nil
-        # Fallback to English text
-        text = site.data['language'][section][item]['en']
-      end
-
-      return text
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::Language)

data/_plugins/liquid_regex.rb

@@ -1,17 +0,0 @@
-require 'liquid'
-
-module Jekyll
-  module RegexReplace
-    def regex_replace(str, regex_search, value_replace)
-      regex = /#{regex_search}/
-      return str.gsub(regex, value_replace)
-    end
-
-    def regex_replace_once(str, regex_search, value_replace)
-      regex = /#{regex_search}/
-      return str.sub(regex, value_replace)
-    end
-  end
-end
-
-Liquid::Template.register_filter(Jekyll::RegexReplace)

data/_plugins/markdown.rb

@@ -1,17 +0,0 @@
-Jekyll::Hooks.register :posts, :post_init do |item|
-    item.content = item.content
-        &.gsub(/^:::([a-z \-_]+)/, '<div class="\1" markdown="1">')
-        &.gsub(/^:::/, '</div>')
-end
-
-Jekyll::Hooks.register :pages, :post_init do |item|
-    item.content = item.content
-        &.gsub(/^:::([a-z \-_]+)/, '<div class="\1" markdown="1">')
-        &.gsub(/^:::/, '</div>')
-end
-
-Jekyll::Hooks.register :documents, :post_init do |item|
-    item.content = item.content
-        &.gsub(/^:::([a-z \-_]+)/, '<div class="\1" markdown="1">')
-        &.gsub(/^:::/, '</div>')
-end

data/assets/js/main.js

@@ -1,18 +0,0 @@
-// @ts-check
-
-import { setNavigationTree, setNavigationItem } from './modules/nav-expand.js';
-import { setClickableBlocks } from './modules/click-blocks.js';
-import { addResizedEvent } from './modules/resizing.js';
-import { addStickyNavigation } from './modules/nav-sticky.js';
-import { addMobileNavigation } from './modules/nav-mobile.js';
-import { addIntersectionObserver } from './modules/animation.js';
-
-setNavigationTree('details.sub-nav');
-setNavigationItem('.site-nav a', 'current-item')
-setClickableBlocks('data-destination');
-
-var resizedEventName = addResizedEvent();
-
-addStickyNavigation('.site-header', '.site-nav', '.site-nav > ul', resizedEventName);
-addMobileNavigation('.navigation-icon', '.site-nav', resizedEventName);
-addIntersectionObserver('.post-list .list-item, main img, main .note, main blockquote');

data/assets/js/modules/animation.js

@@ -1,41 +0,0 @@
-// @ts-check
-
-import { qsa } from './query.js';
-
-/**
- * Assists animation by setting "--shown" CSS property
- * 
- * When an item is visible in the viewport, it will have --shown: 1
- * Otherwise it will be --shown: 0
- * This allows CSS transitions and calculated properties to animate elements
- * 
- * Example
- *     transition: all 0.2s ease-in;
- *     scale: calc(0.75 + (var(--shown, 1) * 0.25));
- * 
- * @param {string} listItemQuery 
- */
-function addIntersectionObserver(listItemQuery) {
-    function handleIntersection(entries, observer) {
-        for (var entry of entries) {
-            var value = entry.isIntersecting ? 1 : 0;
-            entry.target.style.setProperty('--shown', value);
-        }
-    }
-
-    var options = {
-        root: null,
-        rootMargin: '0px',
-        threshold: 0
-    };
-
-    var observer = new IntersectionObserver(handleIntersection, options)
-
-    var items = qsa(listItemQuery);
-
-    for (var i = 0; i < items.length; i++) {
-        observer.observe(items[i]);
-    }
-}
-
-export { addIntersectionObserver };

data/assets/js/modules/click-blocks.js

@@ -1,35 +0,0 @@
-// @ts-check
-
-import { qsa } from './query.js';
-
-/**
- * Makes an entire block clickable based on a data-attribute, usually "data-destination"
- * 
- * Example: You have a list of blog posts, including featured images. If you make the title
- * clickable, clicks on the image won't open the blog. Adding links to the images means
- * keyboard users have to tab twice as much to get through the list.
- * 
- * Use clickable blocks to allow keyboard users to tab through the real links, but still
- * capture clicks elsewhere on the block.
- * 
- * @param {string} dataAttributeName
- */
- function setClickableBlocks(dataAttributeName) {
-    var listItems = qsa('[' + dataAttributeName + ']');
-
-    for(var i = 0; i < listItems.length; i++) {
-        var listItem = listItems[i];
-        listItem.style.cursor = 'pointer';
-        listItem.addEventListener('click', function (e) {
-            var location = this.getAttribute(dataAttributeName);
-
-            if (location) {
-                e.preventDefault();
-                document.location = location;
-                return false;
-            }
-        });
-    }
-}
-
-export { setClickableBlocks };

data/assets/js/modules/events.js

@@ -1,19 +0,0 @@
-// @ts-check
-
-/**
- * 
- * @param {string} name 
- * @param {{[key: string]: any}} detail 
- * @param {Document | HTMLElement} [target]
- */
-function raiseEvent(name, detail, target) {
-    if (!target) {
-        target = document;
-    }
-
-    const event = new CustomEvent(name, { detail: detail});
-    document.dispatchEvent(event);
-    console.log('Event Raised', name, detail);
-}
-
-export { raiseEvent };

data/assets/js/modules/focus.js

@@ -1,76 +0,0 @@
-// @ts-check
-
-import { qsa } from './query.js';
-
-/**
- * Gets first, last, and all focusable elements in the target
- * 
- * For the supplied element, finds all the elements that can receive keyboard focus.
- * 
- * Examples: a, button, input, textarea, select, and other valid interactive items
- * that haven't been disabled or hidden.
- * 
- * @param {HTMLElement} target element
- * @returns {{first: HTMLElement, last: HTMLElement, all: HTMLElement[]}}
- */
- function getFocusableElement(target) {
-    var focusElements = Array.from(
-        qsa('a[href], button, input, textarea, select, details,[tabindex]:not([tabindex="-1"])', target)
-    ).filter(function(el) {
-        return !el.hasAttribute('disabled') && !el.getAttribute('aria-hidden');
-    });
-    
-    return {
-        first: focusElements[0],
-        last: focusElements[focusElements.length -1],
-        all: focusElements
-    };
-}
-
-/**
- * Mechanism to trap focus
- * 
- * @param {KeyboardEvent} event 
- * @param {HTMLElement} focusItem 
- * @returns 
- */
-function trapFocus(event, focusItem) {
-    switch (event.code.toLowerCase()) {
-        case 'tab':
-        event.preventDefault();    
-        focusItem.focus();
-        return false;
-    }
-}
-
-/**
- * Mechanism to trap focus (TAB)
- * 
- * @param {KeyboardEvent} event 
- * @param {HTMLElement} focusItem 
- * @returns 
- */
-function trapFocusForward(event, focusItem) {
-    if (event.shiftKey) {
-        return;
-    }
-
-    trapFocus(event, focusItem);
-}
-
-/**
- * Mechanism to trap tab (SHIFT + TAB)
- * 
- * @param {KeyboardEvent} event 
- * @param {HTMLElement} focusItem 
- * @returns 
- */
-function trapReverseFocus(event, focusItem) {
-    if (!event.shiftKey) {
-        return;
-    }
-
-    trapFocus(event, focusItem);
-}
-
-export { getFocusableElement, trapFocusForward, trapReverseFocus };

data/assets/js/modules/nav-expand.js

@@ -1,51 +0,0 @@
-// @ts-check
-
-import { qs, qsa } from './query.js';
-
-/**
- * Sets the navigation based on the current page
- * 
- * Example: You have a navigation tree with an "About" page with several child items.
- * When the user is on the "About" page, or any child pages, the navigation should
- * be automatically expanded so the user can orient themselves within the site.
- * 
- * @param {string} className 
- */
- function setNavigationTree(className) {
-    var summaries = qsa(className);
-    var site = document.location.origin;
-    var location = document.location.pathname;
-
-    for (var i = 0; i < summaries.length; i++) {
-        var summary = summaries[i];
-        var anchorElement = /** @type {HTMLAnchorElement} */(qs('a', summary));
-        var address = anchorElement.href.replace(site, '');
-
-        if (location.startsWith(address)){
-            summary.setAttribute('open', 'open');
-        }
-    }
-}
-
-/**
- * Highlights the current navigation item
- * 
- * @param {string} navQuery 
- * @param {string} selectedClass 
- */
-function setNavigationItem(navQuery, selectedClass) {
-    var anchors = qsa(navQuery);
-    var site = document.location.origin;
-    var location = document.location.pathname;
-
-    for (var j = 0; j < anchors.length; j++) {
-        var anchor = /** @type {HTMLAnchorElement} */ (anchors[j]);
-        var href = anchor.href.replace(site, '');
-
-        if (href === location) {
-            anchor.classList.add(selectedClass);
-        }
-    }
-}
-
-export { setNavigationTree, setNavigationItem };

data/assets/js/modules/nav-mobile.js

@@ -1,104 +0,0 @@
-// @ts-check
-
-import { qs } from './query.js';
-import { getFocusableElement, trapFocusForward, trapReverseFocus } from './focus.js';
-
-/**
- * Provides an overlay with the navigation for mobile users.
- * 
- * Example: You have site navigation on the page, but demote it (closer to the footer) on mobile to avoid
- * the content being pushed below the fold. You provide an icon that bookmarks to the
- * navigation.
- * 
- * The mobile navigation intercepts the bookmark link and opens the navigation in a modal
- * overlay, trapping keyboard focus until the overlay is closed.
- * 
- * @param {string} iconSelector 
- * @param {string} navigationSelector 
- */
- function addMobileNavigation(iconSelector, navigationSelector, resizedEventName) {
-    var icon = qs(iconSelector);
-    var originalIcon = icon.innerHTML;
-    var overlay = document.createElement('div');
-    var dataOpen = 'data-open';
-
-    icon.addEventListener('keydown', function(e) { 
-        if (icon.getAttribute(dataOpen) === dataOpen) {
-            var focusElements = getFocusableElement(overlay);
-            trapFocusForward(e, focusElements.first); 
-            trapReverseFocus(e, focusElements.last);
-        }
-    });
-
-    function handleIconInteraction() {
-        if (icon.dataset.open == dataOpen) {
-            closeMobileMenu();
-        } else {
-            openMobileMenu();
-        }
-    }
-
-    function openMobileMenu(){
-        document.body.style.overflow = 'hidden';
-        var navigation = qs(navigationSelector);
-        
-        overlay.innerHTML = navigation.outerHTML;
-        overlay.className = 'overlay';
-        overlay.style.display = 'block';
-
-        // Modal Accessibility
-        var title = qs('.site-nav-title', overlay);
-        title.setAttribute('id', 'modal-title');
-        title.setAttribute('tabindex', '-1');
-        overlay.setAttribute('role', 'dialog');
-        overlay.setAttribute('aria-modal', 'true');
-        overlay.setAttribute('aria-labelled-by', 'modal-title');
-
-        // Trap Focus to Visible Overlay
-        var focusElements = getFocusableElement(overlay);
-
-        focusElements.first.addEventListener('keydown', function(e) {
-            trapReverseFocus(e, icon);
-        })
-        focusElements.last.addEventListener('keydown', function(e) { 
-            trapFocusForward(e, icon); 
-        });
-
-        icon.innerHTML = `<svg xmlns="http://www.w3.org/2000/svg" 
-            width="40" height="40" viewBox="0 0 24 24" stroke-width="1.5" 
-            fill="none" stroke-linecap="round" stroke-linejoin="round">
-            <path stroke="none" d="M0 0h24v24H0z" fill="none"/>
-            <line x1="18" y1="6" x2="6" y2="18" />
-            <line x1="6" y1="6" x2="18" y2="18" />
-            </svg>`;
-
-        document.body.appendChild(overlay);
-        icon.setAttribute(dataOpen, dataOpen);
-        title.focus();
-    }
-
-    function closeMobileMenu() {
-        document.body.style.overflow = 'auto';
-
-        if (icon.getAttribute(dataOpen) === dataOpen) {
-            overlay.innerHTML = '';
-            overlay.style.display = 'none';
-            document.body.removeChild(overlay);
-        }
-
-        icon.innerHTML = originalIcon;
-        icon.removeAttribute(dataOpen);
-    }
-
-    icon.addEventListener('click', function (e) {
-        e.preventDefault();
-        handleIconInteraction();
-        return false;
-    });
-
-    document.addEventListener(resizedEventName, function () {
-        closeMobileMenu();
-    })
-}
-
-export { addMobileNavigation };

data/assets/js/modules/nav-sticky.js

@@ -1,54 +0,0 @@
-// @ts-check
-
-import { qs, qsa } from './query.js';
-
-/**
- * Makes an existing navigation element sticky
- * 
- * Example: If the existing navigation is not as tall as the content, the
- * navigation will stick to the top, allowing the user to see it as 
- * they scroll through the article
- * 
- * @param {string} headerSelector 
- * @param {string} navigationSelector 
- * @param {string} navigationListSelector 
- */
-function addStickyNavigation(headerSelector, navigationSelector, navigationListSelector, resizedEventName) {
-    function setNavigationMode() {
-        var header = qs(headerSelector);
-        var navigation = qs(navigationSelector);
-        var navigationList = qs(navigationListSelector); 
-        
-        var buffer = 50;
-        var className = 'sticky';
-
-        var dimensions = {
-            browserHeight: window.innerHeight,
-            browserWidth: window.innerWidth,
-            headerHeight: header.clientHeight,
-            navigationHeight: navigationList.clientHeight
-        };
-
-        // Only enable sticky mode if the menu will fit vertically
-        // && where the browser is more than 860px wide
-        if (dimensions.navigationHeight < ((dimensions.browserHeight - dimensions.headerHeight) - buffer)
-            && dimensions.browserWidth > 860) {
-            console.log('Navigation: Sticky Mode');
-            navigation.classList.add(className)
-            navigation.style.top = dimensions.headerHeight.toString() + 'px';
-        } else {
-            console.log('Navigation: Fixed Mode');
-            navigation.classList.remove(className);
-        }
-    }
-
-    setNavigationMode();
-
-    document.addEventListener(resizedEventName, function(e) {
-        if (e.detail && e.detail.change && e.detail.change.height != 0) {
-            setNavigationMode();
-        }
-    });
-}
-
-export { addStickyNavigation };

data/assets/js/modules/query.js

@@ -1,42 +0,0 @@
-// @ts-check
-
-/**
- * Utility for query selector
- * 
- * @param {string} query
- * @param {HTMLElement | null} [container]
- * @returns {HTMLElement}
- */
- function qs(query, container) {
-    var target = (container)
-        ? container
-        : document;
-
-    /** @type {HTMLElement | null} */
-    var result = target.querySelector(query);
-
-    if (result) {
-        return result;
-    }
-
-    throw new Error(`No element ${query}`);
-}
-
-/**
- * Utility for query selector all
- * 
- * @param {string} query
- * @param {HTMLElement | null} [container]
- * @returns {NodeListOf<any>}
- */
- function qsa(query, container) {
-    var target = (container)
-        ? container
-        : document;
-
-    /** @type {NodeListOf<HTMLElement>} */
-    var result = target.querySelectorAll(query);
-    return result;
-}
-
-export { qs, qsa };

data/assets/js/modules/resizing.js

@@ -1,43 +0,0 @@
-// @ts-check
-
-import { raiseEvent } from './events.js';
-
-var resizeEventName = 'resize';
-var resizedEventName = 'resized';
-
-var width = window.innerWidth;
-var height = window.innerHeight;
-
-/**
- * Adds a de-bounced "resized" event, so you can listen to:
- * document.addEventListener('resized', <handler>);
- * 
- * @returns {string}
- */
- function addResizedEvent() {
-    var debounce = null;
-
-    function resizeEnd(e) {
-        window.clearTimeout(debounce);
-        debounce = window.setTimeout(raiseResizeEvent, 500);
-    }
-
-    function raiseResizeEvent() {
-        var change = {
-            width: window.innerWidth - width,
-            height: window.innerHeight - height
-        };
-
-        width = window.innerWidth;
-        height = window.innerHeight;
-        
-
-        raiseEvent(resizedEventName, { change: change });
-    }
-
-    window.addEventListener(resizeEventName, resizeEnd);
-
-    return resizedEventName;
-}
-
-export { addResizedEvent };

data/assets/js/modules/string.js

@@ -1,49 +0,0 @@
-// @ts-check
-
-/**
- * Looks for a search within a string
- * 
- * @param {string} string 
- * @param {string} search 
- * @returns 
- */
- function contains(string, search) {
-    return string.indexOf(search) > -1;
-}
-
-/**
- * Simplifies a string to plain lower case, removing diacritic characters and hyphens
- * This means a search for "co-op" will be found in "COOP" and "Café" will be found in "cafe"
- * @param {string} string 
- * @returns 
- */
- function sanitise(string) {
-    // @ts-ignore
-    if (String.prototype.normalize) {
-        // Reduces diacritic characters to plain characters
-        string.trim().normalize('NFD').replace(/[\u0300-\u036f]/g, '').toLowerCase().replace(/-/g, '');
-    }
-
-    // Some browsers can't normalise strings
-    return string.trim().toLowerCase().replace(/-/g, '');
-}
-
-/**
- * Sets a minimum length for a search
- * @param {string} string 
- * @returns 
- */
- function isLongEnough(string) {
-    return string.length > 1;
-}
-
-/**
- * Splits a sentence into individual search terms
- * @param {string} string 
- * @returns 
- */
-function explode(string) {
-    return string.split(' ').filter(isLongEnough).map(sanitise);
-}
-
-export { contains, sanitise, explode };

data/assets/js/search.js

@@ -1,154 +0,0 @@
-// @ts-check
-
-import { qs } from './modules/query.js';
-import { raiseEvent } from './modules/events.js';
-import { contains, sanitise, explode } from './modules/string.js';
-
-var haystack = [];
-var needles = [];
-var currentQuery = null;
-
-var ready = false;
-var scrolled = false;
-
-/**
- * Performs the search
- * @param {string} s 
- * @returns 
- */
-function search(s) {
-    needles = [];
-
-    // Clean the input
-    var cleanQuery = sanitise(s);
-
-    if (currentQuery === cleanQuery) {
-        return;
-    }
-
-    raiseEvent('searched', { search: s });
-
-    currentQuery = cleanQuery;
-
-    var queryTerms = explode(currentQuery);
-
-    for (var i = 0; i < haystack.length; i++) {
-        var item = haystack[i];
-
-        item.score = 0;
-        
-        var title = sanitise(item.title);
-        var category = sanitise(item.category);
-        var tags = sanitise(item.tags);
-
-        for (var j = 0; j < queryTerms.length; j++) {
-            var term = queryTerms[j];
-
-            if (contains(title, term)) {
-                item.score = item.score + 10;
-            }
-
-            if (contains(category, term)) {
-                item.score = item.score + 5;
-            }
-
-            if (contains(tags, term)) {
-                item.score = item.score + 5;
-            }
-        }
-
-        if (item.score > 0) {
-            needles.push(item);
-        }
-    }
-
-    needles.sort(function (a, b){
-        return b.score - a.score;
-    });
-
-    var results = qs('#site-search-results');
-
-    if (results == null) {
-        throw new Error('Cannot find #site-search-results');
-    }
-
-    var ol = document.createElement('ol');
-    ol.className = 'site-search-results';
-
-    var limit = Math.min(needles.length, 12)
-
-    for (var i = 0; i < limit; i++) {
-        var needle = needles[i];
-
-        var a = document.createElement('a');
-        a.innerHTML = needle.title;
-        a.href = needle.url;
-
-        var li = document.createElement('li');
-        li.appendChild(a);
-
-        ol.appendChild(li);
-    }
-
-    var h2 = document.createElement('h2');
-    h2.innerHTML = needles.length === 0
-        ? results.dataset.emptytitle || 'No Results'
-        : results.dataset.title || 'Results';
-
-    results.innerHTML = '';
-    results.appendChild(h2);
-    results.appendChild(ol);
-}
-
-var debounceTimer;
-
-function debounceSearch() {
-    var input = /** @type {HTMLInputElement} */(qs('#site-search-query'));
-
-    if (input == null) {
-        throw new Error('Cannot find #site-search-query');
-    }
-
-    var s = input.value;
-
-    window.clearTimeout(debounceTimer);
-    debounceTimer = window.setTimeout(function () {
-        if (ready) {
-            search(s);
-        }
-    }, 400);
-}
-
-fetch('/search.json')
-    .then(function (response) { 
-        return response.json();
-    })
-    .then(function (data) { 
-        haystack = data;
-        ready = true;
-
-        var siteSearch = qs('#site-search');
-        var siteSearchQuery = qs('#site-search-query');
-
-        if (siteSearch == null || siteSearchQuery == null) {
-            throw new Error('Cannot find #site-search or #site-search-query');
-        }
-    
-        siteSearch.addEventListener('submit', function (e) {
-            e.preventDefault();
-            debounceSearch();
-            return false;
-        });
-    
-        siteSearchQuery.addEventListener('keyup', function (e) {
-            e.preventDefault();
-            if (!scrolled) {
-                scrolled = true;
-                this.scrollIntoView(true);
-            }
-            debounceSearch();
-            return false;
-        });
-
-        console.log('Search ready');
-    });

data/assets/svg/down.svg

@@ -1,38 +0,0 @@
-<?xml version="1.0" encoding="iso-8859-1"?>
-<!-- Generator: Adobe Illustrator 19.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0)  -->
-<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
-	 viewBox="0 0 330 330" style="enable-background:new 0 0 330 330;" xml:space="preserve">
-<path id="XMLID_225_" d="M325.607,79.393c-5.857-5.857-15.355-5.858-21.213,0.001l-139.39,139.393L25.607,79.393
-	c-5.857-5.857-15.355-5.858-21.213,0.001c-5.858,5.858-5.858,15.355,0,21.213l150.004,150c2.813,2.813,6.628,4.393,10.606,4.393
-	s7.794-1.581,10.606-4.394l149.996-150C331.465,94.749,331.465,85.251,325.607,79.393z"/>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-<g>
-</g>
-</svg>

data/robots.txt

@@ -1,5 +0,0 @@
----
-layout: null
----
-Sitemap: {{ site.url }}{{ '/sitemap.xml' | prepend: site.baseurl }}
-User-agent: *

data/search.json

@@ -1,36 +0,0 @@
----
-layout: null
----
-{%- assign pages = site.pages | where: 'nav-search', 'true' %}
-{%- assign posts = site.posts | where: 'nav-search', 'true' %}
-{%- assign authors = site.authors | where: 'nav-search', 'true' %}
-[
-  {% for page in pages %}{
-    "title"    : "{{ page.title | escape }}",
-    "category" : "{{ page.category }}",
-    "tags"     : "{{ page.tags | join: ' ' }} {{page.keywords}}",
-    "url"      : "{{ site.baseurl }}{{ page.url }}",
-    "date"     : "{{ page.date }}"
-  }{%- unless forloop.last %},{% endunless %}
-  {%- endfor %}
-  {%- if authors.size > 0 %},{% endif %}
-  {%- for author in authors %}{
-    "title"    : "{{ author.name | escape }}",
-    "category" : "{{ author.category }}",
-    "tags"     : "{{ page.tags | join: ' ' }} {{page.keywords}}",
-    "url"      : "{{ site.baseurl }}{{ author.url }}",
-    "date"     : "{{ author.date }}"
-  }{%- unless forloop.last %},{% endunless %}
-  {%- endfor %}
-  {%- if posts.size > 0 %},{% endif %}
-  {%- for post in posts %}{
-    "title"    : "{{ post.title | escape }}",
-    "category" : "{{ post.category }}",
-    "tags"     : "{{ page.tags | join: ' ' }} {{page.keywords}}",
-    "url"      : "{{ site.baseurl }}{{ post.url }}",
-    "date"     : "{{ post.date }}"
-  }
-  {%- unless forloop.last %},{% endunless %}
-  {%- endfor %}
-]
-

data/sitemap.xml

@@ -1,15 +0,0 @@
----
-layout: null
----
-<?xml version="1.0" encoding="UTF-8"?>
-<sitemapindex xmlns="http://www.sitemaps.org/schemas/sitemap/0.9">
-  <sitemap>
-    <loc>{{ site.url }}{{ '/sitemap/pages.xml' | prepend: site.baseurl }}</loc>
-  </sitemap>
-  <sitemap>
-    <loc>{{ site.url }}{{ '/sitemap/posts.xml' | prepend: site.baseurl }}</loc>
-  </sitemap>
-  <sitemap>
-    <loc>{{ site.url }}{{ '/sitemap/authors.xml' | prepend: site.baseurl }}</loc>
-  </sitemap>
-</sitemapindex>