j1_template_mde 2018.4.10

data/lib/starter_web/pages/start/kickstarter/web_in_a_day/000_includes/documents/templates.adoc

@@ -0,0 +1,249 @@
+---
+layout:                       page
+description:                  Jekyll-style Templates
+title:                        Templates
+tagline:                      Jekyll-style Templates
+group:                        pages
+toc:                          true
+---
+
+:website:                     https://www.elastic.co/
+:license:                     Apache License, Version 2.0
+:revdate:                     2015
+:revnumber:                   4.2.2
+
+//Ref
+:liquid-inheritance-gem:      https://github.com/danwrong/liquid-inheritance
+:liquid-inheritance:          http://www.sameratiani.com/2011/10/22/get-jekyll-working-with-liquid-inheritance.html
+
+// {% raw %} Disable from processing to preserve the liquid markup's in the document
+
+
+[.boxShadow]
+====
+Jekyll uses the Liquid templating language to process templates. 
+====
+
+== Filters
+
+All of the standard Liquid tags and filters are supported. Jekyll even adds a 
+few handy filters and tags of its own to make common tasks easier.
+
+[width="100%",cols="40%,60%",options="header", role="table-responsive mt-3"]
+|=======================================================================
+|Description |Filter and Output
+|*Relative URL*
+
+Prepend the `baseurl` value to the input. Useful if your site is hosted at a subpath rather than the root of the domain.
+| `{{ "/assets/style.css" \| relative_url }}` 
+
+*`my-baseurl/assets/style.css`*
+
+|*Absolute URL*
+
+Prepend the `url` and `baseurl` value to the input. 
+| `{{ "/assets/style.css" \| absolute_url }}`
+
+*`http://example.com/my-baseurl/assets/style.css`*
+
+|*Date to XML Schema*
+
+Convert a Date into XML Schema (ISO 8601) format. 
+| `{{ site.time \| date_to_xmlschema }}` 
+
+*`2008-11-07T13:07:54-08:00`*
+
+|*Date to RFC-822 Format*
+
+Convert a Date into the RFC-822 format used for RSS feeds.
+
+|`{{ site.time \| date_to_rfc822 }}`
+
+*`Mon, 07 Nov 2008 13:07:54 -0800`*
+
+|*Date to String*
+
+Convert a date to short format.
+
+|`{{ site.time \| date_to_string }}`
+
+*`07 Nov 2008`*
+
+|*Date to Long String*
+
+Format a date to long format.
+
+|`{{ site.time \| date_to_long_string }}`
+
+*`07 November 2008`*
+
+|*Where*
+
+Select all the objects in an array where the key has the given value.
+
+|`{{ site.members \| where:"graduation_year","2014" }}`
+
+|*Where Expression*
+
+Select all the objects in an array where the expression is true. Jekyll
+v3.2.0 & later.
+
+|`{{ site.members \| where_exp:"item",
+
+ "item.graduation_year == 2014" }}`
+
+`{{ site.members \| where_exp:"item", 
+
+"item.graduation_year < 2014" }}`
+
+`{{ site.members \| where_exp:"item", 
+
+"item.projects contains 'foo'" }}`
+
+|*Group By*
+
+Group an array's items by a given property.
+
+|`{{ site.members \| group_by:"graduation_year" }}`
+
+*`[{"name"=>"2013", "items"=>[...]}, 
+
+{"name"=>"2014", "items"=>[...]}]`*
+
+|*XML Escape*
+
+Escape some text for use in XML.
+
+|`{{ page.content \| xml_escape }}`
+
+|*CGI Escape*
+
+CGI escape a string for use in a URL. Replaces any special characters
+with appropriate %XX replacements.
+
+|`{{ "foo,bar;baz?" \| cgi_escape }}`
+
+*`foo%2Cbar%3Bbaz%3F`*
+
+|*URI Escape*
+
+URI escape a string.
+
+|`{{ "foo, bar \baz?" \| uri_escape }}`
+
+*`foo,%20bar%20%5Cbaz?`*
+
+|*Number of Words*
+
+Count the number of words in some text.
+
+|`{{ page.content \| number_of_words }}`
+
+*`1337`*
+
+|*Array to Sentence*
+
+Convert an array into a sentence. Useful for listing tags.
+
+|`{{ page.tags \| array_to_sentence_string }}`
+
+*`foo, bar, and baz`*
+
+|*Markdownify*
+
+Convert a Markdown-formatted string into HTML.
+
+|`{{ page.excerpt \| markdownify }}`
+
+|*Smartify*
+
+Convert "quotes" into &ldquo;smart quotes&rdquo;.
+
+|`{{ page.title \| smartify }}`
+
+|*Converting Sass/SCSS*
+
+Convert a Sass- or SCSS-formatted string into CSS.
+
+|`{{ some_scss \| scssify }}` 
+
+
+|*Slugify*
+
+Convert a string into a lowercase URL "slug". See below for options.
+
+|`{{ "The &#x5F;config.yml file" \| slugify }}`
+
+*`the-config-yml-file`*
+
+`{{ "The &#x5F;config.yml file" \| slugify: 'pretty' }}`
+
+*`the-&#x5F;config.yml-file`*
+
+|*Data To JSON*
+
+Convert Hash or Array to JSON.
+
+|`{{ site.data.projects \| jsonify }}`
+
+|*Normalize Whitespace*
+
+Replace any occurrence of whitespace with a single space.
+
+|`{{ "a \n b" \| normalize&#x5F;whitespace }}`
+
+|*Sort*
+
+Sort an array. Optional arguments for hashes: 1. property name 2. nils
+order (__first__ or __last__).
+
+|`{{ page.tags \| sort }}`
+
+`{{ site.posts \| sort: 'author' }}`
+
+`{{ site.pages \| sort: 'title', 'last' }}`
+
+|*Sample*
+
+Pick a random value from an array. Optional: pick multiple values.
+
+|`{{ site.pages \| sample }}`
+
+`{{ site.pages \| sample:2 }}`
+
+|*To Integer*
+
+Convert a string or boolean to integer.
+
+|`{{ some_var \| to_integer }}`
+
+|*Array Filters*
+
+Push, pop, shift, and unshift elements from an Array.
+
+These are **NON-DESTRUCTIVE**, i.e. they do not mutate the array, but
+rather make a copy and mutate that.
+
+|`{{ page.tags \| push: 'Spokane' }}`
+
+*`['Seattle', 'Tacoma', 'Spokane']`*
+
+`{{ page.tags \| pop }}`
+
+*`['Seattle']`*
+
+`{{ page.tags \| shift }}`
+
+*`['Tacoma']`*
+
+`{{ page.tags \| unshift: "Olympia" }}`
+
+*`['Olympia', 'Seattle', 'Tacoma']`*
+
+|*Inspect*
+
+Convert an object into its String representation for debugging.
+
+|`{{ some_var \| inspect }}`
+
+|=======================================================================

