j1-template 2021.0.12 → 2021.1.0

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,10 +148,13 @@ 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.12
-:url-j1-rubydoc--home:                            https://www.rubydoc.info/gems/j1-template/2021.0.12
+: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/
 
 :url-j1-quick-references--jekyll:                 /pages/protected/manuals/quick_references/jekyll/
@@ -399,14 +402,15 @@ end::tables[]
 // PRODUCTS, global product information (e.g. release)
 // -----------------------------------------------------------------------------
 tag::products[]
-:j1-license:                                      MIT License
-:j1-version:                                      2021.0.12
+: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[]

data/lib/starter_web/_plugins/asciidoctor-extensions/callout.rb

@@ -1,9 +1,51 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/asciidoctor-extensions/callout-block.rb
+# Asciidoctor extension for callouts as a (HTML-)block
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+include Asciidoctor
+
+# A block macro that embeds a Callout block into the output document
+#
+# Usage
+#
+#   callout::<num>[<text>, <modifier]
+#
+# Example:
+#
+#   callout::1[Web Browser]
+#
 Asciidoctor::Extensions.register do
-  inline_macro do
+
+  class CalloutBlockMacro < Extensions::BlockMacroProcessor
+    use_dsl
     named :callout
-    process do |parent, target, attrs|
-      # TODO validate that this conum is valid
-      Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
+    name_positional_attributes 'text', 'modifier'
+    default_attrs 'text' => 'callout text to be specified', 'modifier' => 'ml-2 mb-1'
+
+    def process parent, target, attrs
+      doc = parent.document
+      modifier_class = (modifier = attrs['modifier']) ? %(#{modifier}) : nil
+      text_content = (text = attrs['text']) ? %(#{text}) : nil
+      html = %(
+        <div class="paragraph">
+        	<p class="#{modifier}"> <i class="conum" data-value="#{target}"></i> #{text} </p>
+        </div>
+      )
+
+      create_pass_block parent, html, attrs, subs: nil
     end
+
   end
-end
+
+  block_macro CalloutBlockMacro
+end

data/lib/starter_web/_plugins/asciidoctor-extensions/conum.rb

@@ -1,3 +1,30 @@
+# ------------------------------------------------------------------------------
+# ~/_plugins/asciidoctor-extensions/conum.rb
+# Asciidoctor extension for conums
+#
+# Product/Info:
+# https://jekyll.one
+#
+# Copyright (C) 2021 Juergen Adams
+#
+# J1 Template is licensed under the MIT License.
+# See: https://github.com/jekyll-one-org/J1 Template/blob/master/LICENSE
+#
+# ------------------------------------------------------------------------------
+require 'asciidoctor/extensions' unless RUBY_ENGINE == 'opal'
+include Asciidoctor
+
+# A inline macro that embeds a conum into the output document
+#
+# Usage
+# ------------------------------------------------------------------------------
+#   conum::<num>[]
+#
+# Example:
+#
+#   conum:1[]
+#
+# ------------------------------------------------------------------------------
 Asciidoctor::Extensions.register do
   inline_macro do
     named :conum
@@ -6,4 +33,4 @@ Asciidoctor::Extensions.register do
       Asciidoctor::Inline.new(parent, :callout, target.to_i).convert
     end
   end
-end
+end

data/lib/starter_web/_plugins/lunr_index.rb

@@ -99,16 +99,33 @@ module Jekyll
       # or with frontmatter settings (exclude_from_search: true)
       #
       def generate(site)
-        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
 
         @site = site
+        index_dest = @site.instance_variable_get(:@dest)
+        rebuild = @module_config['rebuild']
+        index_file = index_dest + @module_config['index_file']
+
+        if @module_config['rebuild'] == false
+          if File.exist?(index_file)
+            Jekyll.logger.info 'J1 QuickSearch:', 'recreate index disabled.'
+            # Keep the index file from being cleaned by Jekyll
+            #
+            site.static_files << SearchIndexFile.new(site, site.dest, '/', @module_config['index_file'])
+            return
+          end
+        end
+
+        Jekyll.logger.info 'J1 QuickSearch:', 'creating search index ...'
+
         # gather posts and pages
         #
         items = pages_to_index(site)
         content_renderer = PageRenderer.new(site)
         # index = []
+        # rebuild = @module_config['rebuild']
 
         index_js = open(@lunr_path).read
+
         # NOTE: all settings must be added within the index function
         #
         index_js << 'var idx = lunr(function() {'
@@ -136,12 +153,14 @@ module Jekyll
             'body'        => entry.body
           }
 
-          # remove unwanted categories
-          doc['categories'] -= @strip_categories
+          # remove unwanted categories (if any)
+          #
+          doc['categories'] -= @strip_categories unless doc['categories'] == nil
 
           index_js << 'this.add(' << ::JSON.generate(doc, quirks_mode: true) << ');'
 
           # reduce the size of the doc array by deleting the body key
+          #
           doc.delete('body')
           @docs[i] = doc
 
@@ -282,7 +301,7 @@ module Jekyll
               description = excerpt
             end
           end
-          
+
           SearchEntry.new(title, tagline, url, date, tags, categories, description, is_post, body, renderer)
         else
           raise 'Not supported'
@@ -341,6 +360,6 @@ end
 
 module Jekyll
   module J1LunrSearch
-    VERSION = '2021.0.12'
+    VERSION = '2021.1.0'
   end
 end

data/lib/starter_web/collections/posts/public/featured/_posts/0000-00-00-welcome-to-j1.adoc.erb

@@ -3,16 +3,18 @@ title:                                  Welcome
 tagline:                                jekyll for everyone
 date:                                   <%= Time.now.strftime('%Y-%m-%d') %> 00:00:00
 
-tags:                                   [ Example, Post ]
 categories:                             [ Featured ]
+tags:                                   [ Example, Post ]
 
 series:                                 false
-adsense:                                false
 image:                                  /assets/images/modules/attics/katie-moum-1920x1280.jpg
+
+adsense:                                false
+comments:                               false
+advertising:                            false
 toc:                                    true
 
 regenerate:                             false
-
 resources:                              []
 resource_options:
   - attic:
@@ -38,12 +40,13 @@ resource_options:
 
 // Place an excerpt at the most top position
 // -----------------------------------------------------------------------------
-All you're doing at the end of the day is writing your content and Jekyll does
-all the tricky things needed for a website: putting out HTML, Javascript and
-CSS. As a result, the site creation process gets out of your way. Sounds fun,
-isn't it?
+All you’re doing at the end of the day is writing your content, and the J1
+Template does all the tricky things: putting out HTML, Javascript, and CSS.
+As a result, the site creation process gets out of your way.
 
-[role="clearfix mb-3"]
+Sounds fun, isn't it?
+
+// [role="clearfix mb-3"]
 excerpt__end
 
 //  Load Liquid procedures
@@ -70,13 +73,10 @@ which use a database to load dynamic content, a static site will display
 the same content to every user as it will directly load the HTML files
 on the server.
 
-A static website uses server-side rendering to serve pre-built HTML, CSS,
-and JavaScript files to a web browser, in contrast to traditional dynamic
-sites that work by rendering the webpage at the time of the request.
-Static sites enable you to decouple your content repository and front-end
-interface, giving you greater flexibility in how your content is served.
-Cost-efficiency is another reason companies migrate to a static site because
-static files are lightweight and often faster and cheaper to serve.
+A static site serves the content straight to the user as it is stored on
+the server-side. In opposition to WordPress, which uses a database to load
+dynamic content, a static site will display the same content to every user
+as it will directly load the HTML files on the server.
 
 In the last few years, static sites have greatly increased in popularity.
 This surge is primarily due to advances in developer tools (languages and
@@ -85,15 +85,14 @@ performance beyond the limits of a database-driven site.
 
 === What's different?
 
-To make it simple, a dynamic website uses a database and PHP/MySQL to
-generate the content of a page when a user requests it. For example,
-building a website using WordPress CMS will result in having a dynamic
-Website.
+A dynamic website uses a database and PHP/MySQL to generate the content of
+a page when a user requests it. For example, building a website using
+WordPress CMS will result in having a dynamic Website.
 
 Static sites can be written almost exclusively in HTML and serve a fixed
 set of data that renders the same for every site visitor. Static sites use
 server-side rendering to serve pre-built HTML, CSS, and JavaScript files to
-a web browser. Dynamic sites operate in a completely different way, by
+a web browser. Dynamic sites operate in a completely different way by
 leveraging HTML and CSS as well as server-side scripting languages like PHP
 to build webpages on the fly and serve different content to each site
 visitor.
@@ -101,9 +100,9 @@ visitor.
 === Why use a static site?
 
 What are the advantages of a static website over a dynamic site?
-You may be wondering *Why should I build a static site when I could do a
-WordPress?*. Well, having a database implies a lot of downsides. Here
-come the main advantages of using a static site over a dynamic
+You may be wondering *Why should I build a static site when I could do the
+same by using WordPress?*. Well, having a database implies a lot of downsides.
+Here come the main advantages of using a static site over a dynamic
 one.
 
 Performance::
@@ -113,45 +112,45 @@ it is crazy fast to load. Indeed, when the user requests a page, there is
 no need to request a database and various files to generate the
 page itself as all the content is already placed in a one and only file:
 an HTML one. That’s why by using a static site, you will get a boost in
-your loading time that will provide great user experience for the
+your loading time that will provide a great user experience for the
 internauts. Moreover, we know that more and more people are surfing the
-web using their smartphones with, sometimes, poor internet connections,
-that’s why having fast loading times will participate in making your
+web using their smartphones with, sometimes, poor internet connections.
+That’s why having fast loading times will participate in making your
 website mobile-friendly.
 
 Security::
 *Having a static website: say goodbye to hacking and security issues*.
-Tired of getting WordPress notifications about security issues and
-updates every week? No worries, as a static site has no database, there
-are close to no hack possible compared to a WordPress website. Indeed,
-your site will have way fewer footprints and security issues since it
-will only load plain HTML and CSS files. The security gain in having a
-static website is one the main reason why many famous brands switch to
-a static site instead of having their website on Drupal or WordPress.
+Are you tired of getting WordPress notifications about security issues and
+updates every week? No worries, as a static site has no database, there are
+close to no hack possible compared to a WordPress website. Indeed, your
+site will have way fewer footprints and security issues since it will
+only load plain HTML and CSS files. The security gain in having a static
+website is one of the main reasons why many famous brands switch to a
+static site instead of having their website on Drupal or WordPress.
 
 Hosting::
 *Building a static site and hosting: you will save you money*.
-Using a static site, you will only have most of the time only HTML and
-CSS files to host. This kind of files is super light which also means
-that you will not need a powerhouse hosting to have a static site up and
-running. Moreover, if your traffic suddenly increases, your site will not
-go down contrary to a dynamic site which should request the database
-each time for each user.
+Using a static site, you will only have most of the time only HTML and CSS
+files to host. This kind of file is super light which also means that you
+will not need a powerhouse hosting to have a static site up and running.
+Moreover, if your traffic suddenly increases, your site will not go down,
+contrary to a dynamic site that should request the database each time
+for each user.
 
 Control::
-*You're the master*. Using a CMS means, giving control over your site to others.
-Simple like this.
+*You're the master*. You were using a CMS means, giving control over your
+site to others. Simple like this.
 
 == Why use a site generator?
 
 Working with pure HTML files is annoying; senseless today. Indeed, if you need
 to make a modification on your *self-managed* pages, you have to manually
 change every file. That's monkey's work from the early days of static websites.
-If your site comes with 10 pages, it can be manageable but imagine if your site
-is providing 100+ pages or the blog planned for hundreds of articles?
+If your site comes with ten pages, it can be manageable but imagine if your
+site is providing 100+ pages or the blog planned for hundreds of articles?
 
 Using a static site generator will solve this issue as it separates the
-content and the template. To say it another way, by using a static site
+content and the Template. To say it another way, by using a static site
 generator, you will only need to make the modification once, and the
 generator will apply it to all your pages.
 
@@ -164,6 +163,6 @@ better depending on the programming languages you already are familiar with.
 Which static site generator should I use?
 
 When I decided to go for a blog based on a static web, I personally
-choose Jekyll as for me. It's a well known static site generator, good support
-in case of trouble and the software gets regularly updated. This website is
+choose Jekyll as for me. It's a well-known static site generator, good support
+in case of trouble, and the software gets regularly updated. This website is
 powered by Jekyll. For good reasons.