j1-template 2022.4.10 → 2022.5.0.rc2

data/lib/starter_web/Gemfile

@@ -11,49 +11,66 @@
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
 # ------------------------------------------------------------------------------
-#
-#  To install all gem needed for Jekyll and J1 Template
-#
-#  bundle install
-#
-#  Note:  If all packages needed are installed, a list of all gem
-#         and dependencies installed for the bundle can created
-#         by running:
-#
-#         bundle list
-#
+
 # ------------------------------------------------------------------------------
+# NOTE:
+# To install all gem needed for Jekyll and J1 Template:
+#   bundle install
 #
-#  If you see warnings like:
+# TIP:
+# If all packages needed are installed, a list of all gem and dependencies
+# installed for the bundle canbe created by running:
+#   bundle list
 #
+# ------------------------------------------------------------------------------
+# NOTE:
+# If you see warnings like:
 #   WARN: Unresolved specs during Gem::Specification.reset
-#         cleanup your bundle by running:
-#
-#         gem cleanup
+# you may need to cleanup your bundle by running:
+#   gem cleanup
 #
 # ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Define the (download) source, Ruby GEMs are to be loaded from REMOTE
+#
 source 'https://rubygems.org'
 
 # ------------------------------------------------------------------------------
-# Jekyll
-# NOTE: J1 Template is using Jekyll v3.8 and above
+# Specify your Ruby version if the J1 Project is used as an container-based
+# web application. This makes sure to use identical Ruby runtime environments
+# for BUILD and RUN (e.g. for Docker images or a Dyno on Heroku).
 #
+# ruby '3.1'
 
 # ------------------------------------------------------------------------------
-# Use Jekyll version from GH master
+# Jekyll
+# ------------------------------------------------------------------------------
+# NOTE:
+# J1 Template is using Jekyll v4.0 and above
+#
+# ------------------------------------------------------------------------------
+# NOTE:
+# Use|Install a Jekyll version loaded from 'Github' (branch: master):
+#  gem 'jekyll', github: 'jekyll/jekyll'
+# ------------------------------------------------------------------------------
+# NOTE:
+# For default, the Jekyll GEM is loaded from REMOTE
+# ------------------------------------------------------------------------------
 #
-# Support for Ruby version 2.7 (DEC 2019)
-# See: https://github.com/jekyll/jekyll/issues/8049
-# gem 'jekyll', github: 'jekyll/jekyll'
+gem 'jekyll', '~> 4.0'
 
 # ------------------------------------------------------------------------------
-# Use Jekyll version from RubyGems
+# Install Webrick GEM (internally used Web Server) if Ruby V3 is used
 #
-gem 'jekyll', '~> 4.2'
+install_if -> { RUBY_VERSION =~ /3/ } do
+  gem 'webrick', '~> 1.7'
+end
 
-# Theme Rubies, default: J1 Template (NOT used for the development system)
+# ------------------------------------------------------------------------------
+# Specify the THEME GEM used for the project
 #
-gem 'j1-template', '~> 2022.4.10'
+gem 'j1-template', '~> 2022.5.0.rc2'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment
@@ -73,13 +90,13 @@ gem 'nokogiri-pretty', '>= 0.1.0'
 gem 'htmlbeautifier', '>= 1.2.1'
 
 # ------------------------------------------------------------------------------
-# Gem needed to compress JS and JSON files
+# Compress JS and JSON files
 #
 gem 'uglifier', '~> 4.2'
 gem 'json-minify', '~> 0.0.3'
 
 # ------------------------------------------------------------------------------
-# Gem needed to run JS to create Lunr the index
+# Run JS code (from Ruby) to create the index for Lunr
 #
 gem 'execjs', '~> 2.7'
 
@@ -89,56 +106,79 @@ gem 'execjs', '~> 2.7'
 gem 'tzinfo', '>= 1.2.2'
 
 # ------------------------------------------------------------------------------
-# Platform specific Gem
+# Platform specific GEM
 #
-
+# NOTE:
 # Windows does not include zoneinfo files (timezone support).
 # To provide zoneinfo, tzinfo-data gem is bundled on win platforms
 #
-gem 'tzinfo-data' if Gem.win_platform?
-
-# Windows Directory Monitor (WDM) monitor directories
+# ------------------------------------------------------------------------------
+# NOTE:
+# Windows Directory Monitor (WDM) required to monitor directories
 # for changes
 #
-gem 'wdm', '>= 0.1.1' if Gem.win_platform?
+# ------------------------------------------------------------------------------
+#
+install_if -> { Gem.win_platform? } do
+  gem 'tzinfo-data'
+  gem 'wdm', '>= 0.1.1'
+end
 
 # ------------------------------------------------------------------------------
 # Jekyll Plugins
