j1-template 2021.0.16 → 2021.1.0

data/lib/j1_app/j1_site_manager/static_site.rb

@@ -5,6 +5,18 @@ module J1App
     # Sinatra Framework settings
     # ==========================================================================
 
+    # Additional (response) header properties managed by Sinatra::Base
+    # NOTE: for the static content 'Access-Control-Allow-Origin'
+    # is NOT needed ???
+    # --------------------------------------------------------------------------
+    # NOTE: Response header properties are currently set
+    # by HAProxy for production !!!
+    # --------------------------------------------------------------------------
+    # before do
+    #   response.headers['Access-Control-Allow-Origin']   = '*'
+    #   response.headers['X-Powered-By']                  = 'J1 Template'
+    # end
+
     # NOTE: https://stackoverflow.com/questions/7847536/sinatra-in-facebook-iframe
     #
     #set :protection, :except => :frame_options
@@ -15,7 +27,7 @@ module J1App
 
     # Sinatra extension 'sinatra-cross_origin' to enable CORS
     # See: https://github.com/britg/sinatra-cross_origin
-    # Resource Sharing (CORS). 
+    # Resource Sharing (CORS).
     # See more on cross domain resource sharing with:
     #   https://developer.mozilla.org/En/HTTP_access_control
     # --------------------------------------------------------------------------
@@ -24,16 +36,6 @@ module J1App
     #   enable :cross_origin
     # end
 
-    # Additional (response) headers  managed by Sinatra extension
-    # 'sinatra-cross_origin'
-    # NOTE: for the static content 'Access-Control-Allow-Origin'
-    # is NOT needed
-    # --------------------------------------------------------------------------
-    # before do
-    #   response.headers['Access-Control-Allow-Origin']   = '*'
-    #   response.headers['X-Powered-By']                  = 'J1 Template'
-    # end
-
     # OPTION BLOCK for Sinatra extension 'sinatra-cross_origin'
     # Send a HTTP 200 response on the CORS preflight request (browser)
     # --------------------------------------------------------------------------

data/lib/starter_web/Gemfile

@@ -1,5 +1,5 @@
 # ------------------------------------------------------------------------------
-# ~/Gemfile (run-time)
+# ~/Gemfile (runtime)
 # Provides package information to bundle all Ruby gem needed
 # for Jekyll and J1 template (managed by Ruby Gem Bundler)
 #
@@ -52,9 +52,9 @@ ruby RUBY_VERSION
 #
 gem 'jekyll', '~> 4.2'
 
-# Theme Rubies, default: J1 Template
+# Theme Rubies, default: J1 Template (NOT used for the development system)
 #
-gem 'j1-template', '~> 2021.0.16'
+gem 'j1-template', '~> 2021.1.0'
 
 # ------------------------------------------------------------------------------
 # PRODUCTION: Gem needed for the Jekyll and J1 prod environment
@@ -111,17 +111,17 @@ gem 'wdm', '>= 0.1.1' if Gem.win_platform?
 #  asciidoctor-rouge output. Currently, older/latest version v1.x is used
 #
 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'                                             # Needed ???
+# gem 'asciidoctor-pdf', '>= 1.5.4'                                             # Used for PDF creation only
   gem 'asciidoctor-rouge', '>= 0.4.0'
   gem 'jekyll-asciidoc', '>= 3.0.0'
-# gem 'jekyll-algolia', '~> 1.6'                                                # Needed ??? Supported ???
 # gem 'jekyll-feed', ">= 0.15.1"
-# gem 'jekyll-gist', '>= 1.5.0'                                                 # Needed ???, Gist supported asciidoc-extention
-# gem 'jekyll-redirect-from', '>= 0.16.0'                                       # Needed ???
-# gem 'jekyll-sass-converter', '>= 2.1.0'                                       # Needed ??? Supported ???
+# 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', '>= 2020.0.2'
+  gem 'j1-paginator', '>= 2021.1.0'                                             # New version !!!
 end
 
 # ------------------------------------------------------------------------------
@@ -133,7 +133,7 @@ end
 # web application, e.g. on Docker or a Heroku Dyno, to define and use
 # of identical Ruby runtime environments.
 #
-# ruby '2.6.5'
+# ruby '2.7.2'
 
 # ------------------------------------------------------------------------------
 # Enable the `rake` Gem if needed. For container-based apps, Rake can
@@ -181,19 +181,25 @@ gem 'rack-protection', '~> 2.0'
 gem 'rack-ssl-enforcer', '~> 0.2'
 gem 'rest-client', '~> 2.0'
 
