j1-template 2020.0.22 → 2020.0.24

data/lib/starter_web/_includes/attributes.asciidoc

@@ -133,7 +133,7 @@ end::urls[]
 // -----------------------------------------------------------------------------
 tag::tags[]
 
-:browser-window--new:                             window="blank"
+:browser-window--new:                             window="_blank"
 :clipboard--noclip:                               noclip
 :level--beginner:                                 icon:battery-quarter[role="md-blue"]
 :level--advanced:                                 icon:battery-full[role="md-blue"]
@@ -182,7 +182,7 @@ end::tables[]
 // -----------------------------------------------------------------------------
 tag::products[]
 :j1-license:                                      MIT License
-:j1-version:                                      2020.0.22
+:j1-version:                                      2020.0.24
 end::products[]
 
 

data/lib/starter_web/_includes/breadcrumbs.html

@@ -0,0 +1,11 @@
+<div id="breadcrumbs" class="mb-3">
+{% assign crumbs = page.url | remove:'/index.html' | split: '/' %}
+<a href="/">Home</a>
+{% for crumb in crumbs offset: 1 %}
+  {% if forloop.last %}
+    • {{ page.title }}
+  {% else %}
+    • <a href="{% assign crumb_limit = forloop.index | plus: 1 %}{% for crumb in crumbs limit: crumb_limit %}{{ crumb | append: '/' | replace:'without-plugin/','without-plugins/' }}{% endfor %}">{{ crumb | replace:'-',' ' | remove:'.html' | capitalize }}</a>
+  {% endif %}
+{% endfor %}
+</div>

data/lib/starter_web/_plugins/debug.rb

@@ -9,7 +9,6 @@
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 #  USAGE:
 #  Can be used anywhere liquid syntax is parsed with templates, includes,

data/lib/starter_web/_plugins/filters.rb

@@ -9,7 +9,6 @@
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 #
 #  NOTE:

data/lib/starter_web/_plugins/{lorem-inline.rb → lorem_inline.rb}

@@ -1,5 +1,5 @@
 # ------------------------------------------------------------------------------
-# ~/_plugins/asciidoctor-extensions/lorem-block.rb
+# ~/_plugins/asciidoctor-extensions/lorem_inline.rb
 # Asciidoctor extension for J1 Template
 #
 # Product/Info:
@@ -9,7 +9,6 @@
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 # An extension that implements several type of (lorem) blind text
 #

data/lib/starter_web/_plugins/lunr_index.rb

