j1-template 2021.0.3 → 2021.0.8

data/lib/starter_web/_includes/tables/jekyll_variables.asciidoc

@@ -1,5 +1,5 @@
 .Jekyll variables (Liquid)
-[cols="3,3a,6a, options="header", width="100%", role="rtable mt-3"]
+[cols="3,3a,6a, subs=+macros, options="header", width="100%", role="rtable mt-3"]
 |===============================================================================
 |Name |Value |Description
 

data/lib/starter_web/_includes/tables/template_variables.asciidoc

@@ -1,5 +1,5 @@
 .Template variables (Asciidoc)
-[cols="cols="3,3a,6a, options="header", width="100%", role="rtable mt-3"]
+[cols="cols="3,3a,6a, subs=+macros, options="header", width="100%", role="rtable mt-3"]
 |===============================================================================
 |Name |Value |Description
 

data/lib/starter_web/_plugins/asciidoctor-extensions/fab-icon-inline.rb

@@ -26,7 +26,7 @@ Asciidoctor::Extensions.register do
       size_class = (size = attributes['size']) ? %(fa-#{size}) : nil
       modifier_class = (modifier = attributes['modifier']) ? %(#{modifier}) : nil
       icon_name = target.tr '_', '-'
-      %(<i class="fab #{size_class} #{modifier} fa-#{icon_name}"></i>)
+      %(<i class="fab fa-#{icon_name} #{size_class} #{modifier}"></i>)
     end
   end
   inline_macro FabIconInlineMacro

data/lib/starter_web/_plugins/lunr_index.rb

@@ -31,8 +31,8 @@ module Jekyll
         @module_path.slice! "_plugins"
         @module_config_path = File.join(@module_path, 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 = YAML::load(File.open(File.join(@module_config_path, 'defaults', 'quicksearch.yml')))
+        @module_config_user = YAML::load(File.open(File.join(@module_config_path,'quicksearch.yml')))
 
         @module_config_default_settings = @module_config_default['defaults']
         @module_config_user_settings = @module_config_user['settings']
@@ -83,17 +83,23 @@ module Jekyll
         #
         @strip_index_html = @lunr_config['strip_index_html']
 
+        # @strip_categories configuration
+        #
+        @strip_categories = @lunr_config['strip_categories']
+        @stripped_categories = @strip_categories.join(',').gsub!(',', ' ')
+
         # 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 ...'
+        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
 
         @site = site
         # gather posts and pages
@@ -103,7 +109,7 @@ module Jekyll
         # index = []
 
         index_js = open(@lunr_path).read
-        # all settings must be added within the index function
+        # NOTE: all settings must be added within the index function
         #
         index_js << 'var idx = lunr(function() {'
 
@@ -130,7 +136,11 @@ module Jekyll
             'body'        => entry.body
           }
 
+          # remove unwanted categories
+          doc['categories'] -= @strip_categories
+
           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
@@ -146,12 +156,13 @@ module Jekyll
           '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"
+        Jekyll.logger.info 'J1 QuickSearch:', "finished, index ready."
         added_files = [filename]
 
         # Keep the written files from being cleaned by Jekyll
@@ -250,7 +261,7 @@ module Jekyll
           elsif defined?(site.data['date'])
             date = site.data['date']
           else
-            date = '2020-01-01 00:00:00'
+            date = '2021-01-01 00:00:00'
           end
 
           tagline     = site.data['tagline']
@@ -261,6 +272,17 @@ module Jekyll
           is_post     = site.is_a?(Jekyll::Document)
           body        = renderer.render(site)
 
+          if description.nil? || description.length == 0
+            description = 'No description available.'
+          end
+
+          if site.is_a?(Jekyll::Document)
+            excerpt = extract_excerpt(site)
+            unless excerpt.nil? || excerpt.length == 0
+              description = excerpt
+            end
+          end
+          
           SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)
         else
           raise 'Not supported'
@@ -272,6 +294,14 @@ module Jekyll
         [ data['title'], data['url'] ]
       end
 
+      def self.extract_excerpt(item)
+        data = item.to_liquid
+        parsed_data = Nokogiri::HTML.parse(data['excerpt']).text
+        parsed_data.gsub!(/\n+/, ' ')
+        parsed_data.gsub!(/^\s+/, '')
+        parsed_data.gsub!(/\s+$/, '')
+      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)
@@ -311,6 +341,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '1.0.0'
+    VERSION = '2021.0.8'
   end
 end

data/lib/starter_web/_plugins/minifyJS.rb

@@ -33,6 +33,9 @@
 # rubocop:disable Layout/ExtraSpacing
 # rubocop:disable Metrics/AbcSize
 # ------------------------------------------------------------------------------
+# NOTE: To be checked if the gem uglifier can be replaced by the
+# JS module "Terser" already used for package 200_template_js
+# ------------------------------------------------------------------------------
 require 'uglifier'
 
 module Jekyll

data/lib/starter_web/assets/images/modules/icons/d1/scalable/d1.svg

@@ -14,7 +14,7 @@
    version="1.1"
    inkscape:version="1.0.1 (3bc2e813f5, 2020-09-07)"
    sodipodi:docname="d1.svg"
-   inkscape:export-filename="C:\Temp\d10n-2021.0.3\assets\images\modules\icons\d1\d1-256x256.png"
+   inkscape:export-filename="C:\Temp\d10n-2021.0.8\assets\images\modules\icons\d1\d1-256x256.png"
    inkscape:export-xdpi="49.152"
    inkscape:export-ydpi="49.152">
   <title

data/lib/starter_web/collections/posts/public/featured/_posts/0000-00-00-welcome-to-j1-template.adoc.erb

@@ -2,8 +2,6 @@
 title:                                  Welcome
 tagline:                                jekyll for everyone
 date:                                   <%= Time.now.strftime('%Y-%m-%d') %> 00:00:00
-description: >
-                                        Auto-generated welcome post
 
 tags:                                   [ Example, Post ]
 categories:                             [ Featured ]
@@ -34,12 +32,16 @@ resource_options:
 // Enable the Liquid Preprocessor
 :page-liquid:
 
+// Set (local) page attributes here
+// -----------------------------------------------------------------------------
+// :page--attr:                         <attr-value>
+
 // Place an excerpt at the most top position
 // -----------------------------------------------------------------------------
 All you're doing at the end of the day is writing your content and Jekyll does
 all the tricky things needed for a website: putting out HTML, Javascript and
-CSS. As a result, the site creation process gets out of your way. It's done
-by Jekyll, and allows you to concentrate on what truly matters: your content.
+CSS. As a result, the site creation process gets out of your way. Sounds fun,
+isn't it?
 
 [role="clearfix mb-3"]
 excerpt__end
@@ -50,23 +52,18 @@ excerpt__end
 
 // Load page attributes
 // -----------------------------------------------------------------------------
-{% include {{load_attributes}} scope="all" %}
-
-// Set page (local) attributes here
-// -----------------------------------------------------------------------------
-// :page--attr:                         <attr-value>
+{% include {{load_attributes}} scope="global" %}
 
 
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 
+// Include sub-documents
+// -----------------------------------------------------------------------------
+
 [[readmore]]
 == What is a static site?
 
-[role="mb-3"]
-// image::{{page.image}}[{{page.title}}]
-// image::/assets/images/modules/attics/spider-web-1920x1200-bw.png[{{page.title}}, 800]
-
 A static site serves the content straight to the user as it is stored on
 the server-side. To put it in another way, in opposition to WordPress
 which use a database to load dynamic content, a static site will display

data/lib/starter_web/collections/posts/public/featured/_posts/{2018-05-01-confusion-about-base-url.adoc → 2020-04-01-confusion-about-base-url.adoc}

@@ -1,12 +1,10 @@
 ---
 title:                                  Jekyll URLs
 tagline:                                what is baseurl
-date:                                   2018-05-01 00:00:00
-description: >
-                                        Jekyll URL Configuration
+date:                                   2020-04-01 00:00:00
 
 tags:                                   [ Jekyll, Configuration ]
-categories:                             [ Featured ]
+categories:                             [ Knowledge ]
 
 series:
 adsense:                                false
@@ -30,7 +28,7 @@ resource_options:
 // Enable the Liquid Preprocessor
 :page-liquid:
 
-// Set page (local) attributes here
+// Set (local) page attributes here
 // -----------------------------------------------------------------------------
 // :page--attr:                         <attr-value>
 :page-imagesdir: {{page.images.dir}}
@@ -58,6 +56,10 @@ excerpt__end
 
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+// Include sub-documents
+// -----------------------------------------------------------------------------
+
 [[readmore]]
 == Mimic GitHub Pages
 

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

@@ -1,16 +1,14 @@
 ---
 title:                                  Site generators
 tagline:                                OpenSource tools
-date:                                   2019-05-01 00:00:00
-description: >
-                                        Top Open Source site generators
+date:                                   2020-05-01 00:00:00
 
 tags:                                   [ Jekyll, Generators ]
 categories:                             [ Featured ]
 
 series:
 adsense:                                false
-image:                                  /assets/images/modules/attics/building-blocks-1920x1280-bw.jpg
+image:                                  /assets/images/modules/attics/machine-generator-1920x1280.jpg
 toc:                                    true
 
 regenerate:                             false
@@ -22,15 +20,15 @@ resource_options:
       padding_bottom:                   50
       opacity:                          0.5
       slides:
-        - url:                          /assets/images/modules/attics/building-blocks-1920x1280-bw.jpg
-          alt:                          Photo by Ryan Quintal on Unsplash
+        - url:                          /assets/images/modules/attics/machine-generator-1920x1280.jpg
+          alt:                          Photo by Isis Françal on Unsplash
 #         caption:
-#           text:                       Photo by Ryan Quintal on Unsplash
-#           href:                       https://unsplash.com/@ryanquintal/portfolio
+#           text:                       Photo by Isis Françal on Unsplash
+#           href:                       https://unsplash.com/@isisfra
           badge:
             type:                       unsplash
-            author:                     Ryan Quintal
-            href:                       https://unsplash.com/@ryanquintal/portfolio
+            author:                     Isis França
+            href:                       https://unsplash.com/@isisfra
 ---
 
 // Page Initializer
@@ -38,14 +36,15 @@ resource_options:
 // Enable the Liquid Preprocessor
 :page-liquid:
 
-// Set page (local) attributes here
+// Set (local) page attributes here
 // -----------------------------------------------------------------------------
 // :page--attr:                         <attr-value>
 
 // Place an excerpt at the most top position
 // -----------------------------------------------------------------------------
-This article highlights top OpenSource projects, in many different
-programming languages. Have a look what's going on the market.
+This article highlights top OpenSource projects providing static site
+generators, in many different programming languages. And Jekyll is only one of
+them. Have a look if an flull-blown CMS is (really) needed for your project!
 
 [role="clearfix mb-3"]
 excerpt__end
@@ -61,11 +60,14 @@ excerpt__end
 
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+// Include sub-documents
+// -----------------------------------------------------------------------------
+
 [[readmore]]
 == Static Site Generators
 
 [role="mb-3"]
-// image::{{page.image}}[{{page.title}}]
 image::/assets/images/collections/blog/featured/staticgen.jpg[{{page.title}}]
 
 A typical CMS driven website works by building each and every page dynamically.

data/lib/starter_web/collections/posts/public/featured/_posts/{2019-06-01-about-cookies.adoc → 2020-06-01-about-cookies.adoc}

@@ -1,9 +1,7 @@
 ---
 title:                                  Cookies
 tagline:                                good to know
-date:                                   2019-06-01 00:00:00
-description: >
-                                        Useful info on cookies and how they used
+date:                                   2020-06-01 00:00:00
 
 tags:                                   [ About, Cookies ]
 categories:                             [ Featured ]
@@ -39,7 +37,7 @@ resource_options:
 // Enable the Liquid Preprocessor
 :page-liquid:
 
-// Set page (local) attributes here
+// Set (local) page attributes here
 // -----------------------------------------------------------------------------
 // :page--attr:                         <attr-value>
 
@@ -49,22 +47,10 @@ resource_options:
 
 // Place an excerpt at the most top position
 // -----------------------------------------------------------------------------
-Is it needed for visitors to know what cookies are all about?
-
-Not the first place. Cookies are widely used. All users visiting web sites are
-bothered all the time to accept cookies. Because cookies are used that often.
-For good reasons - but for *different* reasons.
-
-To answer the question: yes, you should.
-
-All people are part of the *real* and virtual worlds as well; the internet,
-for example. In the real world, you've learned what cookies are. You can simply
-*see* them, smell them and eat some. For physical cookies, you know them as
-sweets from earliest days.
-
-But cookies in the digital world are different. Cookies in the sense of the
-internet, of the web are *not* dangerous but not necessarily a sort of sweets
-to enjoy people.
+Is it needed for visitors to know what cookies are about? No doubts, your're
+requested to inform - in Europe for legal reasons. All users visiting web sites
+are bothered all the time to accept on cookies. Cookies are used by sites
+of today. For good reasons?
 
 [role="clearfix mb-3"]
 excerpt__end
@@ -80,13 +66,13 @@ excerpt__end
 
 // Page content
 // ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+// Include sub-documents
+// -----------------------------------------------------------------------------
+
 [[readmore]]
 == What are cookies technically
 
-[role="mb-3"]
-// image::{{page.image}}[{{page.title}}]
-// image::/assets/images/modules/attics/cookies-1920x1200-bw.png[{{page.title}}, 800]
-
 In short words. A cookie is a small piece of data that a website asks your
 browser to store on your computer or mobile device. The cookie allows the
 website to "remember" your actions or preferences over time.