j1-template 2021.0.13 → 2021.1.1

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.13'
+gem 'j1-template', '~> 2021.1.1'
 
 # ------------------------------------------------------------------------------
 # 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-sitemap', '>= 1.2.0'
-# gem 'jekyll-redirect-from', '>= 0.16.0'                                       # Needed ???
-# gem 'jekyll-sass-converter', '>= 2.1.0'                                       # Needed ??? Supported ???
-  gem 'j1-paginator', '>= 2020.0.2'
+# 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.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.13
+version:                                2021.1.1
 
 # version
 # ------------------------------------------------------------------------------
@@ -241,9 +241,13 @@ author:
 webmaster:
   email:                                webmaster@example.domain
 
+# crawling/indexing DISABLED for default. Settings managed page-wise using
+# frontmatter defaults or by page settings to make sure that only WANTED
+# pages gets crawled.
+#
 robots:
   index:                                false
-  follow:                               true
+  follow:                               false
 
 # ------------------------------------------------------------------------------
 # BRAND configuration
@@ -251,7 +255,7 @@ robots:
 
 brand:
   image:                                modules/icons/j1/j1-512x512.png
-  image_height:                         48                                      # was: 64
+  image_height:                         48
   text:                                 Starter Web
   text_color:                           "#9E9E9E"
 
@@ -312,10 +316,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:                                    "http://localhost:40000"
 
 # 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 +326,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 +333,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
 #
@@ -365,7 +360,7 @@ show_dir_listing:                       false
 #   source:                             .
 #   destination:                        _site
 #
-source:   .
+source:                                 .
 destination:                            _site
 plugins_dir:                            _plugins
 layouts_dir:                            _layouts
@@ -440,15 +435,15 @@ liquid:
 # PLUGIN configuration
 #
 plugins:
+# - algolia
   - asciidoctor
 # - asciidoctor-pdf
   - jekyll-asciidoc
-# - jekyll-algolia
 # - jekyll-feed
 # - jekyll-gist
-# - jekyll-sitemap
 # - jekyll-redirect-from
 # - jekyll-sass-converter
+# - jekyll-sitemap
   - j1-paginator
 
 # ------------------------------------------------------------------------------
@@ -484,6 +479,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 +521,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
@@ -600,6 +563,24 @@ collections:
 #
 defaults:
 
+  # ----------------------------------------------------------------------------
+  # HTML partials (loaded via XHR) excluded from sitemap
+  #
+  - scope:
+      path:                             assets/data
+
+    values:
+      sitemap:                          false
+
+  # ----------------------------------------------------------------------------
+  # Module HTML docs and examples excluded from sitemap
+  #
+  - scope:
+      path:                             assets/themes/j1
+
+    values:
+      sitemap:                          false
+
   # ----------------------------------------------------------------------------
   # Pages
   #
@@ -610,22 +591,22 @@ defaults:
     values:
       layout:                           page
       author:                           J1 Team
-      toc:                              true
-      fam_menu_id:                      page_ctrl_simple
-      resources:                        toccer
+
+#     robots:
+#       index:                          true
+#       follow:                         true
+
       analytics:                        false
       advertising:                      false
       comments:                         false
-      scrollbar:                        false
-      indexed:                          true
 
-      robots:
-        index:                          true
-        follow:                         true
+      toc:                              true
+      fam_menu_id:                      page_ctrl_simple
+      scrollbar:                        false
 
       icons:
         family:                         MDI
-        color:                          md-indigo
+        color:                          md-blue
         size:                           5x
 
       images:
@@ -633,7 +614,7 @@ defaults:
 
       resource_options:
         - toccer:
-            collapseDepth:              2
+            collapseDepth:              3
 
   # ----------------------------------------------------------------------------
   # Posts
@@ -648,23 +629,26 @@ defaults:
 
     values:
       layout:                           post
-      scrollbar:                        false
       author:                           J1 Team
-      toc:                              true
-      fam_menu_id:                      page_ctrl_simple
-      resources:                        toccer
+
+#     robots:
+#       index:                          true
+#       follow:                         true
+
       analytics:                        false
       advertising:                      false
       comments:                         true
 
-      robots:
-        index:                          true
-        follow:                         true
+      series:                           false
+
+      toc:                              true
+      fam_menu_id:                      page_ctrl_simple
+      scrollbar:                        false
 
       icons:
 #       category-icon:                  comment-text-outline
         family:                         MDI
-        color:                          md-indigo
+        color:                          md-blue
         size:                           5x
 
       images:
@@ -673,7 +657,7 @@ defaults:
 
       resource_options:
         - toccer:
-            collapseDepth:              2
+            collapseDepth:              3
 
   # ----------------------------------------------------------------------------
   # PUBLIC - SERIES
@@ -684,18 +668,21 @@ defaults:
 
     values:
       layout:                           post
-      scrollbar:                        false
       author:                           J1 Team
-      toc:                              true
-      fam_menu_id:                      page_ctrl_simple
-      resources:                        toccer
+
+#     robots:
+#       index:                          true
+#       follow:                         true
+
       analytics:                        false
       advertising:                      false
       comments:                         true
 
-      robots:
-        index:                          true
-        follow:                         true
+      series:                           true
+
+      toc:                              true
+      fam_menu_id:                      page_ctrl_simple
+      scrollbar:                        false
 
       icons:
 #       category-icon:                  dots-horizontal-circle
@@ -716,19 +703,17 @@ defaults:
 
     values:
       layout:                           post
-      scrollbar:                        false
       author:                           Wikipedia
-      resources:                        toccer
-      toc:                              true
-      fam_menu_id:                      page_ctrl_simple
-      resources:                        toccer
+
       analytics:                        false
       advertising:                      false
       comments:                         false
 
-      robots:
-        index:                          false
-        follow:                         false
+      series:                           false
+
+      toc:                              true
+      fam_menu_id:                      page_ctrl_simple
+      scrollbar:                        false
 
       icons:
 #       category-icon:                  wikipedia
@@ -753,37 +738,7 @@ defaults:
 
     values:
       layout:                           page
-
-  # ----------------------------------------------------------------------------
-  # Biography (Book Shelf)
-  #
-  - scope:
-      type:                             biography
-      path:                             collections/_biography
-
-    values:
-      layout:                           page
-
-  # ----------------------------------------------------------------------------
-  # Fantasy (Book Shelf)
-  #
-  - scope:
-      type:                             fantasy
-      path:                             collections/_fantasy
-
-    values:
-      layout:                           page
-
-  # ----------------------------------------------------------------------------
-  # Romance (Book Shelf)
-  #
-  - scope:
-      type:                             romance
-      path:                             collections/_romance
-
-    values:
-      layout:                           page
-
+      sitemap:                          false
 
 # ==============================================================================
 # 6. LAYOUT configuration