data/lib/starter_web/pages/start/kickstarter/web_in_a_day/000_includes/documents/variables.adoc

@@ -0,0 +1,175 @@
+---
+layout:                 page
+description:            Manage and Create Web sites with Jekyll
+title:                  Jekyll Variables
+tagline:                Manage and Create Web sites with Jekyll
+group:                  pages
+toc:                    true
+---
+
+:website:               https://jekyllrb.com/
+:revnumber:             3.2.1
+
+
+[.boxShadow]
+====
+Jekyll traverses your site looking for files to process. Any files with `YAML
+front matter` are subject to processing. For each of these files, Jekyll makes 
+a variety of data available via the `Liquid templating system`. 
+
+The following is a reference of the available data.
+====
+
+== Global Variables
+
+[width="100%", cols="4,8",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 link:../frontmatter/[YAML front
+matter]. Custom variables set via the YAML Front Matter will be
+available here. See below for details.
+
+|`layout` |Layout specific information + the link:../frontmatter/[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 link:./pagination/[Pagination]
+for details.
+|=======================================================================
+
+== Site Variables
+
+
+[width="100%", cols="4,8",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.
+|=======================================================================
+
+
+== Page Variables
+
+[width="100%", cols="4,8",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
+`/source/code/_posts/2008-12-24-closures.md` would have this field set to
+`['work', 'code']`. These can also be specified in the
+link:../frontmatter/[YAML Front Matter].
+
+|`page.tags` |The list of tags to which this post belongs. These can be
+specified in the link:../frontmatter/[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 link:../frontmatter/[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.
+|=======================================================================
+
+[TIP]
+====
+Use Custom Front Matter
+
+Any custom front matter that you specify will be available under `page`.
+For example, if you specify `custom_css: true` in a pages front matter,
+that value will be available as `page.custom_css`.
+
+If you specify front matter in a layout, access that via `layout`. For
+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="4,8",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>`.
+
+

data/lib/starter_web/pages/start/kickstarter/web_in_a_day/100_introduction.adoc

@@ -0,0 +1,169 @@
+---
+title:                                  Introduction
+tagline:                                Your Web in a Day
+description:                            Modern Jekyll Web site in a Day
+
+tags:                                   [ Kickstarter, Introduction, Web, Day, Jekyll ]
+category:
+resources:                              [ lightbox, carousel ]
+permalink:                              /pages/start/kickstarter/web_in_a_day/intro/
+regenerate:                             false
+
+resource_options:
+
+  - toccer:
+      collapseDepth:                    2
+---
+
+// Enable the Liquid Preprocessor
+//
+:page-liquid:
+
+// Set other global page attributes here
+// -------------------------------------------------------------------
+
+{% comment %} Liquid procedures
+--------------------------------------------------------------- {% endcomment %}
+{% capture set_env_entry_document %}themes/{{site.template.name}}/procedures/global/set_env_entry_document.proc{%endcapture%}
+
+
+// NOTE: Initialize entry document paths
+//
+{% include {{set_env_entry_document}} init_folders=all %}
+
+// Load tags and urls
+//
+include::{includedir}/attributes.asciidoc[tag=tags]
+include::{includedir}/attributes.asciidoc[tag=urls]
+
+// Additional Asciidoc page attributes goes here
+//
+
+
+*J1 Web in a Day* is the first in a series of tutorials to learn how to
+create modern web sites using Jekyll. This Kickstart focuses on the basics
+of Jekyll and J1 Template which all people needs to know for a successful way
+to Jekyll.
+
+It is highly recommended to read and work on this tutorial by everyone - independly
+from what level of knowledge they begin. Jekyll is different in compare to
+classic Content Management Systems (CMS) like Joomla, Wordpress or Drupal.
+No surprise: J1 Template is different as well.
+
+To not waste time, get through the turorial and find out what is the *Jekyll Way*.
+And if this the way you want to go.
+
+Have a good time, a good day learning Jekyll.
+
+== Web in a Day
+
+It sounds much, spending a whole day to get Jekyll to know - yes, it is much.
+You'll find a lot of Blog articles like *Jekyll in 15 minutes*. But what can
+be *learned* in 15 minutes?
+
+To be fair, most of these blogs are intended to help *installing Jekyll* and
+get the very first steps managed. If you run Jekyll out of the box, the resulting
+web site (from the build-in theme scaffold) might somewhat disillusioned. You'll
+get a very simple site created based on Jekyll's theme *minima*.
+
+And it is what the name of theme suggets.
+
+.Web site based on Jekyll's Theme minima
+lightbox::pages/kickstarter/web_in_a_day/jekyll-minima-theme.png[ 700, {theme-minima-data} ]
+
+For good reasons, the default theme for a base Jekyll installation is minima.
+Jekyll is the core engine to create Webs but not a tool set to design a site.
+Not that much different to the CMS mentioned earlier as they provide very
+basic templates from a base installation as well.
+
+To have fun exploring Jekyll a whole day, a template is needed that give a good
+impression what can Jekyll do and what you can expect what is achiveable by an
+engine creating so-called static web sites.
+
+.J1 Theme Uno
+lightbox::theme-uno[ 700, {theme-uno-data} ]
+
+lorem:sentences[5]
+lorem:sentences[2]
+
+=== J1 QuickStart
+
+For a better start, J1 QuickStart can be used to install all the software
+components needed for Jekyll on Windows. It's done in *15 minutes*. And
+J1 Template pre-configured for your one-day-journey to Jekyll as well.
+
+.J1 Quickstart for Windows
+lightbox::quickstart-windows[ 700, {quickstart-windows-data} ]
+
+
+[TIP]
+====
+If have'nt done already, you can download the J1 QuickStart package from
+the {quickstart-download}[J1 download page]. J1 QuickStart for Windows supports
+all modern Windows versions from Windows 7 and above.
+
+QuickStart versions for *Linux* and *MacOS* are being developed but not
+available, yet.
+
+For the time being, MacOS users can use e.g. {homebrew-home-en}[Homebrew]
+as a package manager to install OpenSource software on Apple PC's. Install and
+brew the current versions of Ruby and Python needed to run the latest version
+of Jekyll (at the time of writing version 3.3.0) and you'done.
+
+Linux users, a current Linux distribution assumed, can use J1 Template out of
+the box. Follow the installation instructions from the {quickstart-download}[J1 download page]
+described with chapter *Install J1 Template only* and you're done.
+====
+
+====  Install J1 QuickStart
+
+lorem:sentences[5]
+lorem:sentences[2]
+
+++++
+  <div id="quickstart-setup-oneslide" class="owl-carousel margin-bottom-20"></div>
+++++
+
+lorem:sentences[2]
+
+====  Initialize J1 environment
+
+lorem:sentences[5]
+
+++++
+  <div id="quickstart-initialize-oneslide" class="owl-carousel margin-bottom-20"></div>
+++++
+
+lorem:sentences[5]
+
+lorem:sentences[4]
+
+=== J1 Page Layout
+
+lorem:sentences[5]
+
+.J1 Page Layout
+lightbox::theme-uno[ 700, {j1-page-layout-data} ]
+
+=== Layout Inheritance
+
+lorem:sentences[5]
+
+.Layout Inheritance
+lightbox::layout-inheritance[ 700, {layout-inheritance-data} ]
+
+=== Content Inheritance
+
+lorem:sentences[7]
+
+.Content Inheritance
+lightbox::content-inheritance[ 700, {content-inheritance-data} ]
+
+=== Lane Inheritance
+
+lorem:sentences[5]
+
+.J1 Lane Inheritance
+lightbox::lane-inheritance[ 700, {lane-inheritance-data} ]
+
+lorem:sentences[3]