fenton-jekyll-boilerplate 0.0.1

data/_plugins/breadcrumbs.rb

@@ -0,0 +1,82 @@
+require_relative 'breadcrumbs/breadcrumb_item.rb'
+
+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/jekyll-paginate/pager.rb

@@ -0,0 +1,141 @@
+module Jekyll
+    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['paginate'].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['paginate'].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
+  end

data/_plugins/jekyll-paginate/pagination.rb

@@ -0,0 +1,85 @@
+module Jekyll
+    module Paginate
+      class Pagination < 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['paginate'].to_i)
+          (1..pages).each do |num_page|
+            pager = Pager.new(site, num_page, all_posts, pages)
+            if num_page > 1
+              newpage = 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
+  end

data/_plugins/liquid_language.rb

@@ -0,0 +1,38 @@
+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

@@ -0,0 +1,17 @@
+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

@@ -0,0 +1,17 @@
+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/_plugins/paging.rb

@@ -0,0 +1,7 @@
+require "jekyll-paginate/pager"
+require "jekyll-paginate/pagination"
+
+module Jekyll
+  module Extensions
+  end
+end

data/articles/index.html

@@ -0,0 +1,70 @@
+---
+layout: default
+title:  Articles
+date:   2022-09-06
+authors: steve-fenton
+description: Articles about Jekyll Boilerplate.
+nav-title: Articles
+nav-level: 1
+nav-order: 3000
+published: true
+nav-sitemap: true
+nav-search: true
+# Don't use permalink on list pages
+---
+<main id="site-main">
+  <h1>{{ 'articles' | t: 'title' }}</h1>
+  {%- if site.paginate %}
+    {% assign posts = paginator.posts %}
+  {% else %}
+    {% assign posts = site.posts %}
+  {% endif %}
+  {%- if posts.size > 0 -%}
+  <ul class="post-list">
+    {%- assign date_format = site.date_format | default: "%b %-d, %Y" -%}
+    {%- for post in posts -%}
+    <li class="list-item" data-destination="{{ post.url | relative_url }}">
+      {%- if post.banner-image -%}
+      <img src="{{ post.banner-image }}" alt="{{ post.banner-image-alt }}" {% unless forloop.first %}loading="lazy"{% endunless %} />
+      {%- endif -%}
+      <div class="list-item-content">
+        <span class="post-meta">{{ post.date | date: date_format }}</span>
+        <h2>
+          <a href="{{ post.url | relative_url }}">
+            {{ post.title | escape }}
+          </a>
+        </h2>
+        {%- if site.show_excerpts -%}
+          {{ post.excerpt | default: post.description }}
+        {%- endif -%}
+      </div>
+    </li>
+    {%- endfor -%}
+  </ul>
+
+  {% if paginator.total_pages > 1 %}
+  <div class="post-paging">
+    {% if paginator.previous_page %}
+      <a href="{{ paginator.previous_page_path | relative_url }}">&laquo; {{ 'articles' | t: 'previous' }}</a>
+    {% else %}
+      <span>&laquo; {{ 'articles' | t: 'previous' }}</span>
+    {% endif %}
+  
+    {% for page in (1..paginator.total_pages) %}
+      {% if page == paginator.page %}
+        <em>{{ page }}</em>
+      {% else %}
+        {% assign page_one_link = '/' | append: site.paginate_page | append: '1' | append: '/' %}
+        <a href="{{ site.paginate_path | relative_url | replace: ':num', page | replace: page_one_link, '/' }}">{{ page }}</a>
+      {% endif %}
+    {% endfor %}
+  
+    {% if paginator.next_page %}
+      <a href="{{ paginator.next_page_path | relative_url }}">{{ 'articles' | t: 'next' }} &raquo;</a>
+    {% else %}
+      <span>{{ 'articles' | t: 'next' }} &raquo;</span>
+    {% endif %}
+  </div>
+  {% endif %}
+  {%- endif -%}
+</main>

data/assets/css/code.css

