j1-template 2021.0.12 → 2021.1.0

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

@@ -15,30 +15,9 @@
 # About this configuration (used for J1 CC only)
 #
 about_config:
-  title:                                J1 LunrSearch
+  title:                                J1 QuickSearch
   scope:                                Default settings
-  location:                             _data/modules/defaults/lunr_search.yml
-
-# ------------------------------------------------------------------------------
-# J1LunrSearch settings
-#
-#   enabled
-#   ----------------------------------------------------------------------------
-#   Enables|Disables the use of J1 Search Manager
-#
-#   values:                         boolean (true|false)
-#   default:                        false
-#
-# ------------------------------------------------------------------------------
-
-# ------------------------------------------------------------------------------
-# About this configuration (used for J1 CC only)
-#
-about_config:
-
-  title:                                J1LunrSearch
-  scope:                                Default settings
-  location:                             _data/modules/defaults/jekyll_search.yml
+  location:                             _data/modules/defaults/quicksearch.yml
 
 # ------------------------------------------------------------------------------
 # Default settings
@@ -48,6 +27,8 @@ defaults:
   enabled:                              false
   placement:                            navbar
   target:                               _blank
+  rebuild:                              true
+  full_index:                           true
 
   excludes:                             [
                                           /assets/*, /apps/*, /log/* ,
@@ -57,7 +38,7 @@ defaults:
   stopwords:                            /assets/themes/j1/modules/lunrSearch/stopwords/en.txt
   stopwords_locale:                     en
   strip_index_html:                     false
-  strip_categories:                     [ pages, posts, public, featured, wikipedia ]
+  strip_categories:                     [ pages, posts, series, public, featured, wikipedia ]
   min_length:                           3
   date_format:                          mmm dd, yyyy
 

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

@@ -62,16 +62,27 @@ settings:
       enabled:                          true
       id:                               open_toc
       icon:                             plus
-      icon_hover:                       wrap
+      icon_hover:                       cursor-pointer
       color:                            md-blue
 
       # ------------------------------------------------------------------------
       # MENU items
       #
       items:
-        - item:
+        - item:                         To Top
+          enabled:                      true
+          id:                           fam_scroll_to_top
+          color:                        md-green
+          event_handler:                scroll_to_top
+          icon:                         step-backward-2
+          icon_properties:              rotate-90
+
+        - item:                         Table of Contents
           enabled:                      true
+          id:                           open_mmenu_toc
+          color:                        md-blue
           event_handler:                open_mmenu_toc
+          icon:                         wrap
 
     # --------------------------------------------------------------------------
     # FAM for in-page navigation (simplified)

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

@@ -26,6 +26,8 @@ about_config:
 #
 settings:
 
+  tz_offset:                            GMT+01:00
+
   # ============================================================================
   # APPENDER configurations
   #
@@ -33,98 +35,24 @@ settings:
 
     # --------------------------------------------------------------------------
     # CONSOLE appender
-    - name:                           Console Appender
+    - name:                             Console Appender
       appender:
-        name:                         consoleAppender
-        enabled:                      true
-        type:                         BrowserConsoleAppender
-        layout:                       PatternLayout
-        custom_fields:                [ file, line, path ]
-        pattern_string:               '[%d{HH:mm:ss.SSS}] [%f{4}] [%-5p] [%-40c] [%f{1}:%f{2}] %m%n[%f{3}]'
+        name:                           consoleAppender
+        enabled:                        true
 
     # --------------------------------------------------------------------------
     # AJAX appender
-    - name:                           Ajax Appender
+    - name:                             Ajax Appender
       appender:
-        name:                         ajaxAppender
-        enabled:                      false
-        type:                         BrowserAjaxAppender
-        layout:                       JsonLayout
-        custom_fields:                [ file, line, path ]
-
-        payload_url_app:              http://localhost:5000/log2disk?request=write
-        payload_url_web:              http://localhost:44444/log2disk?request=write
-
-        log_folder:                   log
-        log_file_name:                messages
-        log_file_ext:                 log
-
-        create_on_start:              true
-        reset_on_start:               true
-        rolling_files:                false
-        file_mode:                    append
+        name:                           ajaxAppender
+        enabled:                        false                                   # if enabled, make sure that the util_srv (util_srv.yml) is enabled as well
 
     # --------------------------------------------------------------------------
     # POPUP appender
-    - name:                           Popup Appender
+    - name:                             Popup Appender
       appender:
-        name:                         popupAppender
-        enabled:                      false
-        type:                         PopUpAppender
-        width:                        600
-        height:                       400
-        lazyInit:                     false
-        initiallyMinimized:           false
-        layout:                       PatternLayout
-        custom_fields:                []
-        pattern_string:               '[%d{HH:mm:ss}] [ %-5p] - [%m{1}]%n'
-
-
-  # ============================================================================
-  # LOGGER configurations
-  #
-  loggers:
-
-    # --------------------------------------------------------------------------
-    # J1 PARENT logger (j1)
-    - name:                           Parent Logger
-      logger:
-        type:                         parent
-        name:                         j1
-        appender:                     [ consoleAppender, ajaxAppender ]
-        level:
-          production:                 warn
-          development:                debug
-
-    # --------------------------------------------------------------------------
-    # ADAPTER CHILD logger (j1.adapter)
-    # - log:
-    #     type:                         child
-    #     name:                         adapter
-    #     appender:                     [ consoleAppender ]
-    #     level:
-    #       production:                 warn
-    #       development:                debug
-
-    # --------------------------------------------------------------------------
-    # LOADER CHILD logger (j1.loader)
-    # - log:
-    #     type:                         child
-    #     name:                         loader
-    #     appender:                     [ consoleAppender ]
-    #     level:
-    #       production:                 warn
-    #       development:                debug
-
-    # --------------------------------------------------------------------------
-    # MODULE CHILD logger (j1.module)
-    # - log:
-    #     type:                         child
-    #     name:                         module
-    #     appender:                     [ consoleAppender ]
-    #     level:
-    #       production:                 warn
-    #       development:                debug
+        name:                           popupAppender
+        enabled:                        false
 
 # ------------------------------------------------------------------------------
 # END config

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

@@ -1,5 +1,5 @@
 # ------------------------------------------------------------------------------
-# ~/_data/modules/j1_navigator_menu.yml
+# ~/_data/modules/j1_navigator_menu.yml (run-time)
 # Configuration of the J1 NAV Module for the main navigation bar
 #
 # Product/Info:
@@ -102,6 +102,22 @@
     - title:                            Sites
       icon:                             #web
       column:
+        - title:                        Jekyll Home
+          href:                         https://jekyllrb.com/
+          target:                       _blank
+          icon:                         flask
+        - title:                        Ruby
+          href:                         https://www.ruby-lang.org/en/
+          target:                       _blank
+          icon:                         language-ruby
+        - title:                        RubyGems
+          href:                         https://rubygems.org/gems/j1-template/
+          target:                       _blank
+          icon:                         language-ruby
+        - title:                        NpmJS
+          href:                         https://www.npmjs.com/
+          target:                       _blank
+          icon:                         language-javascript
         - title:                        Bootstrap Home
           href:                         http://getbootstrap.com/
           target:                       _blank
@@ -116,7 +132,6 @@
           icon:                         font-awesome
         - title:                        MD Icons
           href:                         https://materialdesignicons.com/
-#         href:                         http://zavoloklom.github.io/material-design-iconic-font/cheatsheet.html
           target:                       _blank
           icon:                         google
         - title:                        Fonts
@@ -131,12 +146,12 @@
     - title:                            Knowledge
       icon:                             #lightbulb-on
       column:
-        - title:                        Jekyll Home
-          href:                         https://jekyllrb.com/
+        - title:                        Learn Jekyll at CloudCannon
+          href:                         http://jekyll.tips/
           target:                       _blank
           icon:                         flask
-        - title:                        Jekyll Tips
-          href:                         http://jekyll.tips/
+        - title:                        Jekyll Cheat Sheet
+          href:                         https://learn.cloudcannon.com/jekyll-cheat-sheet/
           target:                       _blank
           icon:                         flask
         - title:                        Jekyll Stackoverflow
@@ -154,7 +169,11 @@
         - title:                        SelfHTML
           href:                         https://wiki.selfhtml.org/
           target:                       _blank
-          icon:                         xml
+          icon:                         language-html5
+        - title:                        LearnCSS
+          href:                         https://developer.mozilla.org/en-US/docs/Learn/CSS
+          target:                       _blank
+          icon:                         language-css3
         - title:                        Asciidoc Language
           href:                         https://docs.asciidoctor.org/asciidoc/latest/
           target:                       _blank

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

@@ -1,5 +1,5 @@
 # ------------------------------------------------------------------------------
-#  ~/_data/modules/lunr_search.yml
+#  ~/_data/modules/quicksearch.yml
 #  User configuration settings for J1 QuickSearch module
 #
 #  Product/Info:
@@ -16,9 +16,9 @@
 #
 about_config:
 
-  title:                                J1 LunrSearch
+  title:                                J1 QuickSearch
   scope:                                User settings
-  location:                             _data/modules/lunr_search.yml
+  location:                             _data/modules/quicksearch.yml
 
 # ------------------------------------------------------------------------------
 # User configuration settings
@@ -28,6 +28,8 @@ settings:
   enabled:                              true
   placement:                            navbar
   target:                               _blank
+  rebuild:                              false
+  full_index:                           false
 
   stopwords_locale:                     en
   min_length:                           3

data/lib/starter_web/_data/plugins/defaults/paginator.yml

@@ -30,7 +30,7 @@ about_config:
 #   values:                             true|false (boolean)
 #   default:                            false
 #
-enabled:                                false
+#enabled:                                false
 
 # ------------------------------------------------------------------------------
 # User configuration settings
@@ -42,22 +42,25 @@ settings:
   #
   # enabled
   # ----------------------------------------------------------------------------
-  #   Enables|Disables the use of a gallery
+  #   Enables|Disables the use of a pagination
   #
-  # notebook_path
+  # title
   # ----------------------------------------------------------------------------
-  #   All data items displayed by a gallery are being read from a
-  #   JSON file automatically generated from that configuration.
+  #   Customizable (pagination) page title
   #
   #   values:                           string
-  #   default:                          /assets/data/jupyther/notebooks
-  #  
+  #   default:                          :title - page :num
+  #
 
   # ----------------------------------------------------------------------------
   # PAGINATION settings
   #
   pagination:
     enabled:                            false
+
+    title:                              :title
+    rebuild:                            true                                    # currently NOT used
+
     permalink:                          /page:num/
     per_page:                           4
     limit:                              0
@@ -71,12 +74,13 @@ settings:
   #
   autopages:
     enabled:                            false
+    rebuild:                            true                                    # currently NOT used
 
     tags:
       enabled:                          false
-      layouts:                          [ 
-                                          paginator/autopage_collections_tags.html, 
-                                          paginator/autopage_tags.html 
+      layouts:                          [
+                                          paginator/autopage_collections_tags.html,
+                                          paginator/autopage_tags.html
                                         ]
 
     categories:
@@ -87,6 +91,5 @@ settings:
       enabled:                          false
       layouts:                          [ paginator/autopage_collection.html ]
 
-
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/plugins/paginator.yml

@@ -30,23 +30,25 @@ about_config:
 #   values:                             true|false (boolean)
 #   default:                            false
 #
-enabled:                                true
+#enabled:                                true
 
 # ------------------------------------------------------------------------------
 # User configuration settings
 #
 settings:
 
-  # ------------------------------------------------------------------------------
+  # ----------------------------------------------------------------------------
   # PAGINATION settings
   #
   pagination:
     enabled:                            true
+    rebuild:                            false                                   # currently NOT used
 
   # AUTOPAGE settings
   #
   autopages:
     enabled:                            false
+    rebuild:                            false                                   # currently NOT used
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/private.yml

@@ -1,28 +1,29 @@
 # ------------------------------------------------------------------------------
 # ~/_data/private.yml
-# The private.yml file is used to set private data used by several J1 apps
-# and modules to configure e.g. security and/or authentication settings.
+# The private.yml file is used to set sensitive private data used by
+# J1 components to configure security and authentication settings
 #
 # Product/Info:
 # https://jekyll.one
 #
-# Copyright (C) 2021 Juergen Adams
+# Copyright (C) 2019 Juergen Adams
 #
 # J1 Template is licensed under the MIT License.
 # See: https://github.com/jekyll-one-org/j1_template/blob/master/LICENSE
 # ------------------------------------------------------------------------------
 # NOTE:
-#   As this file contains highly confidential data, never publish this
-#   file to the public. A productive private.yml file should ALWAYS be
-#   excluded from ANY source published to the public (e.g. a repo at Github).
+#   As this file contains very confidential data, a productive private.yml
+#   file should ALWAYS be excluded from ANY source published to the public
+#   (e.g. a repo at Github)
 # ------------------------------------------------------------------------------
 
+
 # ==============================================================================
 # GLOBAL settings
 # ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 global:
 
-  # used by J1 e.g. to encrypt cookies
+  # used by J1 to encrypt cookies
   session_secret:                       <your-secret-string>
 
 
@@ -42,8 +43,8 @@ modules:
       repo:                             <your-gh-repo>
       server_url:                       <your-gh-webhook-url>
 
-    secret:                             <your-gh-secret>
-    payload_url:                        <your-payload-url>
+    secret:                             <your-gh-secret>                        # secret used at GH Webhooks
+    payload_url:                        <your-payload-url>                      # payload url (e.g channel at smee.io)
 
 
 # ==============================================================================
@@ -54,7 +55,7 @@ util_srv:
   oauth:
 
     # GH OAuth settings used for J1 Control Center (NetlifyCMS) for the
-    # external OAuth client
+    # external OAuth client (base_url)
     # --------------------------------------------------------------------------
     comment:
       name:                           <your-config-name>
@@ -63,8 +64,8 @@ util_srv:
       strategy:                       members
       members:                        all
 
-    site_url:                         http://localhost:44444
-    site_redirect_url:                http://localhost:44444/auth/github/callback
+    site_url:                         http://localhost:40010
+    site_redirect_url:                http://localhost:40010/auth/github/callback
     client_scope:                     repo, user
     client_id:                        <your-client-id>
     client_secret:                    <your-client-secret>
@@ -79,69 +80,40 @@ middleware:
   # ----------------------------------------------------------------------------
   oauth:
 
-    # DISQUS credentials
     # --------------------------------------------------------------------------
+    # DISQUS credentials
+    # ==========================================================================
     disqus:
 
-      # J1 Auth client (mode WEB, development system)
-      # ------------------------------------------------------------------------
-      comment:
-        name:                           <your-config-name>
-        user:                           <your-gh-user>
-        org:                            <your-gh-organisation>
-        strategy:                       members
-        members:                        all
-
-      client_url:                       http://localhost:5000
-      client_redirect_url:              http://localhost:5000/auth/disqus/callback
-      client_id:                        <your-client-id>
-      client_secret:                    <your-client-secret>
-
       # J1 Auth client (mode APP, development system)
       # ------------------------------------------------------------------------
       comment:
-        name:                           <your-config-name>
-        user:                           <your-gh-user>
-        org:                            <your-gh-organisation>
-        strategy:                       members
-        members:                        all
+        name:                           <your-disqus-config-name>
+        user:                           <your-disqus-user>
 
-      client_url:                       http://localhost:5000
-      client_redirect_url:              http://localhost:5000/auth/disqus/callback
-      client_id:                        <your-client-id>
-      client_secret:                    <your-client-secret>
+      client_url:                       http://localhost:40010
+      client_redirect_url:              http://localhost:40010/auth/disqus/callback
+      client_id:                        <your-disqus-client-id>
+      client_secret:                    <your-disqus-client-secret>
 
-    # GITHUB credentials
     # --------------------------------------------------------------------------
+    # GITHUB credentials
+    # ==========================================================================
     github:
 
-      # J1 Auth client (mode WEB, development system)
-      # ------------------------------------------------------------------------
-      comment:
-        name:                           <your-config-name>
-        user:                           <your-gh-user>
-        org:                            <your-gh-organisation>
-        strategy:                       members
-        members:                        all
-
-      client_url:                       http://localhost:5000
-      client_redirect_url:              http://localhost:5000/auth/github/callback
-      client_id:                        <your-client-id>
-      client_secret:                    <your-client-secret>
-
       # J1 Auth client (mode APP, development system)
       # ------------------------------------------------------------------------
       comment:
-        name:                           <your-config-name>
+        name:                           <your-gh-config-name>
         user:                           <your-gh-user>
-        org:                            <your-gh-organisation>
+        org:                            <your-gh-org>
         strategy:                       members
         members:                        all
 
-      client_url:                       http://localhost:5000
-      client_redirect_url:              http://localhost:5000/auth/github/callback
-      client_id:                        <your-client-id>
-      client_secret:                    <your-client-secret>
+      client_url:                       http://localhost:40010
+      client_redirect_url:              http://localhost:40010/auth/github/callback
+      client_id:                        <your-gh-client-id>
+      client_secret:                    <your-gh-client-secret>
 
 # ------------------------------------------------------------------------------
 # END