RubyGems - j1-template - Versions diffs - 2022.5.1 → 2022.5.2 - Mend

j1-template 2022.5.1 → 2022.5.2

Files changed (143) hide show

data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/documentation.adoc CHANGED Viewed

@@ -11,25 +11,40 @@ description: >
                                         structure. Complex AsciiDoc projects of type documentation can be
                                         easily worked on by multiple authors.
-categories:                             [ Knowledge ]
-tags:                                   [ Asciidoc, Skeleton, Documentation, PDF ]
+categories:                             [ Knowledge, Asciidoc ]
+tags:                                   [ Skeleton, Documentation, Book ]
 robots:
   index:                                false
   follow:                               false
+personalization:                        false
+comments:                               false
+exclude_from_search:                    false
+fab_menu_id:                            page_ctrl
+scrollbar:                              false
+toc:                                    true
 permalink:                              /pages/public/skeleton/documentation/
-regenerate:                             false
+regenerate:                             true
 resources:                              [ animate, clipboard, lightbox, rouge ]
 resource_options:
+  - toccer:
+      collapseDepth:                    3
   - attic:
+      padding_top:                      400
+      padding_bottom:                   50
+      opacity:                          0.5
       slides:
         - url:                          /assets/images/modules/attics/sigmund-1920x1280.jpg
           alt:                          Photo by Sigmund on Unsplash
-          title:                        Skeleton
-          tagline:                      documentation
           alignY:                       0.3
           badge:
             type:                       unsplash

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/100_chapter.asciidoc CHANGED Viewed

@@ -13,99 +13,7 @@ The table below lists the available settings for Jekyll, and the various
 `options` (specified in the configuration file) and `flags` (specified on the
 command-line) that control them.
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|Setting |Options and Flags
-a|
-*Site Source*
-Change the directory where Jekyll will read files
- a|
-`source: DIR`
-`-s, --source DIR`
-a|
-*Site Destination*
-Change the directory where Jekyll will write files
- a|
-`destination: DIR`
-`-d, --destination DIR`
-a|
-*Safe*
-Disable custom plugins, and ignore symbolic links.
- a|
-`safe: BOOL`
-`--safe`
-a|
-*Exclude*
-Exclude directories and/or files from the conversion. These exclusions
-are relative to the site's source directory and cannot be outside the
-source directory.
- |`exclude: [DIR, FILE, ...]`
-a|
-*Include*
-Force inclusion of directories and/or files in the conversion.
-`.htaccess` is a good example since dotfiles are excluded by default.
- |`include: [DIR, FILE, ...]`
-a|
-*Keep files*
-When clobbering the site destination, keep the selected files. Useful
-for files that are not generated by jekyll; e.g. files or assets that
-are generated by your build tool. The paths are relative to the
-`destination`.
- |`keep_files: [DIR, FILE, ...]`
-a|
-*Time Zone*
-Set the time zone for site generation. This sets the `TZ` environment
-variable, which Ruby uses to handle time and date creation and
-manipulation. Any entry from the
-https://en.wikipedia.org/wiki/Tz_database[IANA Time Zone Database] is
-valid, e.g. `America/New_York`. A list of all available values can be
-found
-https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[here]. The
-default is the local time zone, as set by your operating system.
- |`timezone: TIMEZONE`
-a|
-*Encoding*
-Set the encoding of files by name (only available for Ruby 1.9 or
-later). The default value is `utf-8` starting in 2.0.0, and `nil` before
-2.0.0, which will yield the Ruby default of `ASCII-8BIT`. Available
-encodings can be shown by the command
-`ruby -e 'puts Encoding::list.join("\n")'`.
- |`encoding: ENCODING`
-a|
-*Defaults*
-Set defaults for YAML Front Matter variables.
- |see below
-|=======================================================================
+include::../tables/global_configuration_options.asciidoc[]
 [WARNING]
 ====
@@ -122,118 +30,7 @@ staging area and copy files from there to your web server.
 === Build Command Options
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|Setting |Options and Flags
-a|
-*Regeneration*
-Enable auto-regeneration of the site when files are modified.
- |`-w, --[no-]watch`
-a|
-*Configuration*
-Specify config files instead of using `_config.yml` automatically.
-Settings in later files override settings in earlier files.
- |`--config FILE1[,FILE2,...]`
-a|
-*Drafts*
-Process and render draft posts.
- a|
-`show_drafts: BOOL`
-`--drafts`
-a|
-*Environment*
-Use a specific environment value in the build.
- |`JEKYLL_ENV=production`
-a|
-*Future*
-Publish posts or collection documents with a future date.
- a|
-`future: BOOL`
-`--future`
-a|
-*LSI*
-Produce an index for related posts.
- a|
-`lsi: BOOL`
-`--lsi`
-a|
-*Limit Posts*
-Limit the number of posts to parse and publish.
- a|
-`limit_posts: NUM`
-`--limit_posts NUM`
-a|
-*Force polling*
-Force watch to use polling.
- |`--force_polling`
-a|
-*Verbose output*
-Print verbose output.
- |`-V, --verbose`
-a|
-*Silence Output*
-Silence the normal output from Jekyll during a build
- |`-q, --quiet`
-a|
-*Incremental build*
-Enable the experimental incremental build feature. Incremental build
-only re-builds posts and pages that have changed, resulting in
-significant performance improvements for large sites, but may also break
-site generation in certain cases.
- a|
-`incremental: BOOL`
-`-I, --incremental`
-a|
-*Liquid profiler*
-Generate a Liquid rendering profile to help you identify performance
-bottlenecks.
- a|
-`profile: BOOL`
-`--profile`
-|=======================================================================
+include::../tables/build_command_options.asciidoc[]
 === Serve Command Options
@@ -241,68 +38,7 @@ In addition to the options below, the `serve` sub-command can accept any of
 the options for the `build` sub-command, which are then applied to the site
 build which occurs right before your site is served.
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|======================================================================
-|Setting |Options and Flags
-a|
-*Local Server Port*
-Listen on the given port.
- a|
-`port: PORT`
-`--port PORT`
-a|
-*Local Server Hostname*
-Listen at the given hostname.
- a|
-`host: HOSTNAME`
-`--host HOSTNAME`
-a|
-*Base URL*
-Serve the website from the given base URL
- a|
-`baseurl: URL`
-`--baseurl URL`
-a|
-*Detach*
-Detach the server from the terminal
- a|
-`detach: BOOL`
-`-B, --detach`
-a|
-*Skips the initial site build.*
-Skips the initial site build which occurs before the server is started.
- |`--skip-initial-build`
-a|
-*X.509 (SSL) Private Key*
-SSL Private Key.
- |`--ssl-key`
-a|
-*X.509 (SSL) Certificate*
-SSL Public certificate.
- |`--ssl-cert`
-|======================================================================
+include::../tables/serve_command_options.asciidoc[]
 [WARNING]
 ====
@@ -370,67 +106,11 @@ A basic Jekyll site usually looks something like this:
 └── index.html
 ----
-=== Dirs and Files
+=== Files and Folders
 An overview of what each of these does:
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|File / Directory |Description
-|`_config.yml`
-|Stores configuration data. Many
-of these options can be specified from the command line executable but
-it's easier to specify them here so you don't have to remember them.
-|`_drafts` |Drafts are unpublished posts. The format of these files is
-without a date: `title.MARKUP`. Learn how to work with drafts.
-|`_includes` |These are the partials that can be mixed and matched by
-your layouts and posts to facilitate reuse. The liquid tag
-`{% include file.ext %}` can be used to include the
-partial in `_includes/file.ext`.
-|`_layouts` |These are the templates that wrap posts. Layouts are chosen
-on a post-by-post basis in the YAML Front Matter,
-which is described in the next section. The liquid tag
-`{{ content }}` is used to inject content into the
-web page.
-|`_posts` |Your dynamic content, so to speak. The naming convention of
-these files is important, and must follow the format:
-`YEAR-MONTH-DAY-title.MARKUP`. The permalinks can
-be customized for each post, but the date and markup language are
-determined solely by the file name.
-|`_data` |Well-formatted site data should be placed here. The Jekyll
-engine will autoload all YAML files in this directory (using either the
-`.yml`, `.yaml`, `.json` or `.csv` formats and extensions) and they will
-be accessible via `site.data`. If there's a file `members.yml` under the
-directory, then you can access contents of the file through
-`site.data.members`.
-|`_site` |This is where the generated site will be placed (by default)
-once Jekyll is done transforming it. It's probably a good idea to add
-this to your `.gitignore` file.
-|`.jekyll-metadata` |This helps Jekyll keep track of which files have
-not been modified since the site was last built, and which files will
-need to be regenerated on the next build. This file will not be included
-in the generated site. It's probably a good idea to add this to your
-`.gitignore` file.
-|`index.html` and other HTML, Markdown, Textile files |Provided that the
-file has a YAML Front Matter section, it will be
-transformed by Jekyll. The same will happen for any `.html`,
-`.markdown`, `.md`, or `.textile` file in your site's root directory or
-directories not listed above.
-|Other Files/Folders |Every other directory and file except for those
-listed above such as `css` and `images` folders, `favicon.ico` files,
-and so forthÔÇöwill be copied verbatim to the generated site. There are
-plenty of sites already using Jekyll if you're curious
-to see how they're laid out.
-|=======================================================================
+include::../tables/files_and_folders.asciidoc[]
 === Set a Jekyll environment
 You can specify a Jekyll environment at build time. In the build (or serve)

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/200_chapter.asciidoc CHANGED Viewed

@@ -6,126 +6,17 @@ a variety of data available via the `Liquid templating system`.
 The following is a reference of the available data.
 === Global Variables
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|Variable |Description
-|`site` |Sitewide information + configuration settings from
-`_config.yml`. See below for details.
-|`page` |Page specific information + the YAML front
-matter. Custom variables set via the YAML Front Matter will be
-available here. See below for details.
-|`layout`
-|Layout specific information + the YAML
-front matter. Custom variables set via the YAML Front Matter in layouts
-will be available here.
-|`content` |In layout files, the rendered content of the Post or Page
-being wrapped. Not defined in Post or Page files.
-|`paginator` |When the `paginate` configuration option is set, this
-variable becomes available for use. See Pagination
-for details.
-|=======================================================================
+include::../tables/global_variables.asciidoc[]
 === Site Variables
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|Variable |Description
-|`site.time` |The current time (when you run the `jekyll` command).
-|`site.pages` |A list of all Pages.
-|`site.posts` |A reverse chronological list of all Posts.
-|`site.related_posts` |If the page being processed is a Post, this
-contains a list of up to ten related Posts. By default, these are the
-ten most recent posts. For high quality but slow to compute results, run
-the `jekyll` command with the `--lsi`
-(https://en.wikipedia.org/wiki/Latent_semantic_analysis#Latent_semantic_indexing[latent
-semantic indexing]) option. Also note GitHub Pages does not support the
-`lsi` option when generating sites.
-|`site.static_files` |A list of all (i.e. files not processed by
-Jekyll's converters or the Liquid renderer). Each file has three
-properties: `path`, `modified_time` and `extname`.
-|`site.html_pages` |A subset of `site.pages` listing those which end in
-`.html`.
-|`site.html_files` |A subset of `site.static_files` listing those which
-end in `.html`.
-|`site.collections` |A list of all the collections.
-|`site.data` |A list containing the data loaded from the YAML files
-located in the `_data` directory.
-|`site.documents` |A list of all the documents in every collection.
-|`site.categories.CATEGORY` |The list of all Posts in category `CATEGORY`.
-|`site.tags.TAG` |The list of all Posts with tag `TAG`.
-|`site.[CONFIGURATION_DATA]` |All the variables set via the command line
-and your `_config.yml` are available through the `site` variable. For
-example, if you have `url: http://mysite.com` in your configuration
-file, then in your Posts and Pages it will be stored in `site.url`.
-Jekyll does not parse changes to `_config.yml` in `watch` mode, you must
-restart Jekyll to see changes to variables.
-|=======================================================================
+include::../tables/site_variables.asciidoc[]
 === Page Variables
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|=======================================================================
-|Variable |Description
-|`page.content` |The content of the Page, rendered or un-rendered
-depending upon what Liquid is being processed and what `page` is.
-|`page.title` |The title of the Page.
-|`page.excerpt` |The un-rendered excerpt of the Page.
-|`page.url` |The URL of the Post without the domain, but with a leading
-slash, e.g. `/2008/12/14/my-post.html`
-|`page.date` |The Date assigned to the Post. This can be overridden in a
-Post's front matter by specifying a new date/time in the format
-`YYYY-MM-DD HH:MM:SS` (assuming UTC), or `YYYY-MM-DD HH:MM:SS +/-TTTT`
-(to specify a time zone using an offset from UTC. e.g.
-`2008-12-14 10:30:00 +0900`).
-|`page.id` |An identifier unique to the Post (useful in RSS feeds). e.g.
-`/2008/12/14/my-post`
-|`page.categories` |The list of categories to which this post belongs.
-Categories are derived from the directory structure above the `_posts`
-directory. For example, a post at
-`/work/code/_posts/2008-12-24-closures.md` would have this field set to
-`['work', 'code']`. These can also be specified in the
-YAML Front Matter.
-|`page.tags` |The list of tags to which this post belongs. These can be
-specified in the YAML Front Matter.
-|`page.path` |The path to the raw post or page. Example usage: Linking
-back to the page or post's source on GitHub. This can be overridden in
-the YAML Front Matter.
-|`page.next` |The next post relative to the position of the current post
-in `site.posts`. Returns `nil` for the last entry.
-|`page.previous` |The previous post relative to the position of the
-current post in `site.posts`. Returns `nil` for the first entry.
-|=======================================================================
+include::../tables/page_variables.asciidoc[]
 [TIP]
 ====
@@ -140,25 +31,3 @@ example, if you specify `class: full_page` in a pages front matter,
 that value will be available as `layout.class` in the layout and its
 parents.
 ====
-=== Paginator
-[width="100%", cols="6,6", options="header", role="table-responsive mt-3"]
-|==============================================================
-|Variable |Description
-|`paginator.per_page` |Number of Posts per page.
-|`paginator.posts` |Posts available for that page.
-|`paginator.total_posts` |Total number of Posts.
-|`paginator.total_pages` |Total number of pages.
-|`paginator.page` |The number of the current page.
-|`paginator.previous_page` |The number of the previous page.
-|`paginator.previous_page_path` |The path to the previous page.
-|`paginator.next_page` |The number of the next page.
-|`paginator.next_page_path` |The path to the next page.
-|==============================================================
-NOTE: These are only available in index files, however they can be located
-in a subdirectory, such as `<code>/blog/index.html</code>`.
-NOTE: J1 is using Paginator V2 for pagination. See details with
-{plugins_paginator_v2_user_guide}[Paginator V2 User Guide].

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/images/readme ADDED Viewed

	@@ -0,0 +1 @@
1	+ Contains images to be includes from local include/images folder

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/build_command_options.asciidoc ADDED Viewed

@@ -0,0 +1,72 @@
+.Build Command Options
+[cols="2a,2a,2a,6a", width="100%", options="header", role="rtable mt-4"]
+|===
+|Setting |Option |Flag |Description
+|*Regeneration*
+|`na`
+|`-w, --[no-]watch`
+|Enable auto-regeneration of the site when files are modified.
+|*Configuration*
+|`na`
+|`--config FILE1 [,FILE2, ..]`
+|Specify config files instead of using `_config.yml` automatically.
+Settings in later files override settings in earlier files.
+|*Drafts*
+|`show_drafts: BOOL`
+|`--drafts`
+|Process and render draft posts.
+|*Environment*
+|`na`
+|`na`
+|Use a specific environment value `JEKYLL_ENV=production` in the build.
+|*Future*
+|`future: BOOL`
+|`--future`
+|Publish posts or collection documents with a future date.
+|*LSI*
+|`lsi: BOOL`
+|`--lsi`
+|Produce an index for related posts.
+|*Limit Posts*
+|`limit_posts: NUM`
+|`--limit_posts NUM`
+|Limit the number of posts to parse and publish.
+|*Force polling*
+|`na`
+|`--force_polling`
+|Force watch to use polling.
+|*Verbose output*
+|`na`
+|`-V, --verbose`
+|Print verbose output.
+|*Silence Output*
+|`na`
+|`-q, --quiet`
+|Silence the normal output from Jekyll during a build
+|*Incremental build*
+|`incremental: BOOL`
+|`-I, --incremental`
+|Enable the experimental incremental build feature. Incremental build
+only re-builds posts and pages that have changed, resulting in
+significant performance improvements for large sites, but may also break
+site generation in certain cases.
+|*Liquid profiler*
+|`profile: BOOL`
+|`--profile`
+|Generate a Liquid rendering profile to help you identify performance
+bottlenecks.
+|===

data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/tables/files_and_folders.asciidoc ADDED Viewed

@@ -0,0 +1,66 @@
+.Files and Folders
+[cols="4a,8a", width="100%", options="header", role="rtable mt-4"]
+|===
+|File\|Folder |Description
+|`_config.yml`
+|Stores all *side-wide* used configuration data. Many of these options can
+be specified from the command line executable but it's easier to specify
+them in a file so you don't have to remember them.
+|`_drafts`
+|Drafts are unpublished posts. The format of these files is without a
+date: `title.MARKUP`.
+|`_includes`
+|These are the partials that can be mixed and matched by your layouts and
+posts to facilitate reuse. The liquid tag `{% include file.ext %}` can be
+used to include the partial in `_includes/file.ext`.
+|`_layouts`
+|This folder contains the templates that wrap posts and pages. Layouts
+are chosen on a file-by-file basis in the YAML Front Matter, which is
+described in the next section. The liquid tag `{{content}}` is used to
+inject content into the web page.
+|`_posts`
+|The folder contains your blog post content. The naming convention of
+these files is important, and must follow the format: `YEAR-MONTH-DAY-title.ext`.
+The *permalinks* can be customized for each post, but the date and markup
+language are determined solely by the file name.
+|`_data`
+|Well-formatted site data should be placed in that folder. The Jekyll
+engine will autoload all YAML files in this directory (using either the
+`.yml`, `.yaml`, `.json` or `.csv` formats and extensions) and they will
+be accessible via `site.data`. If there's a file e.g. `members.yml` under
+the directory, then you can access contents of the file through
+`site.data.members`.
+|`_site`
+|This folder is where the generated site will be placed (by default)
+once Jekyll is done transforming it. It's probably a good idea to add
+this to your `.gitignore` file if you're using _Git_ for version control.
+|`.jekyll-metadata`
+|This file helps Jekyll keep track of which files have not been modified
+since the site was last built, and which files will need to be regenerated
+on the next build. This file will not be included in the generated site.
+It's probably a good idea to add this to your `.gitignore` file if you're
+using _Git_ for version control.
+|`index.html`
+|`index.html` and other HTML, Asciidoc, Markdown, Textile files. If the
+file contains a YAML *Front Matter* section, it will be transformed by
+Jekyll. The same will happen for any `.html`, `.adoc`, `.markdown`, `.md`,
+or `.textile` file in your site's root directory or directories not
+listed above.
+|Other Files or Folders
+|Every other directory and file except for those listed above such as
+`css` and `images` folders, `favicon.ico` files, and so forth will be
+copied verbatim to the generated site. There are plenty of sites already
+using Jekyll if you're curious to see how they're laid out.
+|===