j1-template 2021.0.16 → 2021.1.0

data/lib/starter_web/_data/private@localhost.yml

@@ -0,0 +1,156 @@
+# ------------------------------------------------------------------------------
+# ~/_data/private.yml
+# 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) 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 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 to encrypt cookies
+  session_secret:                       12ada70c0d34914d194f1a790c9b23bd
+
+
+# ==============================================================================
+# MODULE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+modules:
+
+  # J1 Webhook
+  # NOTE:
+  # ----------------------------------------------------------------------------
+  webhook:
+
+    comment:
+      name:                             j1-template@jekyll-one-org
+      user:                             j1juergen
+      repo:                             jekyll-one-org/j1-template
+      server_url:                       https://github.com/jekyll-one-org/j1-template/settings/hooks
+
+    secret:                             12ada70c0d34914d194f1a790c9b23bd        # secret used at GH Webhook
+    payload_url:                        https://smee.io/bzTe8lpQq1KeSJF         # payload url (e.g channel at smee.io)
+
+
+# ==============================================================================
+# # J1 Utility Server
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+util_srv:
+
+  oauth:
+
+    # GH OAuth settings used for J1 Control Center (NetlifyCMS) for the
+    # external OAuth client (base_url)
+    # --------------------------------------------------------------------------
+    comment:
+      name:                           j1-utilitiy-server@local-44444
+      user:                           j1juergen@jekyll-one-org
+      user_url:                       https://github.com/organizations/jekyll-one-org/settings/applications/1129706
+      strategy:                       members
+      members:                        all
+
+    site_url:                         http://localhost:44444
+    site_redirect_url:                http://localhost:44444/auth/github/callback
+    client_scope:                     repo, user
+    client_id:                        1a0d2977414958182711
+    client_secret:                    358b3b44e3711f9b279d4ae7164c9de2e5dafc27
+
+
+# ==============================================================================
+# MIDDLEWARE settings
+# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+middleware:
+
+  # OAuth settings (J1 Auth Client)
+  # ----------------------------------------------------------------------------
+  oauth:
+
+    # --------------------------------------------------------------------------
+    # DISQUS credentials
+    # ==========================================================================
+    disqus:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           starter@localhost
+        user:                           juergen.adams@jekyll-one.com
+        strategy:                       members
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/disqus/callback
+      client_id:                        6JCzzU8t2yr11JLps0IWbslWvJJz1s07Q6W9XUBjzJa3zc6ziRlGCJWssslzoj3i
+      client_secret:                    7e36hTTenfAV2wH2csw8ZXj1HY6QhwzvGbImPLTxvMeX5psQHdXOJWDD37KHJ2rw
+
+    # --------------------------------------------------------------------------
+    # GITHUB credentials
+    # ==========================================================================
+    github:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+      comment:
+        name:                           starter@localhost
+        user:                           jekyll-one
+        org:                            jekyll-one-org
+        strategy:                       members
+        members:                        all
+
+      client_url:                       http://localhost:41010
+      client_redirect_url:              http://localhost:41010/auth/github/callback
+      client_id:                        4759b4d27a5f526c632a
+      client_secret:                    8472988317760fd097d1e80e996f4ec410c1857a
+
+    # --------------------------------------------------------------------------
+    # PATREON credentials
+    # ==========================================================================
+    patreon:
+
+      # J1 Auth client (mode APP, development system)
+      # ------------------------------------------------------------------------
+#     comment:
+#       name:                           j1-starter-local-5k
+#       user:                           juergen@jekyll.one
+#       strategy:                       members
+#       api:                            v1
+#
+#     client_url:                       http://localhost:5000
+#     client_redirect_url:              http://localhost:5000/auth/github/callback
+#     client_id:                        bDuEYHyKjtypxb5wQKMILCCUw-x5XtYD-_9MsDAO22agQGoaB2CRKtP5UReRVflS
+#     client_secret:                    uDRsD1dwWSLPUCeBrjz4umjsNMD04drCtTqy7xSEjkqIVACGa-h-n1w8t9o2mW42
+
+    # --------------------------------------------------------------------------
+    # TWITTER credentials (currently NOT supported)
+    # ==========================================================================
+    twitter:
+
+      # J1 Auth client
+      # ------------------------------------------------------------------------
+#     comment:
+#       name:                           <your-oauth-app-name>
+#       user:                           <your-userid>
+#       strategy:                       <your-strategy>
+#       api:                            v1
+#
+#     client_url:                       <your-client-url>
+#     client_redirect_url:              <your-client-redirect-url>
+#     client_id:                        <your-client-id>
+#     client_secret:                    <your-client-secret>
+
+# ------------------------------------------------------------------------------
+# END

data/lib/starter_web/_data/resources.yml

@@ -77,7 +77,6 @@
 #      ...
 #    ]
 #