@@ -0,0 +1,313 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/lunr_index.rb
+# Creates an lunr index file (json) to be used by J1LunrSearch
+#
+# Product/Info:
+# http://jekyll.one
+#
+# Copyright (C) 2020 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+# ------------------------------------------------------------------------------
+require 'fileutils'
+require 'net/http'
+require 'json'
+require 'uri'
+require 'execjs'
+require 'yaml'
+
+module Jekyll
+  module J1LunrSearch
+    #noinspection RubyTooManyInstanceVariablesInspection
+    class Indexer < Jekyll::Generator
+      def initialize(config = {})
+        super(config)
+
+        @mode = config['environment']
+        @template = config['theme']
+        @module_config_path = File.join(File.dirname(__FILE__), '..', config['data_dir'], 'modules')
+
+        @module_config_default = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'lunr_search.yml')))
+        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'lunr_search.yml')))
+
+        @module_config_default_settings = @module_config_default['defaults']
+        @module_config_user_settings = @module_config_user['settings']
+        @module_config = @module_config_default_settings.merge!(@module_config_user_settings)
+
+        @lunr_config = {
+          'excludes' => [],
+          'strip_index_html' => false,
+          'min_length' => 3,
+          'stopwords' => 'stopwords.txt',
+          'fields' => {
+            'title' => 10,
+            'tagline' => 10,
+            'tags' => 20,
+            'categories' => 20,
+            'description' => 20,
+            'body' => 1
+          }
+        }.merge!(@module_config || {})
+
+        @module_dir = @lunr_config['module_dir']
+        @index_dir  = @lunr_config['index_dir']
+        @index_name = @lunr_config['index_name']
+
+        # calculate the module path
+        # if NO template GEM is used (dev system), @module_path points
+        # in the project folder, otherwise (runtime system) to the Ruby
+        # GEM installation folder!
+        #
+        if @template.nil?
+          @module_path = File.join(File.dirname(__FILE__), '../', @module_dir)
+        else
+          @gem_path    = `bundle info --path j1-template`
+          @module_path = File.join(@gem_path.chomp, @module_dir)
+        end
+
+        @lunr_path = File.join(@module_path, 'lunr.min.js')
+        raise "Could not find #{@lunr_path}" unless File.exist?(@lunr_path)
+
+        lunr_src = open(@lunr_path).read
+        ctx = ExecJS.compile(lunr_src)
+
+        @docs = {}
+        @excludes = @lunr_config['excludes']
+
+        # if web host supports index.html as default doc, then
+        # optionally exclude it from the url
+        #
+        @strip_index_html = @lunr_config['strip_index_html']
+
+        # stop word exclusion configuration
+        #
+        @min_length = @lunr_config['min_length']
+        @stopwords_file = @lunr_config['stopwords']
+      end
+
+      # Index all pages except pages matching any value in config['lunr_excludes']
+      # or with frontmatter settings (exclude_from_search: true)
+      #
+      def generate(site)
+        Jekyll.logger.info 'J1 LunrSearch:', 'creating search index ...'
+
+        @site = site
+        # gather posts and pages
+        #
+        items = pages_to_index(site)
+        content_renderer = PageRenderer.new(site)
+        # index = []
+
+        index_js = open(@lunr_path).read
+        # all settings must be added within the index function
+        #
+        index_js << 'var idx = lunr(function() {'
+
+        @lunr_config['fields'].each_pair do |name, boost|
+            index_js << "this.field('#{name}', {'boost': #{boost}});"
+        end
+
+        items.each_with_index do |item, i|
+          entry = SearchEntry.create(item, content_renderer)
+
+          entry.strip_index_suffix_from_url! if @strip_index_html
+          entry.strip_stopwords!(stopwords, @min_length) if File.exists?(@stopwords_file)
+
+          doc = {
+            'id'          => i,
+            'title'       => entry.title,
+            'tagline'     => entry.tagline,
+            'url'         => entry.url,
+            'date'        => entry.date,
+            'tags'        => entry.tags,
+            'categories'  => entry.categories,
+            'description' => entry.description,
+            'is_post'     => entry.is_post,
+            'body'        => entry.body
+          }
+
+          index_js << 'this.add(' << ::JSON.generate(doc, quirks_mode: true) << ');'
+          # reduce the size of the doc array by deleting the body key
+          doc.delete('body')
+          @docs[i] = doc
+
+        end
+        index_js << '});'
+
+        filename  = File.join(@index_dir, "#{@index_name}")
+        ctx       = ExecJS.compile(index_js)
+        index     = ctx.eval('JSON.stringify(idx)')
+
+        total     = {
+          'docs'  => @docs,
+          'index' => ::JSON.parse(index, {:max_nesting => false})
+        }
+
+        filepath  = File.join(site.dest, filename)
+        # create data path if not already exists
+        FileUtils.mkdir_p(File.dirname(filepath))
+        File.open(filepath, 'w') { |f| f.write(JSON.dump(total)) }
+        Jekyll.logger.info 'J1 LunrSearch:', "finished, index ready"
+        added_files = [filename]
+
+        # Keep the written files from being cleaned by Jekyll
+        #
+        added_files.each do |fname|
+          site.static_files << SearchIndexFile.new(site, site.dest, '/', fname)
+        end
+      end
+
+      private
+
+      # load the stopwords (file)
+      #
+      def stopwords
+        @stopwords ||= IO.readlines(@stopwords_file).map { |l| l.strip }
+      end
+
+      def output_ext(doc)
+        if doc.is_a?(Jekyll::Document)
+          Jekyll::Renderer.new(@site, doc).output_ext
+        else
+          doc.output_ext
+        end
+      end
+
+      def pages_to_index(site)
+        items = []
+
+        # deep copy pages and documents (all collections, including posts)
+        #
+        site.pages.each {|page| items << page.dup }
+        site.documents.each {|document| items << document.dup }
+
+        # process only files that will be converted to .html and only
+        # non excluded files
+        #
+        items.select! {|i| i.respond_to?(:output_ext) && output_ext(i) == '.html' && ! @excludes.any? {|s| (i.url =~ Regexp.new(s)) != nil } }
+        items.reject! {|i| i.data['exclude_from_search'] }
+
+        items
+      end
+    end
+  end
+end
+
+require 'nokogiri'
+module Jekyll
+  module J1LunrSearch
+    class PageRenderer
+      def initialize(site)
+        @site = site
+      end
+
+      # render item, but without using its layout
+      #
+      def prepare(item)
+        layout = item.data['layout']
+        begin
+          item.data['layout'] = nil
+
+          if item.is_a?(Jekyll::Document)
+            output = Jekyll::Renderer.new(@site, item).run
+          else
+            item.render({}, @site.site_payload)
+            output = item.output
+          end
+        ensure
+          # restore original layout
+          #
+          item.data['layout'] = layout
+        end
+
+        output
+      end
+
+      # render the item, parse the output and get all text elements
+      #
+      def render(item)
+        layoutless = item.dup
+        Nokogiri::HTML(prepare(layoutless)).text
+      end
+    end
+  end
+end
+
+require 'nokogiri'
+module Jekyll
+  module J1LunrSearch
+    #noinspection RubyTooManyInstanceVariablesInspection
+    class SearchEntry
+      def self.create(site, renderer)
+        if site.is_a?(Jekyll::Page) or site.is_a?(Jekyll::Document)
+
+          if defined?(site.date)
+            date = site.date
+          elsif defined?(site.data['date'])
+            date = site.data['date']
+          else
+            date = '2020-01-01 00:00:00'
+          end
+
+          tagline     = site.data['tagline']
+          tags        = site.data['tags']
+          categories  = site.data['categories']
+          description = site.data['description']
+          title, url  = extract_title_and_url(site)
+          is_post     = site.is_a?(Jekyll::Document)
+          body        = renderer.render(site)
+
+          SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)
+        else
+          raise 'Not supported'
+        end
+      end
+
+      def self.extract_title_and_url(item)
+        data = item.to_liquid
+        [ data['title'], data['url'] ]
+      end
+
+      attr_reader :title, :tagline, :url, :date, :tags, :categories, :description, :is_post, :body, :collection
+
+      def initialize(title, tagline, url, date, tags, categories, description, is_post, body, collection)
+        @title, @tagline, @url, @date,@tags,  @categories, @description, @is_post, @body, @collection = title, tagline, url, date, tags, categories, description, is_post, body, collection
+      end
+
+      def strip_index_suffix_from_url!
+        @url.gsub!(/index\.html$/, '')
+      end
+
+      # remove anything that is in the stop words list from
+      # the text to be indexed
+      #
+      def strip_stopwords!(stopwords, min_length)
+        #noinspection RubyParenthesesAfterMethodCallInspection
+        @body = @body.split.delete_if() do |x|
+          t = x.downcase.gsub(/[^a-z]/, '')
+          t.length < min_length || stopwords.include?(t)
+        end.join(' ')
+      end
+    end
+  end
+end
+
+module Jekyll
+  module J1LunrSearch
+    class SearchIndexFile < Jekyll::StaticFile
+      # Override write as the lunr index file has been
+      # already created
+      #
+      def write(dest)
+        true
+      end
+    end
+  end
+end
+
+module Jekyll
+  module J1LunrSearch
+    VERSION = '1.0.0'
+  end
+end