-# If any (additional) plugins are used, they goes here:
-# ------------------------------------------------------------------------------
-# NOTE: asciidoctor v2.x (automatically loaded via ???) creates corrupted
-#  asciidoctor-rouge output. Currently, older/latest version v1.x is used
+# If any (additional) Jekyll Plugins are used, they goes here
 #
 group :jekyll_plugins do
-# gem 'algolia', '~> 2.0', '>= 2.0.4'                                           # New/latest (Jekyll-)Algolia gem
-  gem 'asciidoctor', '= 1.5.8'                                                  # See notes!!!
-# gem 'asciidoctor-pdf', '>= 1.5.4'                                             # Used for PDF creation only
-  gem 'asciidoctor-rouge', '>= 0.4.0'
+  # Base Jekyll Plugins (required)
+  #
+  gem 'asciidoctor', '~> 2.0'
   gem 'jekyll-asciidoc', '>= 3.0.0'
-# gem 'jekyll-feed', ">= 0.15.1"
-# gem 'jekyll-gist', '>= 1.5.0'                                                 # Useful ???
-# gem 'jekyll-redirect-from', '>= 0.16.0'                                       # Useful ???
-# gem 'jekyll-sass-converter', '>= 2.1.0'                                       # Used if SASS (file) conversion is enabled
-  gem 'jekyll-sitemap', '>= 1.2.0'
-  gem 'j1-paginator', '>= 2021.1.1'                                             # New version !!!
+  gem 'j1-paginator', '>= 2021.1.1'
+  #
+  # Additional Supporting GEMs (optional)
+  #
+  # gem 'algolia', '~> 2.0', '>= 2.0.4'                                         # Required for Algolia support only
+  # gem 'asciidoctor-pdf', '>= 1.5.4'                                           # Required for Asciidoctor PDF creation only
+  # gem 'jekyll-sass-converter', '>= 2.1.0'                                     # Required for Jekyll|SASS (file) conversion support
+  #
+  # Additional Jekyll Plugins  (optional)
+  #
+  gem 'jekyll-sitemap', '>= 1.2.0'                                              # Create XML sitemap (recommended)
+  # gem 'jekyll-feed', ">= 0.15.1"
+  # gem 'jekyll-gist', '>= 1.5.0'
+  # gem 'jekyll-redirect-from', '>= 0.16.0'
 end
 
 # ------------------------------------------------------------------------------
-# Web Application specific RubyGems
+# GEM needed for the Jekyll and J1 dev environment
+#
+# NOTE:
+# For the build (npm|yarn), J1 Template is using scss_lint
+# for linting the SCSS (Sass) components.
 #
+# ------------------------------------------------------------------------------
+# NOTE:
+# scss_lint is based on old gem 'sass', '~> 3.5.5'. A replacement
+# is needed (?) for a linter using the new Ruby Sass GEM (sassc)
+# gem 'scss_lint', '~> 0.56.0', require: false
+#
+# ------------------------------------------------------------------------------
+gem 'sassc', '~> 2.4'
+gem 'bump', '~> 0.10'
 
 # ------------------------------------------------------------------------------
-# Define your Ruby version if the J1 web is used as an container-based
-# web application, e.g. on Docker or a Heroku Dyno, to define and use
-# of identical Ruby runtime environments.
+# Web Application specific RubyGems
 #
-# ruby '2.7.2'
 
 # ------------------------------------------------------------------------------
+# Ruby Task Manager
+#
+# NOTE:
 # Enable the `rake` Gem if needed. For container-based apps, Rake can
 # be used as a pre-processor engine running # tasks defined by a
 # Rakefile prior running the app|web.
 #
+# ------------------------------------------------------------------------------
 # gem 'rake', '~> 12.0'
 
 # html-proofer. Automate the process of checking links on your site
@@ -154,6 +194,9 @@ end
 # gem 'html-proofer', '~> 3.10'
 
 # ------------------------------------------------------------------------------
+# Web server used by applications
+#
+# NOTE:
 # Define the build environment and the web server for J1 sites that
 # runs as an web application. To improve the production (run-time)
 # performance for the web, the RubyGems e.g Puma or Passenger can be
@@ -165,59 +208,63 @@ end
 # For container-based apps, Rake can be used as a pre-processor engine
 # running # tasks defined by a Rakefile prior running the app|web.
 #
+# ------------------------------------------------------------------------------
+#
 # gem 'passenger', '>= 5.3'
 gem 'puma', '>= 5.5.2'
 
 # ------------------------------------------------------------------------------