-gem 'omniauth', '>= 2.0'
+# 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
+#
+# gem 'omniauth', '~> 2.0'
+
+gem 'omniauth', '~> 1.0'                                                        # latest: 1.9.1
 gem 'omniauth-oauth2', '~> 1.7'
 
 gem 'sinatra', '~> 2.0'
-gem 'sinatra-cross_origin', '~> 0.3.1'
-
 gem 'warden', '~> 1.2'
 
 # ------------------------------------------------------------------------------
 # Gem needed for J1 logger based on log4r (middleware)
 #
 gem 'log4r', '~> 1.1', '>= 1.1.10'
-gem 'uuid', '~> 2.3', '>= 2.3.8'
 gem 'date', '~> 2.0'
 
 # ------------------------------------------------------------------------------

data/lib/starter_web/_config.yml

@@ -53,7 +53,7 @@ environment:                            production
 # ------------------------------------------------------------------------------
 #   Sets the build version of J1 Template Gem
 #
-version:                                2021.0.16
+version:                                2021.1.0
 
 # version
 # ------------------------------------------------------------------------------
@@ -312,10 +312,9 @@ permalink:                              pretty
 # domain http|s://your-site.domain here. Accessible in Liquid as
 # "site.url". For the development environment there is an EXCEPTION:
 # if you are running jekyll serve in a development environment,
-# site.url will be set to the value of host, port. This defaults to
-# url: http://localhost:4000.
+# site.url will be set to the value of host, port.
 #
-url:                                    "http://localhost:44440/"
+url:                                    ""
 
 # The subpath of your site, e.g. /blog/. Used in conjunction with
 # site.url (see above) when you want a link to something with the
@@ -323,12 +322,6 @@ url:                                    "http://localhost:44440/"
 #
 baseurl:                                ""
 
-# TODO: Following parameters should moved to header or panel that uses
-# these values (production_url, download_url, base_path)
-#
-#production_url:                        http://jekyll.one
-#download_url:                          http://jekyll.one/downloads
-
 # The production_url is only used when full-domain names are needed
 # such as sitemap.txt. For most places will/should use base_path to
 # make the URLs.
@@ -336,14 +329,12 @@ baseurl:                                ""
 base_path:                              ""
 
 # ------------------------------------------------------------------------------
-# TODO: Following parameters should moved to the components that uses
-# these values (protocol, host, port)
 # Base hostname and protocol for the site
 #
 #  Defaults:
 #   protocol:                           http
 #   host:                               localhost
-#   port:                               4000
+#   port:                               40000
 #   timezone:                           Europe/Berlin
 #   encoding:                           UTF-8
 #
@@ -440,10 +431,10 @@ liquid:
 # PLUGIN configuration
 #
 plugins:
+# - algolia
   - asciidoctor
 # - asciidoctor-pdf
   - jekyll-asciidoc
-# - jekyll-algolia
 # - jekyll-feed
 # - jekyll-gist
 # - jekyll-redirect-from
@@ -484,6 +475,7 @@ asciidoc_attributes:                    &asciidoc_attributes
   icons:                                font
   imagesdir:                            /assets/images
   iconsdir:                             '{imagesdir}/icons/asciidoc'
+# experimental:                         true                                    # enable the UI macros, e.g kbd:[], for Asciidoctor globally
 
 asciidoc:
   processor:                            asciidoctor
@@ -525,39 +517,6 @@ whitelist:
 #
 excerpt_separator:                      excerpt__end
 
-# ------------------------------------------------------------------------------
-# PAGINATION settings (Jekyll Paginate V2)
-#
-pagination:
-  enabled:                              true
-  permalink:                            /page:num/
-  per_page:                             4
-  limit:                                0
-  sort_field:                           date
-  sort_reverse:                         true
-  trail:
-    before:                             2
-    after:                              2
-
-# AUTOPAGE settings
-#
-autopages:
-  enabled:                              false
-
-  tags:
-    enabled:                            false
-    layouts:                            [
-                                          paginator/autopage_collections_tags.html,
-                                          paginator/autopage_tags.html
-                                        ]
-  categories:
-    enabled:                            false
-    layouts:                            [ paginator/autopage_category.html ]
-
-  collections:
-    enabled:                            false
-    layouts:                            [ paginator/autopage_collection.html ]
-
 # ------------------------------------------------------------------------------
 # COLLECTION settings
 # See: https://jekyllrb.com/docs/collections/#collections

data/lib/starter_web/_data/_defaults/j1_config.yml