data/lib/starter_web/_plugins/prettify.rb

@@ -9,9 +9,7 @@
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
-#
 #  NOTE:
 #  CustomFilters cannot be used in SAFE mode (e.g not usable for
 #  rendering pages with Jekyll on GitHub
@@ -23,7 +21,6 @@
 #
 #    {% endcapture %}
 #    {{ cache_name | pretty_print }}
-#
 # ------------------------------------------------------------------------------
 require 'nokogiri'
 require 'nokogiri-pretty'

data/lib/starter_web/_plugins/simple_search_filter.rb

@@ -9,7 +9,6 @@
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 
 module Jekyll

data/lib/starter_web/_plugins/symlink_watcher.rb

@@ -13,14 +13,13 @@
 # See: https://github.com/willnorris/willnorris.com/blob/master/LICENSE
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
-#
 # ------------------------------------------------------------------------------
 # NOTE:
 #   The symlink_watcher plugin extends jekyll-watch to listen also
 #   for changes in any symlinked sub-directory.
 #
-#   For example, in _drafts directory is a symlink to a directory 
-#   elsewhere on the filesystem. This plugin will cause jekyll to 
+#   For example, in _drafts directory is a symlink to a directory
+#   elsewhere on the filesystem. This plugin will cause jekyll to
 #   regenerate the site when ANY file change in the drafts folder.
 # ------------------------------------------------------------------------------
 require "find"

data/lib/starter_web/collections/posts/public/featured/_posts/2018-05-01-confusion-about-base-url.adoc

@@ -6,12 +6,10 @@ description:                            Jekyll URL Configuration
 date:                                   2018-05-01 00:00:00
 series:
 adsense:                                false
-#image:                                  /assets/images/modules/attics/cookies-1920x1200-bw.jpg
-image:                                 /assets/images/collections/blog/featured/what-is-a-baseurl.jpg
+image:                                  /assets/images/collections/blog/featured/what-is-a-baseurl.jpg
 
 tags:                                   [ Jekyll, Configuration ]
-index:                                  [ Jekyll, Configuration, URL, base_url ]
-categories:                             [ featured ]
+categories:                             [ Featured ]
 
 regenerate:                             false
 

data/lib/starter_web/collections/posts/public/featured/_posts/2019-05-01-top-open-source-static-site-generators.adoc

@@ -9,9 +9,9 @@ adsense:                                false
 image:                                  /assets/images/modules/attics/building-blocks-1920x1280-bw.jpg
 
 tags:                                   [ Jekyll, Generators ]
-index:                                  [ Jekyll, Top, Open, Source, Static, Site, Generators ]
-categories:                             []
+categories:                             [ Featured ]
 
+toc:                                    true
 regenerate:                             false
 
 resources:                              []
@@ -72,6 +72,8 @@ That means fetching the content from a database to pass them over to a template
 system for adding the required structure information (e.g. CSS styles).
 This means each page is assembled on demand.
 
+=== Is an CMS needed?
+
 For many, many websites dynamic page generation is entirely unnecessary and
 adds unwanted risks in terms of complexity, performance losses and security
 issues. After all, the content of most websites changes only, when the content