-#
 #   NOTE:
 #   The key|value pair for LOCAL should ALWAYS specified, respectively
 #   ALL resources should be available locally at least. This allows to
@@ -393,11 +392,8 @@ resources:
       pass_init_data:                   false
       data:
         css:                            []
-        files:                          [
-                                          modules/util/js/log4javascript.js,
-                                          adapter/js/logger.js
-                                        ]
-        js:                             []
+        files:                          [ adapter/js/logger.js ]
+        js:                             [ modules/log4javascript/js/log4javascript ]
         init_function:                  [ j1.adapter.logger.init ]
 
   # ----------------------------------------------------------------------------
@@ -697,6 +693,27 @@ resources:
 # Apps and Modules loaded ASYCHRONOUSLY (defer)
 # ------------------------------------------------------------------------------
 
+  # ----------------------------------------------------------------------------
+  # HTML modifier for Asciidoctor
+  #
+  - name:                               Asciidoctor
+    resource:
+      id:                               asciidoctor
+      enabled:                          true
+      comment:                          HTML modifier for Asciidoctor
+      region:                           head
+      layout:                           [ page, post, collection ]
+      required:                         always
+      preload:                          false                                   # property currently unused
+      script_load:                      defer
+      dependencies:                     false
+      pass_init_data:                   false
+      data:
+        css:                            []
+        files:                          [ adapter/js/asciidoctor.js ]
+        js:                             []
+        init_function:                  [ j1.adapter.asciidoctor.init ]
+
   # ----------------------------------------------------------------------------
   # Rouge, pure Ruby themeable code highlighter
   # https://github.com/rouge-ruby/rouge
@@ -748,9 +765,9 @@ resources:
   #
   - name:                               J1 Gallery Customizer
     resource:
-      id:                               gallery_customizer
+      id:                               justifiedGalleryCustomizer
       enabled:                          true
-      comment:                          Gallery Customizer
+      comment:                          Justified Gallery Customizer
       layout:                           [ app, raw ]
       region:                           head
       required:                         ondemand
@@ -760,9 +777,9 @@ resources:
       pass_init_data:                   true
       data:
         css:                            []
-        files:                          [ adapter/js/gallery_customizer.js ]
+        files:                          [ adapter/js/justifiedGalleryCustomizer.js ]
         js:                             []
-        init_function:                  [ j1.adapter.gallery_customizer.init ]
+        init_function:                  [ j1.adapter.justifiedGalleryCustomizer.init ]
 
   # ----------------------------------------------------------------------------
   # iFrameResizer, creates dynamic, configurable, client|server
@@ -973,9 +990,9 @@ resources:
   #
   - name:                               Justified Gallery
     resource:
-      id:                               justified_gallery
+      id:                               justifiedGallery
       enabled:                          true
-      comment:                          module justified gallery
+      comment:                          module justifiedGallery
       region:                           head
       layout:                           [ home, page, post, collection, raw, app ]
       required:                         ondemand
@@ -988,18 +1005,18 @@ resources:
                                           modules/justifiedGallery/css/justifiedGallery,
                                           modules/justifiedGallery/css/theme/uno
                                         ]
-        files:                          [ adapter/js/jf_gallery.js ]
+        files:                          [ adapter/js/justifiedGallery.js ]
         js:                             [ modules/justifiedGallery/js/justifiedGallery ]
-        init_function:                  [ j1.adapter.jf_gallery.init ]
+        init_function:                  [ j1.adapter.justifiedGallery.init ]
 
   # ----------------------------------------------------------------------------
   # LightGallery
   #
   - name:                               LightGallery
     resource:
-      id:                               light_gallery
+      id:                               lightGallery
       enabled:                          true
-      comment:                          module lightgallery
+      comment:                          module lightGallery
       region:                           head
       layout:                           [ home, page, post, collection, raw, app ]
       required:                         ondemand

data/lib/starter_web/_data/utilities/defaults/util_srv.yml

@@ -23,11 +23,11 @@ about_config:
   location:                             _data/utilities/defaults/util_srv.yml
 
 # ------------------------------------------------------------------------------
-# Default configuration settings
+# DEFAULT configuration settings
 #
 defaults:
-  enabled:                              false
 
+  enabled:                              false
   private_data:                         _data/private.yml
 
   ssl:                                  false
@@ -36,6 +36,52 @@ defaults:
   port:                                 44444
   verbose:                              false
 