@@ -0,0 +1,460 @@
+# ------------------------------------------------------------------------------
+# ~/_data/j1_config.yml
+# J1 Template settings
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# For details, see https://jekyll.one
+# ------------------------------------------------------------------------------
+
+# ==============================================================================
+# THEME configuration
+#
+# ------------------------------------------------------------------------------
+#   Sets the default theme used for J1 Template for default
+#
+#   Note: Themes from Bootswatch cannot used currently as default theme
+#
+# ------------------------------------------------------------------------------
+#   theme.name
+#
+#   values                              Uno light|Uno dark
+#   default:                            Uno light
+# ------------------------------------------------------------------------------
+#   theme.author
+#
+#   values                              <string>
+#   default:                            J1 Team
+# ------------------------------------------------------------------------------
+#   theme.url
+#
+#   values                              <url>
+#   default:                            https://jekyll.one/
+# ------------------------------------------------------------------------------
+theme:
+  name:                                 Uno light
+  author:                               J1 Team
+  author_url:                           https://jekyll.one/
+
+# ------------------------------------------------------------------------------
+# CSS and SASS settings
+#
+css:
+  custom_scss:                          false
+  custom_css:                           false
+
+# ------------------------------------------------------------------------------
+# Typography settings
+#
+typography:
+  rtext:                                true
+  rtext_size:                           300
+
+# ==============================================================================
+# URL configuration
+#
+# ------------------------------------------------------------------------------
+#
+# All links will be name-spaced by base_path if defined.
+# Links in your website should always be prefixed with {{base_path}}
+# however this value will be dynamically changed depending on your
+# deployment situation.
+#
+# CNAME (http://yourcustomdomain.com)
+#   DO NOT SET base_path
+#   (url's will be prefixed with "/" and work relatively)
+#
+# GitHub Pages (http://username.github.io)
+#   DO NOT SET base_path
+#   (url's will be prefixed with "/" and work relatively)
+#
+# GitHub Project Pages (http://username.github.io/project-name)
+#
+#   A GitHub Project site exists in the `gh-pages` branch of one of
+#   your repositories.
+#  REQUIRED! Set base_path to: http://username.github.io/project-name
+#
+# CAUTION:
+#   - When in localhost, your site will run from root "/" regardless
+#     of base_path
+#   - Only the following values are falsy: ["", null, false]
+#   - When setting base_path it must be a valid url.
+#     This means always setting the protocol (http|https) or
+#     prefixing with "/"
+#
+#base_path:
+
+# By default, the asset_path is automatically defined relative to
+# base_path plus the enabled theme, e.g
+#
+#     [base_path]/assets/themes/[THEME-NAME]
+#
+#     e.g. /assets/themes/bootstrap
+#
+# Override this by defining an absolute path to assets here.
+# ex:
+#   http://s3.amazonaws.com/yoursite/themes/watermelon/assets
+#
+asset_path:                             /assets/themes/j1
+app_path:                               /assets/apps
+image_path:                             /assets/images
+
+# These paths are to the main pages J1 ships with.
+# Some template helpers refer to these paths
+#
+#pages_path:                            /builder/pages
+archive_path:                           /builder/posts/timeline
+categories_path:                        /builder/categories
+tags_path:                              /builder/tags
+#atom_path:                             /atom.xml
+#rss_path:                              /rss.xml
+
+# ------------------------------------------------------------------------------
+# Common site URLs
+#
+about-site-url:                         /pages/public/about/site/
+user_info_url:                          /pages/public/legal/en/privacy/
+theme_author_url:                       https://jekyll.one
+
+
+# ==============================================================================
+# DATA path configuration settings
+#
+# ------------------------------------------------------------------------------
+runtime_data_path:                      /assets/data/runtime-data.yml
+message_catalog_data_path:              /assets/data/messages.yml
+colors_data_path:                       /assets/data/colors.json
+font_size_data_path:                    /assets/data/font_sizes.json
+country_data_path:                      /assets/data/countries.json
+
+
+# ==============================================================================
+# COOKIE configuration settings
+#
+# ------------------------------------------------------------------------------
+cookies:
+  app_session:                          j1.app.session
+  user_session:                         j1.user.session
+  user_state:                           j1.user.state
+
+
+# ==============================================================================
+# PAGE configuration settings
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+#   flicker_timeout (2019-08-06: currently NOT used anymore)
+#   ----------------------------------------------------------------------------
+#   Number of milliseconds (ms) the current page is hidden (display: none)
+#   to prevent "DOM flicker" (aka "FOUC": Flash of unstyled content)
+#
+#   prettify
+#   ----------------------------------------------------------------------------
+#   If set to true, all generated HTML pages (by Liquid|Jekyll) get
+#   formatted "pretty" by layout "default".
+#
+#   NOTE: Used for developent mode ONLY
+#   NOTE: See ~/packages/300_template_src/_layouts/default.html
+# ------------------------------------------------------------------------------
+flicker_timeout:                        250
+
+# ------------------------------------------------------------------------------
+# HTML PrettyPrint
+#
+prettify:                               true
+
+
+# ==============================================================================
+# USER configuration settings
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# Default
+#
+user:
+  provider:                             j1
+  provider_site_url:                    https://jekyll.one
+  provider_home_url:                    https://jekyll.one
+  provider_blog_url:                    /pages/public/blog/navigator/
+  provider_member_url:                  /pages/public/learn/whats_up/
+  provider_privacy_url:                 /pages/public/legal/en/privacy/
+  user_name:                            guest
+  status:                               active
+  provider_membership:                  guest
+  provider_permissions:                 [ 'public' ]
+
+
+# ==============================================================================
+# FRAMEWORK configuration settings
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# cards.card-deck (responsive card decks)
+#
+#   Bootstrap card decks are NOT responsive by default. Additional breakpoint
+#   classes for J1 Template introduce support on card decks for responsiveness.
+#   With the values for `break_on_XX`, the number of cards can be specified
+#   to be shown on a deck per *row*.
+#
+#   default:                          no defaults
+#   values:                           integer (num of cards)
+#
+# ------------------------------------------------------------------------------
+# ------------------------------------------------------------------------------
+# popovers.trigger (tooltips.trigger)
+#
+#   How a popover is triggered. You may pass multiple triggers.
+#   Separate them with a space. Trigger `manual` cannot be combined
+#   with any other trigger. 'manual' indicates that the popover will
+#   be triggered programmatically via the .popover('show'), .popover('hide')
+#   and .popover('toggle') methods.
+#
+#   default:                          hover
+#   values:                           click | hover | focus | manual
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# BOOTSTRAP framework settings
+#
+bootstrap:
+  default_theme:                        bootstrap
+
+  cards:
+     card_deck:
+      break_on_sm:                      1
+      break_on_md:                      2
+      break_on_lg:                      3
+      break_on_xl:                      3
+
+
+  tooltips:
+    enabled:                            true
+    trigger:                            hover
+
+  popovers:
+    enabled:                            true
+    trigger:                            hover
+
+# ------------------------------------------------------------------------------
+# HIGHLIGHTER settings
+#
+rouge:
+  theme_light:                          igorpro
+
+  # may github, pastie
+  theme_dark:                           monokai.sublime
+
+# ------------------------------------------------------------------------------
+# SEO settings (optimization)
+#
+
+# ------------------------------------------------------------------------------
+# PRELOAD settings
+# ------------------------------------------------------------------------------
+# NOTE:
+#   Specify resources that your page will need very soon, which you want
+#   to start loading early in the page lifecycle, before browsers' main
+#   rendering machinery starts. This may improve the performace for the RENDER
+#   phase to improve the FCP (First Contentful Paint). FCP marks the time
+#   at which the first text or image is shown to the user.
+# ------------------------------------------------------------------------------
+# NOTE:
+#   Preloading fonts,the crossorigin attribute is needed to handle
+#   CORS issues.
+# ------------------------------------------------------------------------------
+# NOTE:
+#   Preloading applies ONLY if the requested resource is NOT cached (304).
+#   If a resource is already cached (by the browser OR the web server), some
+#   browser (e.g. Chrome) issue WARNINGS, but can be ignored.
+# ------------------------------------------------------------------------------
+# INFO:
+#   https://stackoverflow.com/questions/1330825/preloading-font-face-fonts
+#   https://developer.mozilla.org/en-US/docs/Web/HTML/Preloading_content
+#   https://github.com/GoogleChromeLabs/critters/issues/18 (crossorigin)
+# ------------------------------------------------------------------------------
+# font:
+#   preload:                              true
+#   cors:                                 crossorigin
+#   fonts:                                [
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Thin.woff,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Thin.woff2,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Light.woff,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Light.woff2,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Regular.woff,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Regular.woff2,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Medium.woff,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Medium.woff2,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Bold.woff,
+#                                           /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Bold.woff2,
+#                                           /assets/themes/j1/core/fonts/material_design_icons/fonts/materialdesignicons-webfont.woff,
+#                                           /assets/themes/j1/core/fonts/material_design_icons/fonts/materialdesignicons-webfont.woff2
+#                                         ]
+preload:
+
+  font:
+    preload:                              false
+    cors:                                 crossorigin
+    fonts:                                []
+    # fonts:                              [
+    #                                         /assets/themes/j1/core/fonts/roboto/fonts/Roboto-Regular.woff,
+    #                                         /assets/themes/j1/core/fonts/material_design_icons/fonts/materialdesignicons-webfont.woff
+    #                                     ]
+  css:
+    preload:                              true
+    css:                                  [
+                                            /assets/themes/j1/core/css/themes/uno-light/bootstrap,
+                                            /assets/themes/j1/core/css/vendor
+                                          ]
+    files:                                []
+
+  js:
+    preload:                              true
+    js:                                   [
+                                            /assets/themes/j1/modules/bmd/js/bootstrap-material-design,
+                                            /assets/themes/j1/modules/backstretch/js/backstretch,
+                                            /assets/themes/j1/core/js/template
+                                          ]
+    files:                                [
+                                            /assets/themes/j1/adapter/js/attic.js,
+                                            /assets/themes/j1/adapter/js/logger.js,
+                                            /assets/themes/j1/adapter/js/bmd.js,
+                                            /assets/themes/j1/adapter/js/navigator.js
+                                          ]
+  image:
+    preload:                              false
+    files:                                [ /assets/images/modules/icons/j1/j1-512x512.png ]
+
+# ------------------------------------------------------------------------------
+# PRECONNECT settings
+# ------------------------------------------------------------------------------
+# NOTE:
+#   Improve page load speed with preconnect|dns-prefetch for 3rd party
+#   origins. Establishing connections often involves significant time in
+#   slow networks (e.g. mobile 2|3G), particularly when it comes to secure
+#   connections (HTTPS), as it may involve DNS lookups, redirects, and
+#   several round trips to the final server that handles the user's request.
+# ------------------------------------------------------------------------------
+preconnect:
+  enabled:                              true
+  urls:                                 [ "https://bootswatch.com" ]
+
+
+# ------------------------------------------------------------------------------
+# Font AweSome settings
+#
+fa:
+  color:                                default
+
+# ------------------------------------------------------------------------------
+# Body style settings
+#
+body:
+  scrollbar:                            false
+  background-color:                     md_gray_50
+  font-color:                           md_gray_900
+  font-size:                            1em
+  font-weight:                          400
+  line-height:                          1.5
+
+
+# ==============================================================================
+# CONNECTOR configuration settings
+#
+# ------------------------------------------------------------------------------
+
+# ------------------------------------------------------------------------------
+# COMMENTS settings
+#
+# Set 'enabled' to false to turn commenting off globally
+# Set 'provider' to the comment provider you want to use
+# ------------------------------------------------------------------------------
+# disqus
+#
+#   short_name: your-disqus-short-name (w/o disqus.com)
+#
+# ------------------------------------------------------------------------------
+comments:
+  enabled:                              true
+  provider:                             disqus
+
+  disqus:
+    short_name:                         jekyll-one
+
+# facebook:
+#   appid:                              123
+#   num_posts:                          5
+#   width:                              580
+#   colorscheme:                        light
+
+# custom:
+#   custom_data:
+
+# ------------------------------------------------------------------------------
+# ANALYTICS settings
+#
+# Set 'enabled' to false to turn analytics off globally
+# Set 'provider' to the analytics provider you want to use
+#
+analytics:
+  enabled:                              false
+  provider:                             google
+  google:
+    tracking_id:                        'UA-138160879-1'
+  custom:
+    custom_data:
+
+# ------------------------------------------------------------------------------
+# ADVERTISING settings
+#
+# Set 'enabled' to false to turn advertising off globally
+# Set 'provider' to the analytics provider you want to use
+#
+advertising:
+  enabled:                              true
+  provider:                             custom
+  google:
+    publisher_id:                       ca-pub-6537273267695855
+  custom:
+    custom_data:
+
+# ------------------------------------------------------------------------------
+# TRANSLATOR settings
+#
+# Set 'enabled' to false to turn translators off globally
+# Set 'provider' to the translation provider you want to use
+#
+translation:
+  enabled:                              false
+  provider:                             google
+
+  google:
+    layout:                             default
+    meta_data:                          [google-translate-customization]
+    page_language:                      en
+    translation_languages:              [all]
+
+# ------------------------------------------------------------------------------
+# SHARING settings (currently NOT supported)
+#
+# Settings for sharing helper. Sharing is for things like tweet, plusone,
+# like, reddit buttons etc. Set 'provider' to the sharing provider you
+# want to use. Set 'provider' to false to turn sharing off globally.
+#
+# Set 'enabled' to false to turn sharing off globally
+# Set 'provider' to the sharing provider you want to use
+#
+# sharing:
+#   enabled:                            false
+#   provider:
+
+
+# ------------------------------------------------------------------------------
+# END config