+# Data encryption (currently NOT supported)
+#
+# NOTE:
 # OpenSSL provides SSL, TLS and general purpose cryptography. Used to
-# encrypt 'private' data
-# NOTE: currently NOT used
+# encrypt 'private' data used by applications.
 #
+# ------------------------------------------------------------------------------
 # gem 'openssl'
 
 # ------------------------------------------------------------------------------
+# Runtime environment for applications
+#
+# NOTE:
 # If J1 is transformed into a (Rack and Sinatra based) Web
 # application, the site can be secured using user authentication
 # for accessing private pages. J1 is using the Omniauth stack for
 # authentication. For default, the Omniauth (authentication) strategies
 # for Github, Twitter, Facebook and Patreon are implemented.
 #
+# ------------------------------------------------------------------------------
 gem 'rack', '~> 2.2', '>= 2.2.3'
 gem 'rack-protection', '~> 2.0'
 gem 'rack-ssl-enforcer', '~> 0.2'
 gem 'rest-client', '~> 2.0'
+gem 'sinatra', '~> 2.0'
+gem 'warden', '~> 1.2'
 
-# NOTE: For the base gem omniauth, the currtent version >= 2 cannot be
-#       used. For unknown reason, a WRONG redirect URL is calculated
-#       e.g. for strategy oauth2/github
+# ------------------------------------------------------------------------------
+# Authentication
 #
-#       Wrong:    http://localhost:xxx/auth/github
-#       Correct:  https://github.com/login?client_id=xx&return=yyy
+# NOTE:
+# For the base gem omniauth, the currtent version >= 2 cannot be
+# used. For unknown reason, a WRONG redirect URL is calculated
+# e.g. for strategy oauth2/github
+#   Wrong:    http://localhost:xxx/auth/github
+#   Correct:  https://github.com/login?client_id=xx&return=yyy
 #
+# ------------------------------------------------------------------------------
+# Note:
+# For upcoming J1 versions, v2.x version will be used
 # gem 'omniauth', '~> 2.0'
-
-gem 'omniauth', '~> 1.0'                                                        # latest: 1.9.1
+# ------------------------------------------------------------------------------
+gem 'omniauth', '~> 1.9'
 gem 'omniauth-oauth2', '~> 1.7'
 
-gem 'sinatra', '~> 2.0'
-gem 'warden', '~> 1.2'
-
 # ------------------------------------------------------------------------------
-# Gem needed for J1 logger based on log4r (middleware)
-#
+# Logging
+# GEM required for J1 logger based on log4r (middleware)
+# ------------------------------------------------------------------------------
 gem 'log4r', '~> 1.1', '>= 1.1.10'
 gem 'date', '~> 2.0'
 
-# ------------------------------------------------------------------------------
-# DEVELOPMENT: Gem needed for the Jekyll and J1 dev environment
-#
-
-# For the build (npm|yarn), J1 Template is using scss_lint
-# for linting the SCSS (CSS) components:
-#
-gem 'scss_lint', '~> 0.56.0'
-gem 'sass', '~> 3.5.0'
-gem 'bump', '~> 0.8'
-
 # ------------------------------------------------------------------------------
 # END

data/lib/starter_web/_config.yml

@@ -10,6 +10,8 @@
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
 # ------------------------------------------------------------------------------
+# WARNING: This configuration can only be used for Ruby V3
+# ------------------------------------------------------------------------------
 
 # ==============================================================================
 # 1. BUILD configuration
@@ -53,7 +55,7 @@ environment:                            development
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2022.4.10
+version:                                2022.5.0.rc2
 
 # version
 # ------------------------------------------------------------------------------
@@ -74,16 +76,11 @@ copyright:                              © 2022 J1 · All rights reserved
 # components are available public at RubyGems.org.
 #
 #
-# theme (NOT set for development system)
+# theme
 # ------------------------------------------------------------------------------
 #   Sets the name of the (gem-based) theme used for Jekyll
 #   serve and build
 #
-#   Note: Do not change anything here because (gem-based) theme name
-#   information is bumped-in by the build process automatically
-#
-#   default:                            j1-template
-#
 theme:                                  j1-template
 
 # ------------------------------------------------------------------------------
@@ -269,7 +266,7 @@ robots:
 # Set the brand image and favicon (located in /asset/images)
 
 brand:
-  image:                                modules/icons/j1/j1-512x512.png
+  image:                                icons/j1/j1-512x512.png
   image_height:                         48px
   text:                                 Jekyll One
   text_color:                           "#9E9E9E"
@@ -277,7 +274,7 @@ brand:
 # Set the favicon and type
 #
 favicon:
-  image:                                modules/icons/j1/j1-32x32.ico
+  image:                                icons/j1/j1-32x32.ico
   type:                                 image/ico
 
 # ==============================================================================

data/lib/starter_web/_data/modules/attics.yml

@@ -53,13 +53,19 @@ settings:
         enabled:                        true
         id:                             attic_home
         layout:                         home
+#       title_animate:                  animate__fadeInDown
+#       raised_level:                   15
         padding_top:                    400
         padding_bottom:                 50
         opacity:                        0.5
-#       title_animate:                  animate__fadeInDown
-#       raised_level:                   15
-#       background_color_1:             "#512DA8"                               # deep-purple-700
-#       background_color_2:             "#B39DDB"                               # deep-purple-200
+#       background_color_1:             transparent
+#       background_color_2:             transparent
+        background_color_1:             "#0D47A1"                               # md-blue-900
+        background_color_2:             "#0D47A1"                               # md-blue-900
+        filters:
+          grayscale:                    1
+          contrast:                     0.8
+          brightness:                   0.8
 
     # --------------------------------------------------------------------------
     # layouts posts|pages
@@ -72,6 +78,9 @@ settings:
         padding_top:                    400
         padding_bottom:                 50
         opacity:                        0.5
+        filters:
+          grayscale:                    0.5
+          sepia:                        0.5
 
     # --------------------------------------------------------------------------
     # layouts raw

data/lib/starter_web/_data/modules/defaults/attics.yml

@@ -51,7 +51,7 @@ defaults:
 
   title_size:                           3em
   title_color:                          rgba(255, 255, 255, 0.8)                # rgba_lighten_800
-  title_animate:                        animate__bounceInDown                            # fadeInDown fadeInLeft
+  title_animate:                        animate__bounceInDown                   # fadeInDown fadeInLeft
   title_align:                          left
 
   tagline_size:                         1.5em

data/lib/starter_web/_data/modules/defaults/navigator.yml

@@ -128,7 +128,7 @@ defaults:
 
     raised_level:                       5                                       # level
     delay_menu_open:                    200                                     # milli seconds
-    max_height:                         550                                     # px
+    max_height:                         600                                     # px
     menu_font_size:                     larger
     megamenu_font_size:                 small
     icon_family:                        MDI
@@ -146,7 +146,7 @@ defaults:
     dropdown_animate_out:               fadeOutDown
     dropdown_animate_duration:          .75                                     # seconds
     dropdown_item_min_width:            15                                      # rem
-    dropdown_menu_max_height:           25.5                                    # rem
+    dropdown_menu_max_height:           27                                      # rem
     dropdown_font_size:                 small
     dropdown_padding_x:                 18                                      # rem
     dropdown_padding_y:                 10                                      # px
@@ -240,7 +240,7 @@ defaults:
     close_icon:                         close
     clear_icon:                         format-clear
     input_color:                        rgba(0, 0, 0, 0.7)                      # rgba-darken-700
-    background_color:                   "#FAFAFA"                               # md-grey-50
+    background_color:                   transparent                               # md-grey-50
     placeholder:                        Your search expression
     search_heading_lead:                ""
     result_heading_lead:                ""

data/lib/starter_web/_data/modules/defaults/themer.yml

@@ -150,7 +150,7 @@ defaults:
 
   reloadPageOnChange:                   false                                   # reload current page, if theme has been changed
   retries:                              30                                      # retry to load theme list from API
-  preview_page:                         /pages/public/previewer/theme/
+  preview_page:                         /pages/public/previewer/current_theme/
   menu_icon_family:                     MDI
   menu_icon_color:                      "#9E9E9E"
   menu_icon_size:                       mdi-sm

data/lib/starter_web/_data/modules/navigator.yml

@@ -100,7 +100,7 @@ settings:
       # DRAWER Sidebar
       #
       - menu:
-          enabled:                      true
+          enabled:                      false
 
           xhr_container_id:             navigator_sidebar_mmenu
           xhr_data_element:             sidebar_mmenu
@@ -128,7 +128,7 @@ settings:
                     - title:            Name
                       icon:             face
                       value:            ??theme-name
-                      href:             /pages/public/previewer/theme/
+                      href:             /pages/public/previewer/current_theme/
                       target:           none
                     - title:            Author
                       icon:             grease-pencil
@@ -138,7 +138,7 @@ settings:
                     - title:            Version
                       icon:             numeric
                       value:            ??theme-version
-                      href:             /pages/public/previewer/theme/
+                      href:             /pages/public/previewer/current_theme/
                       target:           none
 
               - box: