j1-template 2023.2.7 → 2023.3.1

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/files_and_folders.asciidoc

@@ -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.
+
+|===

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/global_configuration_options.asciidoc

@@ -0,0 +1,63 @@
+
+.Global Configuration Options
+[cols="2a,2a,2a,6a", width="100%", options="header", role="rtable mt-4"]
+|===
+|Setting |Option |Flag |Description
+
+|*Site Source*
+|`source: DIR`
+|`-s, --source DIR`
+|Change the directory where Jekyll will read files
+
+|*Site Destination*
+|`destination: DIR` +
+|`-d, --destination DIR`
+|Change the directory where Jekyll will write files
+
+|*Safe*
+|`safe: BOOL`
+|`--safe`
+|Disable non-whitelisted plugins, caching to disk, and ignore symbolic links.
+
+|*Exclude*
+|`exclude: [DIR, FILE, ...]`
+|`na`
+|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.
+
+|*Include*
+|`include: [DIR, FILE, ...]`
+|`na`
+|Force inclusion of directories and/or files in the conversion.
+The file `.htaccess` is a good example since dotfiles are excluded
+by default.
+
+|*Keep files*
+|`keep_files: [DIR, FILE, ...]`
+|`na`
+|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`.
+
+|*Time Zone*
+|`timezone: TIMEZONE`
+|`na`
+|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, {browser-window--new}]
+is valid, e.g. `America/New_York`. A list of all available values can be
+found from
+https://en.wikipedia.org/wiki/List_of_tz_database_time_zones[here, {browser-window--new}].
+The default is the local time zone, as set by your operating system.
+
+|*Encoding*
+|`encoding: ENCODING`
+|`na`
+|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`.
+
+|===

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/global_variables.asciidoc

@@ -0,0 +1,26 @@
+
+.Global Variables
+[cols="4a,8a", width="100%", options="header", role="rtable mt-4"]
+|===
+|Variable |Description
+
+|`site`
+|Sitewide configuration settings from `_config.yml`.
+
+|`page`
+|Page specific information. Custom variables set via the YAML Front Matter
+will be available here.
+
+|`layout`
+|Layout specific information. 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.
+
+|===

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/page_variables.asciidoc

@@ -0,0 +1,54 @@
+
+.Page Variables
+[cols="4a,8a", width="100%", options="header", role="rtable mt-4"]
+|===
+|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.
+
+|===

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/serve_command_options.asciidoc

@@ -0,0 +1,45 @@
+
+.Serve Command Options
+[cols="2a,2a,2a,6a", width="100%", options="header", role="rtable mt-4"]
+|===
+|Setting |Option |Flag |Description
+
+
+|*Local Server Port*
+|`port: PORT`
+|`--port PORT`
+|Listen on the given port.
+
+|*Local Server Hostname*
+|`host: HOSTNAME`
+|`--host HOSTNAME`
+|Listen at the given hostname.
+
+|*Base URL*
+|`baseurl: URL`
+|`--baseurl URL`
+|Serve the website from the given base URL
+
+|*Detach*
+|`detach: BOOL`
+|`-B, --detach`
+|Detach the server from the terminal to run the Jekyll executeable
+in background.
+NOTE: The parameter Detach is *not* available on _Windows_.
+
+|*Skip the initial site build*
+|`na`
+|`--skip-initial-build`
+|Skips the initial site build which occurs before the server is started
+
+|*X.509 (SSL) Private Key*
+|`na`
+|`--ssl-key`
+|SSL Private Key if HTTPS connections are used
+
+|*X.509 (SSL) Certificate*
+|`na`
+|`--ssl-cert`
+|SSL Public certificate if HTTPS connections are used
+
+|===

data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/site_variables.asciidoc

@@ -0,0 +1,59 @@
+
+.Site Variables
+[cols="4a,8a", width="100%", options="header", role="rtable mt-4"]
+|===
+|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.
+
+|===