@@ -0,0 +1,188 @@
+.highlight  { 
+    background: #FFF; 
+    color: #333; 
+}
+
+@media (prefers-color-scheme: dark) {
+    .highlight  { 
+        background: #f3f3f3; 
+        color: #333; 
+    }
+}
+
+/* Comment */
+.highlight .c { color: #999988; font-style: italic }
+
+/* Error */
+.highlight .err { color: #a61717; background-color: #e3d2d2 }
+
+/* Keyword */
+.highlight .k { font-weight: bold }
+
+/* Operator */
+.highlight .o { font-weight: bold }
+
+/* Comment.Multiline */
+.highlight .cm { color: #999988; font-style: italic }
+
+/* Comment.Preproc */
+.highlight .cp { color: #999999; font-weight: bold }
+
+/* Comment.Single */
+.highlight .c1 { color: #999988; font-style: italic }
+
+/* Comment.Special */
+.highlight .cs { color: #999999; font-weight: bold; font-style: italic }
+
+/* Generic.Deleted */
+.highlight .gd { color: #000000; background-color: #ffdddd }
+
+/* Generic.Deleted.Specific */
+.highlight .gd .x { color: #000000; background-color: #ffaaaa }
+
+/* Generic.Emph */
+.highlight .ge { font-style: italic }
+
+/* Generic.Error */
+.highlight .gr { color: #aa0000 }
+
+/* Generic.Heading */
+.highlight .gh { color: #999999 }
+
+/* Generic.Inserted */
+.highlight .gi { color: #000000; background-color: #ddffdd }
+
+/* Generic.Inserted.Specific */
+.highlight .gi .x { color: #000000; background-color: #aaffaa }
+
+/* Generic.Output */
+.highlight .go { color: #888888 }
+
+/* Generic.Prompt */
+.highlight .gp { color: #555555 }
+
+/* Generic.Strong */
+.highlight .gs { font-weight: bold }
+
+/* Generic.Subheading */
+.highlight .gu { color: #aaaaaa }
+
+/* Generic.Traceback */
+.highlight .gt { color: #aa0000 }
+
+/* Keyword.Constant */
+.highlight .kc { font-weight: bold }
+
+/* Keyword.Declaration */
+.highlight .kd { font-weight: bold }
+
+/* Keyword.Pseudo */
+.highlight .kp { font-weight: bold }
+
+/* Keyword.Reserved */
+.highlight .kr { font-weight: bold }
+
+/* Keyword.Type */
+.highlight .kt { color: #445588; font-weight: bold }
+
+/* Literal.Number */
+.highlight .m { color: #009999 }
+
+/* Literal.String */
+.highlight .s { color: #d14 }
+
+/* Name.Attribute */
+.highlight .na { color: #008080 }
+
+/* Name.Builtin */
+.highlight .nb { color: #0086B3 }
+
+/* Name.Class */
+.highlight .nc { color: #445588; font-weight: bold }
+
+/* Name.Constant */
+.highlight .no { color: #008080 }
+
+/* Name.Entity */
+.highlight .ni { color: #800080 }
+
+/* Name.Exception */
+.highlight .ne { color: #990000; font-weight: bold }
+
+/* Name.Function */
+.highlight .nf { color: #990000; font-weight: bold }
+
+/* Name.Namespace */
+.highlight .nn { color: #555555 }
+
+/* Name.Tag */
+.highlight .nt { color: #000080 }
+
+/* Name.Variable */
+.highlight .nv { color: #008080 }
+
+/* Operator.Word */
+.highlight .ow { font-weight: bold }
+
+/* Text.Whitespace */
+.highlight .w { color: #bbbbbb }
+
+/* Literal.Number.Float */
+.highlight .mf { color: #009999 }
+
+/* Literal.Number.Hex */
+.highlight .mh { color: #009999 }
+
+/* Literal.Number.Integer */
+.highlight .mi { color: #009999 }
+
+/* Literal.Number.Oct */
+.highlight .mo { color: #009999 }
+
+/* Literal.String.Backtick */
+.highlight .sb { color: #d14 }
+
+/* Literal.String.Char */
+.highlight .sc { color: #d14 }
+
+/* Literal.String.Doc */
+.highlight .sd { color: #d14 }
+
+/* Literal.String.Double */
+.highlight .s2 { color: #d14 }
+
+/* Literal.String.Escape */
+.highlight .se { color: #d14 }
+
+/* Literal.String.Heredoc */
+.highlight .sh { color: #d14 }
+
+/* Literal.String.Interpol */
+.highlight .si { color: #d14 }
+
+/* Literal.String.Other */
+.highlight .sx { color: #d14 }
+
+/* Literal.String.Regex */
+.highlight .sr { color: #009926 }
+
+/* Literal.String.Single */
+.highlight .s1 { color: #d14 }
+
+/* Literal.String.Symbol */
+.highlight .ss { color: #990073 }
+
+/* Name.Builtin.Pseudo */
+.highlight .bp { color: #999999 }
+
+/* Name.Variable.Class */
+.highlight .vc { color: #008080 }
+
+/* Name.Variable.Global */
+.highlight .vg { color: #008080 }
+
+/* Name.Variable.Instance */
+.highlight .vi { color: #008080 }
+
+/* Literal.Number.Integer.Long */
+.highlight .il { color: #009999 }