+  logger_client:
+    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
+
+  oauth_client:
+    enabled:                            false
+    provider:                           github
+    provider_url:                       https://github.com                      # PROVIDER_URL needed for enterprise github installs
+    token_path:                         /login/oauth/access_token
+    authorize_path:                     /login/oauth/authorize
+
+  git_client:
+    enabled:                            false
+    secret:                             12ada70c0d34914d194f1a790c9b23bd
+    payload_url:                        https://smee.io/bzTe8lpQq1KeSJF
+
+    pull:
+      execute:                          false                                   # true|false
+      response_success:                 The pull request to your local working copy finished successfully.
+      response_failed:                  "The pull request to your local working copy has failed. Reason: "
+
+  npm_client:
+    enabled:                            false
+
+    built:
+      execute:                          false                                   # rebuild disabled for testing (as Jekyll is running in parallel)
+      response_success:                 The built request to your local site finished successfully.
+      response_failed:                  "The built request to your local fite has failed. Reason: "
+
+  commit_detection:
+
+    modal_commit_detected:
+      enabled:                          true
+      autohide:                         false
+      autohidden:                       5000
+
+    modal_pull_response:
+      enabled:                          true
+      autohide:                         false
+      autohidden:                       5000
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_data/utilities/util_srv.yml

@@ -24,74 +24,17 @@ about_config:
   location:                             _data/utilities/util_srv.yml
 
 # ------------------------------------------------------------------------------
-# User configuration settings
+# USER configuration settings
 #
 settings:
-  enabled:                              true
 
-  commit_detection:
-
-    modal_commit_detected:
-      enabled:                          true
-      autohide:                         false
-      autohidden:                       5000
-
-    modal_pull_response:
-      enabled:                          true
-      autohide:                         false
-      autohidden:                       5000
-
-  utility_server:
-    enabled:                            true
-
-    ssl:                                false
-    origin:                             localhost
-    host_name:                          0.0.0.0
-    port:                               44444
-    verbose:                            false
-    
-    oauth_client:
-      enabled:                          false
-
-      provider:                         github      
-      provider_url:                     https://github.com                      # PROVIDER_URL needed for enterprise github installs
-      token_path:                       /login/oauth/access_token
-      authorize_path:                   /login/oauth/authorize
-
-    git_client:
-      enabled:                          false
-
-      secret:                           <your-gh-webhook-secret>
-      payload_url:                      <your-payload-url>                      # e.g from smee.io
-
-      pull:
-        execute:                        true                                    # true|false
-        response_success:               The pull request to your local working copy finished successfully.
-        response_failed:                "The pull request to your local working copy has failed. Reason: "
-
-    npm_client:
-      enabled:                          false
-
-      built:                              
-        execute:                        false                                   # rebuild disabled for testing (as Jekyll is running in parallel)
-        response_success:               The built request to your local site finished successfully.
-        response_failed:                "The built request to your local fite has failed. Reason: "
-
-    logger_client:
-      enabled:                          false
-
-      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
+  enabled:                              false                                   # if set to true, util server will be started
 
+  ssl:                                  false
+  origin:                               localhost
+  host_name:                            0.0.0.0
+  port:                                 40020
+  verbose:                              false
 
 # ------------------------------------------------------------------------------
-# END config
+# END config

data/lib/starter_web/_includes/attributes.asciidoc

@@ -148,9 +148,11 @@ tag::urls[]
 :url-iframe-resizer--gh-repo:                     https://github.com/davidjbradshaw/iframe-resizer
 
 :url-j1--home:                                    https://jekyll.one/
-:url-j1--download:                                https://rubygems.org/gems/j1-template/versions/2021.0.16
-:url-j1-rubydoc--home:                            https://www.rubydoc.info/gems/j1-template/2021.0.16
+:url-j1--download:                                https://rubygems.org/gems/j1-template/
+:url-j1--versions:                                https://rubygems.org/gems/j1-template/versions/
+:url-j1-rubydoc--home:                            https://www.rubydoc.info/gems/j1-template/
 :url-j1--preview:                                 https://preview.jekyll.one/
+:url-j1--quickstart:                              https://jekyll.one/pages/public/learn/quickstart/
 
 :url-j1-kickstarter--web-in-a-day:                https://jekyll.one/pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/
 :url-j1-web-in-a-day--meet-and-greet:             https://jekyll.one/pages/public/learn/kickstarter/web_in_a_day/meet_and_greet/
@@ -400,14 +402,15 @@ end::tables[]
 // PRODUCTS, global product information (e.g. release)
 // -----------------------------------------------------------------------------
 tag::products[]
-:j1-license:                                      MIT License
-:j1-version:                                      2021.0.16
+:j1--license:                                     MIT License
+:j1--version:                                     2021.1.0
+:j1--site-name:                                   Jekyll One
 end::products[]
 
 
 // AUTHORS, global author information (special variables)
 // -----------------------------------------------------------------------------
 tag::authors[]
-:author-adams--name:                              "Jürgen Adams"
-:author-adams--url:                               https://jekyll.one
+:author--adams--name:                             "Jürgen Adams"
+:author--adams--url:                              https://jekyll.one
 end::authors[]