j1-template 2023.7.0 → 2023.8.0
Sign up to get free protection for your applications and to get access to all the features.
- checksums.yaml +4 -4
- data/_includes/themes/j1/modules/searcher/procedures/topsearch.proc +2 -1
- data/_includes/themes/j1/procedures/global/create_bs_button.proc +0 -1
- data/_includes/themes/j1/procedures/global/create_word_cloud.proc +3 -2
- data/_includes/themes/j1/procedures/global/date-german.proc +2 -7
- data/_includes/themes/j1/procedures/global/get_category.proc +13 -19
- data/_includes/themes/j1/procedures/global/get_category_item.proc +29 -33
- data/_includes/themes/j1/procedures/global/get_documents_dir.proc +8 -8
- data/_includes/themes/j1/procedures/global/get_page_url.proc +9 -14
- data/_includes/themes/j1/procedures/global/select_color.proc +12 -17
- data/_includes/themes/j1/procedures/global/select_font_size.proc +31 -35
- data/_includes/themes/j1/procedures/global/select_icon_size.proc +38 -40
- data/_includes/themes/j1/procedures/global/select_location.proc +56 -59
- data/_includes/themes/j1/procedures/global/set_base_vars_folders.proc +2 -4
- data/_includes/themes/j1/procedures/global/set_image_block.proc +4 -2
- data/_includes/themes/j1/procedures/global/setup.proc +8 -3
- data/assets/data/masonry.html +13 -13
- data/assets/themes/j1/adapter/js/masterslider.js +2 -1
- data/assets/themes/j1/adapter/js/slick.js +13 -10
- data/assets/themes/j1/core/css/themes/unolight/bootstrap.css +70 -0
- data/assets/themes/j1/core/css/themes/unolight/bootstrap.min.css +1 -1
- data/assets/themes/j1/core/js/template.js +1339 -3
- data/assets/themes/j1/core/js/template.min.js +7 -7
- data/assets/themes/j1/core/js/template.min.js.map +1 -1
- data/assets/themes/j1/modules/carousel/css/theme/uno.css +5 -0
- data/assets/themes/j1/modules/carousel/css/theme/uno.min.css +1 -1
- data/assets/themes/j1/modules/masonry/css/theme/readme +1 -0
- data/assets/themes/j1/modules/masterslider/css/theme/uno.css +2 -3
- data/assets/themes/j1/modules/masterslider/css/theme/uno.min.css +1 -1
- data/assets/themes/j1/modules/slick/lightbox/css/theme/uno.css +13 -2
- data/assets/themes/j1/modules/slick/lightbox/css/theme/uno.min.css +1 -1
- data/assets/themes/j1/modules/slick/lightbox/js/slick-lightbox.js +373 -347
- data/assets/themes/j1/modules/slick/slider/css/theme/uno.css +20 -51
- data/assets/themes/j1/modules/slick/slider/css/theme/uno.min.css +2 -2
- data/lib/j1/version.rb +1 -1
- data/lib/starter_web/Gemfile +2 -2
- data/lib/starter_web/README.md +5 -5
- data/lib/starter_web/_config.yml +1 -1
- data/lib/starter_web/_data/blocks/banner.yml +8 -9
- data/lib/starter_web/_data/blocks/footer.yml +3 -3
- data/lib/starter_web/_data/modules/masonry.yml +9 -1
- data/lib/starter_web/_data/modules/masterslider.yml +69 -116
- data/lib/starter_web/_data/modules/navigator_menu.yml +58 -51
- data/lib/starter_web/_data/resources.yml +3 -3
- data/lib/starter_web/_data/templates/feed.xml +1 -1
- data/lib/starter_web/_includes/attributes.asciidoc +1 -0
- data/lib/starter_web/_plugins/asciidoctor/callout.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/masterslider-block.rb +1 -1
- data/lib/starter_web/_plugins/asciidoctor/slick-block.rb +1 -1
- data/lib/starter_web/_plugins/index/lunr.rb +1 -1
- data/lib/starter_web/assets/images/collections/books/biography/a_life_in_questions.jpg +0 -0
- data/lib/starter_web/collections/posts/public/featured/_posts/0000-00-00-welcome-to-j1.adoc.erb +5 -5
- data/lib/starter_web/index.html +6 -6
- data/lib/starter_web/package.json +1 -1
- data/lib/starter_web/pages/public/blog/navigator/archive/categoryview.html +0 -1
- data/lib/starter_web/pages/public/tools/previewer/preview_bootstrap_theme.adoc +148 -140
- data/lib/starter_web/utilsrv/_defaults/package.json +1 -1
- data/lib/starter_web/utilsrv/package.json +1 -1
- metadata +3 -75
- data/assets/themes/j1/modules/carousel/js/carousel.js +0 -1517
- data/assets/themes/j1/modules/carousel/js/carousel.min.js +0 -57
- data/assets/themes/j1/modules/masonry/css/theme/uno.css +0 -35
- data/assets/themes/j1/modules/masonry/css/theme/uno.min.css +0 -15
- data/assets/themes/j1/modules/speak2me/LICENSE +0 -21
- data/assets/themes/j1/modules/speak2me/js/speak2me.js +0 -947
- data/assets/themes/j1/modules/speak2me/js/speak2me.min.js +0 -26
- data/lib/starter_web/_data/modules/buymeacoffee.yml +0 -30
- data/lib/starter_web/_data/modules/defaults/buymeacoffee.yml +0 -30
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-restaurant-140x80.jpg +0 -0
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-restaurant.jpg +0 -0
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-single-man-140x80.jpg +0 -0
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-single-man.jpg +0 -0
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-single-woman-140x80.jpg +0 -0
- data/lib/starter_web/assets/images/modules/masterslider/slider_5/ms-free-food-single-woman.jpg +0 -0
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/attributes.asciidoc +0 -58
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/accordion.asciidoc +0 -34
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/alerts.asciidoc +0 -15
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/badges.asciidoc +0 -9
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/body.asciidoc +0 -14
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/breadcrumbs.asciidoc +0 -14
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/buttons.asciidoc +0 -75
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/cards.asciidoc +0 -22
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/carousel.asciidoc +0 -37
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/close.asciidoc +0 -15
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/code.asciidoc +0 -14
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/color_system.asciidoc +0 -353
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/components.asciidoc +0 -69
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/dropdowns.asciidoc +0 -53
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/figures.asciidoc +0 -5
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/forms.asciidoc +0 -270
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/grid.asciidoc +0 -49
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/links.asciidoc +0 -21
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/list_groups.asciidoc +0 -28
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/modals.asciidoc +0 -43
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/navbar.asciidoc +0 -45
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/navs.asciidoc +0 -28
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/offcanvas.asciidoc +0 -16
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/options.asciidoc +0 -30
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/pagination.asciidoc +0 -40
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/paragraph.asciidoc +0 -5
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/placeholders.asciidoc +0 -5
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/popovers.asciidoc +0 -28
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/position.asciidoc +0 -8
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/progress_bars.asciidoc +0 -12
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/spacing.asciidoc +0 -14
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/spinners.asciidoc +0 -12
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/tables.asciidoc +0 -55
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/thumbnails.asciidoc +0 -9
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/toasts.asciidoc +0 -18
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/tooltips.asciidoc +0 -28
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/typography.asciidoc +0 -115
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/documents/z_index.asciidoc +0 -26
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/tables/_table.asciidoc +0 -9
- data/lib/starter_web/pages/public/learn/bs_sass_variables/_includes/tables/accordion.asciidoc +0 -87
- data/lib/starter_web/pages/public/learn/bs_sass_variables/bs_sass_variables.adoc +0 -267
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/attributes.asciidoc +0 -59
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/documents/100_chapter.asciidoc +0 -541
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/documents/200_chapter.asciidoc +0 -33
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/build_command_options.asciidoc +0 -72
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/files_and_folders.asciidoc +0 -66
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/global_configuration_options.asciidoc +0 -63
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/global_variables.asciidoc +0 -26
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/page_variables.asciidoc +0 -54
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/serve_command_options.asciidoc +0 -45
- data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/tables/site_variables.asciidoc +0 -59
- data/lib/starter_web/pages/public/learn/core_web_vitals/core_web_vitals.adoc +0 -447
- data/lib/starter_web/pages/public/learn/roundtrip/lunr_search.1.asciidoc +0 -460
- data/lib/starter_web/pages/public/manuals/speak2me.adoc +0 -412
- data/lib/starter_web/pages/public/tools/cheatsheet/gem.adoc +0 -259
- data/lib/starter_web/pages/public/tools/cheatsheet/git.adoc +0 -1462
- data/lib/starter_web/pages/public/tools/cheatsheet/j1.adoc +0 -177
- data/lib/starter_web/pages/public/tools/cheatsheet/yaml.adoc +0 -522
@@ -1,59 +0,0 @@
|
|
1
|
-
// ~/document_base_folder/000_includes
|
2
|
-
// Asciidoc attribute includes: attributes.asciidoc
|
3
|
-
// -----------------------------------------------------------------------------
|
4
|
-
|
5
|
-
// URLs - Internal references and/or sources on the Internet
|
6
|
-
// -----------------------------------------------------------------------------
|
7
|
-
tag::urls[]
|
8
|
-
|
9
|
-
:url-j1--home: https://jekyll.one/
|
10
|
-
|
11
|
-
end::urls[]
|
12
|
-
|
13
|
-
|
14
|
-
// FOOTNOTES, global asciidoc attributes (variables)
|
15
|
-
// -----------------------------------------------------------------------------
|
16
|
-
tag::footnotes[]
|
17
|
-
end::footnotes[]
|
18
|
-
|
19
|
-
|
20
|
-
// Tags - Asciidoc attributes used internally
|
21
|
-
// -----------------------------------------------------------------------------
|
22
|
-
tag::tags[]
|
23
|
-
end::tags[]
|
24
|
-
|
25
|
-
|
26
|
-
// Data - Data elements for Asciidoctor extensions
|
27
|
-
// -----------------------------------------------------------------------------
|
28
|
-
tag::data[]
|
29
|
-
|
30
|
-
:data-image--core_web_vitals_best: "assets/images/pages/core_web_vitals/core_web_vitals_best.jpg, Excellent performance values (Lighthouse)"
|
31
|
-
:data-image--core_web_vitals_best_full: "assets/images/pages/core_web_vitals/core_web_vitals_best_full.jpg, Excellent performance values (Lighthouse)"
|
32
|
-
|
33
|
-
end::data[]
|
34
|
-
|
35
|
-
|
36
|
-
// Images - Images from local include/images folder
|
37
|
-
// -----------------------------------------------------------------------------
|
38
|
-
tag::images[]
|
39
|
-
end::images[]
|
40
|
-
|
41
|
-
|
42
|
-
// PRODUCTS, local product information (e.g. release)
|
43
|
-
// -----------------------------------------------------------------------------
|
44
|
-
tag::products
|
45
|
-
|
46
|
-
:license: e.g. Apache License, Version 2.0
|
47
|
-
:revdate: e.g. 2018
|
48
|
-
:revnumber: e.g. 1.2.3
|
49
|
-
|
50
|
-
end::products[]
|
51
|
-
|
52
|
-
|
53
|
-
// AUTHORS, local author information (e.g. article)
|
54
|
-
// -----------------------------------------------------------------------------
|
55
|
-
tag::authors[]
|
56
|
-
|
57
|
-
:uri-author-xxx: https://xxx
|
58
|
-
|
59
|
-
end::authors[]
|
data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/documents/100_chapter.asciidoc
DELETED
@@ -1,541 +0,0 @@
|
|
1
|
-
== Configuration
|
2
|
-
|
3
|
-
Jekyll allows you to configure your sites in any way you can dream up, and it’s
|
4
|
-
thanks to the powerful and flexible configuration options that this is possible.
|
5
|
-
|
6
|
-
These options can either be specified in a `_config.yml` file placed in your
|
7
|
-
site’s root directory, or can be specified as flags for the `jekyll` executable
|
8
|
-
on command-line.
|
9
|
-
|
10
|
-
=== Global Configuration
|
11
|
-
|
12
|
-
The table below lists the available settings for Jekyll, and the various
|
13
|
-
`options` (specified in the configuration file) and `flags` (specified on the
|
14
|
-
command-line) that control them.
|
15
|
-
|
16
|
-
include::../tables/global_configuration_options.asciidoc[]
|
17
|
-
|
18
|
-
[WARNING]
|
19
|
-
====
|
20
|
-
Destination folders are cleaned on site builds.
|
21
|
-
|
22
|
-
The contents of `<destination>` are automatically cleaned, by default, when
|
23
|
-
the site is built. Files or folders that are not created by your site will
|
24
|
-
be removed. Some files could be retained by specifying them within the
|
25
|
-
`<keep_files>` configuration directive.
|
26
|
-
|
27
|
-
Do not use an important location for `<destination>` instead, use it as a
|
28
|
-
staging area and copy files from there to your web server.
|
29
|
-
====
|
30
|
-
|
31
|
-
=== Build Command Options
|
32
|
-
|
33
|
-
include::../tables/build_command_options.asciidoc[]
|
34
|
-
|
35
|
-
=== Serve Command Options
|
36
|
-
|
37
|
-
In addition to the options below, the `serve` sub-command can accept any of
|
38
|
-
the options for the `build` sub-command, which are then applied to the site
|
39
|
-
build which occurs right before your site is served.
|
40
|
-
|
41
|
-
include::../tables/serve_command_options.asciidoc[]
|
42
|
-
|
43
|
-
[WARNING]
|
44
|
-
====
|
45
|
-
Do not use tabs in configuration files.
|
46
|
-
|
47
|
-
This will either lead to parsing errors, or Jekyll will revert to the
|
48
|
-
default settings. Use spaces instead.
|
49
|
-
====
|
50
|
-
|
51
|
-
=== Custom WEBrick Headers
|
52
|
-
|
53
|
-
The Jekyll `serve` command enables an internal Web server - `WEBrick` - to
|
54
|
-
serve your site without the need of an external Webserver (like Apache or Nginx).
|
55
|
-
To control the internal server, you can provide custom headers for your site
|
56
|
-
by adding them to `_config.yml`
|
57
|
-
|
58
|
-
[source, yaml]
|
59
|
-
--------------
|
60
|
-
# File: _config.yml
|
61
|
-
webrick:
|
62
|
-
headers:
|
63
|
-
My-Header: My-Value
|
64
|
-
My-Other-Header: My-Other-Value
|
65
|
-
--------------
|
66
|
-
|
67
|
-
NOTE: Jekyll provide by default `Content-Type` and `Cache-Control` response
|
68
|
-
headers: one *dynamic* in order to specify the nature of the data being served,
|
69
|
-
the other *static* in order to disable caching so that you don't have to fight
|
70
|
-
with Chrome's aggressive *caching* when you are in *development mode*.
|
71
|
-
|
72
|
-
== Jekyll Environment
|
73
|
-
|
74
|
-
=== Folder structure
|
75
|
-
|
76
|
-
Jekyll is, at its core, a text transformation engine. The concept behind the
|
77
|
-
system is this: you give it text written in your favorite markup language, be
|
78
|
-
that Markdown, Textile, or just plain HTML, and it churns that through a layout
|
79
|
-
or a series of layout files. Throughout that process you can tweak how you want
|
80
|
-
the site URLs to look, what data gets displayed in the layout, and more. This
|
81
|
-
is all done through editing text files; the static web site is the final
|
82
|
-
product.
|
83
|
-
|
84
|
-
A basic Jekyll site usually looks something like this:
|
85
|
-
|
86
|
-
[source, sh]
|
87
|
-
----
|
88
|
-
.
|
89
|
-
├── _config.yml
|
90
|
-
├── _drafts
|
91
|
-
| ├── begin-with-the-crazy-ideas.textile
|
92
|
-
| └── on-simplicity-in-technology.markdown
|
93
|
-
├── _includes
|
94
|
-
| ├── footer.html
|
95
|
-
| └── header.html
|
96
|
-
├── _layouts
|
97
|
-
| ├── default.html
|
98
|
-
| └── post.html
|
99
|
-
├── _posts
|
100
|
-
| ├── 2007-10-29-why-every-programmer-should-play-nethack.textile
|
101
|
-
| └── 2009-04-26-barcamp-boston-4-roundup.textile
|
102
|
-
├── _data
|
103
|
-
| └── members.yml
|
104
|
-
├── _site
|
105
|
-
├── .jekyll-metadata
|
106
|
-
└── index.html
|
107
|
-
----
|
108
|
-
|
109
|
-
=== Files and Folders
|
110
|
-
|
111
|
-
An overview of what each of these does:
|
112
|
-
|
113
|
-
include::../tables/files_and_folders.asciidoc[]
|
114
|
-
|
115
|
-
=== Set a Jekyll environment
|
116
|
-
You can specify a Jekyll environment at build time. In the build (or serve)
|
117
|
-
arguments, you can specify a Jekyll environment and value. The build will then
|
118
|
-
apply this value in any conditional statements in your content.
|
119
|
-
|
120
|
-
For example, suppose you set this conditional statement in your code:
|
121
|
-
|
122
|
-
[source, liquid]
|
123
|
-
--------------
|
124
|
-
{% raw %}
|
125
|
-
{% if jekyll.environment === "production" %}
|
126
|
-
{% include disqus.html %}
|
127
|
-
{% endif %}
|
128
|
-
{% endraw %}
|
129
|
-
--------------
|
130
|
-
|
131
|
-
When you build your Jekyll site, the content inside the `if` statement won't
|
132
|
-
be run unless you also specify a `production` environment in the build
|
133
|
-
command, like this:
|
134
|
-
|
135
|
-
[source, sh]
|
136
|
-
--------------
|
137
|
-
JEKYLL_ENV=production jekyll build
|
138
|
-
--------------
|
139
|
-
|
140
|
-
Specifying an environment value allows you to make certain content available
|
141
|
-
only within specific environments.
|
142
|
-
|
143
|
-
The default value for `JEKYLL_ENV` is `development`. Therefore if you
|
144
|
-
omit `JEKYLL_ENV` from the build arguments, the default value will be
|
145
|
-
`JEKYLL_ENV=development`. Any content inside
|
146
|
-
|
147
|
-
[source, liquid]
|
148
|
-
--------------
|
149
|
-
{% if jekyll.environment == "development" %}
|
150
|
-
--------------
|
151
|
-
|
152
|
-
tags will automatically appear in the build.
|
153
|
-
|
154
|
-
Your environment values can be anything you want (not just `development` or
|
155
|
-
`production`). Some elements you might want to hide in development environments
|
156
|
-
include Disqus comment forms or Google Analytics. Conversely, you might want
|
157
|
-
to expose an "Edit me in GitHub" button in a development environment but not
|
158
|
-
include it in production environments.
|
159
|
-
|
160
|
-
By specifying the option in the build command, you avoid having to change
|
161
|
-
values in your configuration files when moving from one environment to another.
|
162
|
-
|
163
|
-
=== Front Matter defaults
|
164
|
-
|
165
|
-
Using YAML Front Matter is one way that you can specify configuration in the
|
166
|
-
pages and posts for your site. Setting things like a default layout, or
|
167
|
-
customizing the title, or specifying a more precise date/time for the post
|
168
|
-
can all be added to your page or post front matter.
|
169
|
-
|
170
|
-
Often times, you will find that you are repeating a lot of configuration
|
171
|
-
options. Setting the same layout in each file, adding the same
|
172
|
-
category - or categories - to a post, etc. You can even add custom variables
|
173
|
-
like author names, which might be the same for the majority of posts on
|
174
|
-
your blog.
|
175
|
-
|
176
|
-
Instead of repeating this configuration each time you create a new post or
|
177
|
-
page, Jekyll provides a way to set these defaults in the site configuration.
|
178
|
-
To do this, you can specify site-wide defaults using the `defaults` key in
|
179
|
-
the `_config.yml` file in your project's root directory.
|
180
|
-
|
181
|
-
The `defaults` key holds an array of scope/values pairs that define what
|
182
|
-
defaults should be set for a particular file path, and optionally, a file
|
183
|
-
type in that path.
|
184
|
-
|
185
|
-
Let's say that you want to add a default layout to all pages and posts in
|
186
|
-
your site. You would add this to your `_config.yml` file:
|
187
|
-
|
188
|
-
[source, yaml]
|
189
|
-
--------------
|
190
|
-
defaults:
|
191
|
-
- scope:
|
192
|
-
path: "" # an empty string here means all files in the project
|
193
|
-
values:
|
194
|
-
layout: "default"
|
195
|
-
--------------
|
196
|
-
|
197
|
-
[NOTE]
|
198
|
-
====
|
199
|
-
Please stop and rerun `jekyll serve` command.
|
200
|
-
|
201
|
-
The `_config.yml` master configuration file contains global
|
202
|
-
configurations and variable definitions that are read once at execution time.
|
203
|
-
Changes made to `_config.yml` during automatic regeneration
|
204
|
-
are not loaded until the next execution.
|
205
|
-
|
206
|
-
Note `Data Files` are included and reloaded during automatic regeneration.
|
207
|
-
|
208
|
-
====
|
209
|
-
|
210
|
-
Here, we are scoping the `values` to any file that exists in the path `scope`.
|
211
|
-
Since the path is set as an empty string, it will apply to **all files** in
|
212
|
-
your project. You probably don't want to set a layout on every file in your
|
213
|
-
project - like css files, for example - so you can also specify a `type` value
|
214
|
-
under the `scope` key.
|
215
|
-
|
216
|
-
[source, yaml]
|
217
|
-
--------------
|
218
|
-
defaults:
|
219
|
-
- scope:
|
220
|
-
path: "" # an empty string here means all files in the project
|
221
|
-
type: "posts" # previously `post` in Jekyll 2.2.
|
222
|
-
values:
|
223
|
-
layout: "default"
|
224
|
-
--------------
|
225
|
-
|
226
|
-
Now, this will only set the layout for files where the type is `posts`.
|
227
|
-
The different types that are available to you are `pages`, `posts`, `drafts`
|
228
|
-
or any collection in your site. While `type` is optional, you must specify a
|
229
|
-
value for `path` when creating a `scope|values` pair.
|
230
|
-
|
231
|
-
As mentioned earlier, you can set multiple scope/values pairs for `defaults`.
|
232
|
-
|
233
|
-
[source, yaml]
|
234
|
-
--------------
|
235
|
-
defaults:
|
236
|
-
- scope:
|
237
|
-
path: ""
|
238
|
-
type: "posts"
|
239
|
-
values:
|
240
|
-
layout: "my-site"
|
241
|
-
|
242
|
-
- scope:
|
243
|
-
path: "projects"
|
244
|
-
type: "pages" # previously `page` in Jekyll 2.2.
|
245
|
-
values:
|
246
|
-
layout: "project" # overrides previous default layout
|
247
|
-
author: "Mr. Hyde"
|
248
|
-
--------------
|
249
|
-
|
250
|
-
With these defaults, all posts would use the `my-site` layout. Any html files
|
251
|
-
that exist in the `projects/` folder will use the `project` layout, if it
|
252
|
-
exists. Those files will also have the `page.author` liquid variable
|
253
|
-
set to `Mr. Hyde`.
|
254
|
-
|
255
|
-
[source, yaml]
|
256
|
-
--------------
|
257
|
-
collections:
|
258
|
-
- my_collection:
|
259
|
-
output: true
|
260
|
-
|
261
|
-
defaults:
|
262
|
-
- scope:
|
263
|
-
path: ""
|
264
|
-
type: "my_collection" # a collection in your site, in plural form
|
265
|
-
values:
|
266
|
-
layout: "default"
|
267
|
-
--------------
|
268
|
-
|
269
|
-
In this example, the `layout` is set to `default` inside the collection with
|
270
|
-
the name `my_collection`.
|
271
|
-
|
272
|
-
==== Precedence
|
273
|
-
|
274
|
-
Jekyll will apply all of the configuration settings you specify in the
|
275
|
-
`defaults` section of your `_config.yml` file. However, you can choose
|
276
|
-
to override settings from other scope/values pair by specifying a more specific
|
277
|
-
path for the scope.
|
278
|
-
|
279
|
-
You can see that in the second to last example above. First, we set the default
|
280
|
-
layout to `my-site`. Then, using a more specific path, we set the default
|
281
|
-
layout for files in the `projects/` path to `project`. This can be done with
|
282
|
-
any value that you would set in the page or post front matter.
|
283
|
-
|
284
|
-
Finally, if you set defaults in the site configuration by adding a `defaults`
|
285
|
-
section to your `_config.yml` file, you can override those settings in a
|
286
|
-
post or page file. All you need to do is specify the settings in the post or
|
287
|
-
page front matter.
|
288
|
-
|
289
|
-
For example:
|
290
|
-
|
291
|
-
[source, yaml]
|
292
|
-
--------------
|
293
|
-
# In _config.yml
|
294
|
-
...
|
295
|
-
defaults:
|
296
|
-
- scope:
|
297
|
-
path: "projects"
|
298
|
-
type: "pages"
|
299
|
-
values:
|
300
|
-
layout: "project"
|
301
|
-
author: "Mr. Hyde"
|
302
|
-
category: "project"
|
303
|
-
...
|
304
|
-
--------------
|
305
|
-
|
306
|
-
[source, yaml]
|
307
|
-
--------------
|
308
|
-
# In projects/foo_project.md
|
309
|
-
---
|
310
|
-
author: "John Smith"
|
311
|
-
layout: "foobar"
|
312
|
-
---
|
313
|
-
The post text goes here...
|
314
|
-
--------------
|
315
|
-
|
316
|
-
The `projects/foo_project.md` would have the `layout` set to `foobar`
|
317
|
-
instead of `project` and the `author` set to `John Smith` instead of `Mr. Hyde`
|
318
|
-
when the site is built.
|
319
|
-
|
320
|
-
=== Default Configuration
|
321
|
-
|
322
|
-
Jekyll runs with the following configuration options by default. Alternative
|
323
|
-
settings for these options can be explicitly specified in the configuration
|
324
|
-
file or on the command-line.
|
325
|
-
|
326
|
-
[WARNING]
|
327
|
-
====
|
328
|
-
There are two unsupported kramdown options.
|
329
|
-
|
330
|
-
Please note that both `remove_block_html_tags` and
|
331
|
-
`remove_span_html_tags` are currently *unsupported*
|
332
|
-
in Jekyll due to the fact that they are not included within the kramdown
|
333
|
-
HTML converter.
|
334
|
-
====
|
335
|
-
|
336
|
-
[source, yaml]
|
337
|
-
--------------
|
338
|
-
# Where things are
|
339
|
-
#
|
340
|
-
source: .
|
341
|
-
destination: ./_site
|
342
|
-
plugins_dir: _plugins
|
343
|
-
layouts_dir: _layouts
|
344
|
-
data_dir: _data
|
345
|
-
includes_dir: _includes
|
346
|
-
collections:
|
347
|
-
posts:
|
348
|
-
output: true
|
349
|
-
|
350
|
-
# Handling Reading
|
351
|
-
#
|
352
|
-
safe: false
|
353
|
-
include: [".htaccess"]
|
354
|
-
exclude: []
|
355
|
-
keep_files: [".git", ".svn"]
|
356
|
-
encoding: "utf-8"
|
357
|
-
markdown_ext: "markdown,mkdown,mkdn,mkd,md"
|
358
|
-
|
359
|
-
# Filtering Content
|
360
|
-
#
|
361
|
-
show_drafts: null
|
362
|
-
limit_posts: 0
|
363
|
-
future: false
|
364
|
-
unpublished: false
|
365
|
-
|
366
|
-
# Plugins
|
367
|
-
#
|
368
|
-
whitelist: []
|
369
|
-
gems: []
|
370
|
-
|
371
|
-
# Conversion
|
372
|
-
#
|
373
|
-
markdown: kramdown
|
374
|
-
highlighter: rouge
|
375
|
-
lsi: false
|
376
|
-
excerpt_separator: "\n\n"
|
377
|
-
incremental: false
|
378
|
-
|
379
|
-
# Serving
|
380
|
-
#
|
381
|
-
detach: false
|
382
|
-
port: 4000
|
383
|
-
host: 127.0.0.1
|
384
|
-
baseurl: "" # does not include hostname
|
385
|
-
show_dir_listing: false
|
386
|
-
|
387
|
-
# Outputting
|
388
|
-
#
|
389
|
-
permalink: date
|
390
|
-
paginate_path: /page:num
|
391
|
-
timezone: null
|
392
|
-
|
393
|
-
quiet: false
|
394
|
-
verbose: false
|
395
|
-
defaults: []
|
396
|
-
|
397
|
-
liquid:
|
398
|
-
error_mode: warn
|
399
|
-
|
400
|
-
# Markdown Processors
|
401
|
-
#
|
402
|
-
rdiscount:
|
403
|
-
extensions: []
|
404
|
-
|
405
|
-
redcarpet:
|
406
|
-
extensions: []
|
407
|
-
|
408
|
-
kramdown:
|
409
|
-
auto_ids: true
|
410
|
-
footnote_nr: 1
|
411
|
-
entity_output: as_char
|
412
|
-
toc_levels: 1..6
|
413
|
-
smart_quotes: lsquo,rsquo,ldquo,rdquo
|
414
|
-
input: GFM
|
415
|
-
hard_wrap: false
|
416
|
-
footnote_nr: 1
|
417
|
-
--------------
|
418
|
-
|
419
|
-
=== Liquid Options
|
420
|
-
|
421
|
-
Liquid's response to errors can be configured by setting `error_mode`.
|
422
|
-
The options are
|
423
|
-
|
424
|
-
- `lax` --- Ignore all errors.
|
425
|
-
- `warn` --- Output a warning on the console for each error.
|
426
|
-
- `strict` --- Output an error message and stop the build.
|
427
|
-
|
428
|
-
=== Markdown Options
|
429
|
-
|
430
|
-
The various Markdown renderers supported by Jekyll sometimes have extra options
|
431
|
-
available.
|
432
|
-
|
433
|
-
==== Redcarpet
|
434
|
-
|
435
|
-
Redcarpet can be configured by providing an `extensions` sub-setting, whose
|
436
|
-
value should be an array of strings. Each string should be the name of one of
|
437
|
-
the `Redcarpet::Markdown` class's extensions; if present in the array, it will
|
438
|
-
set the corresponding extension to `true`.
|
439
|
-
|
440
|
-
Jekyll handles two special Redcarpet extensions:
|
441
|
-
|
442
|
-
- `no_fenced_code_blocks` --- By default, Jekyll sets the
|
443
|
-
`fenced_code_blocks` extension (for delimiting code blocks with
|
444
|
-
triple tildes or triple backticks) to `true`, probably because GitHub's eager
|
445
|
-
adoption of them is starting to make them inescapable. Redcarpet's normal
|
446
|
-
`fenced_code_blocks` extension is inert when used with Jekyll;
|
447
|
-
instead, you can use this inverted version of the extension for disabling
|
448
|
-
fenced code.
|
449
|
-
|
450
|
-
Note that you can also specify a language for highlighting after the first
|
451
|
-
delimiter:
|
452
|
-
|
453
|
-
[source, ruby]
|
454
|
-
--------------
|
455
|
-
# ...ruby code
|
456
|
-
--------------
|
457
|
-
|
458
|
-
With both fenced code blocks and highlighter enabled, this will statically
|
459
|
-
highlight the code; without any syntax highlighter, it will add a
|
460
|
-
`class="LANGUAGE"` attribute to the `<code>` element, which can be used as a
|
461
|
-
hint by various JavaScript code highlighting libraries.
|
462
|
-
|
463
|
-
- `smart` --- This pseudo-extension turns on SmartyPants, which converts
|
464
|
-
straight quotes to curly quotes and runs of hyphens to em (`---`) and en (`--`) dashes.
|
465
|
-
|
466
|
-
All other extensions retain their usual names from Redcarpet, and no renderer
|
467
|
-
options aside from `smart` can be specified in Jekyll. [A list of available
|
468
|
-
extensions can be found in the Redcarpet README file.][redcarpet_extensions]
|
469
|
-
Make sure you're looking at the README for the right version of
|
470
|
-
Redcarpet: Jekyll currently uses v3.2.x. The most commonly used
|
471
|
-
extensions are:
|
472
|
-
|
473
|
-
- `tables`
|
474
|
-
- `no_intra_emphasis`
|
475
|
-
- `autolink`
|
476
|
-
|
477
|
-
[redcarpet_extensions]: https://github.com/vmg/redcarpet/blob/v3.2.2/README.markdown#and-its-like-really-simple-to-use
|
478
|
-
|
479
|
-
### Custom Markdown Processors
|
480
|
-
|
481
|
-
If you're interested in creating a custom markdown processor, you're in luck! Create a new class in the `Jekyll::Converters::Markdown` namespace:
|
482
|
-
|
483
|
-
[source, ruby]
|
484
|
-
--------------
|
485
|
-
class Jekyll::Converters::Markdown::MyCustomProcessor
|
486
|
-
def initialize(config)
|
487
|
-
require 'funky_markdown'
|
488
|
-
@config = config
|
489
|
-
rescue LoadError
|
490
|
-
STDERR.puts 'You are missing a library required for Markdown. Please run:'
|
491
|
-
STDERR.puts ' $ [sudo] gem install funky_markdown'
|
492
|
-
raise FatalException.new("Missing dependency: funky_markdown")
|
493
|
-
end
|
494
|
-
|
495
|
-
def convert(content)
|
496
|
-
::FunkyMarkdown.new(content).convert
|
497
|
-
end
|
498
|
-
end
|
499
|
-
--------------
|
500
|
-
|
501
|
-
Once you've created your class and have it properly set up either as a plugin
|
502
|
-
in the `_plugins` folder or as a gem, specify it in your `_config.yml`:
|
503
|
-
|
504
|
-
[source, yaml]
|
505
|
-
--------------
|
506
|
-
markdown: MyCustomProcessor
|
507
|
-
--------------
|
508
|
-
|
509
|
-
=== Incremental Regeneration
|
510
|
-
|
511
|
-
Incremental regeneration helps shorten build times by only generating documents
|
512
|
-
and pages that were updated since the previous build. It does this by keeping
|
513
|
-
track of both file modification times and inter-document dependencies in the
|
514
|
-
`.jekyll-metadata` file.
|
515
|
-
|
516
|
-
[WARNING]
|
517
|
-
====
|
518
|
-
Incremental regeneration is still an experimental feature.
|
519
|
-
|
520
|
-
While incremental regeneration will work for the most common cases, it will
|
521
|
-
not work correctly in every scenario. Please be extremely cautious when
|
522
|
-
using the feature, and report any problems not listed below by
|
523
|
-
{uri-jekyll-submit-issue}[opening an issue on GitHub].
|
524
|
-
====
|
525
|
-
|
526
|
-
Under the current implementation, incremental regeneration will only generate a
|
527
|
-
document or page if either it, or one of its dependencies, is modified.
|
528
|
-
Currently, the only types of dependencies tracked are includes (using the
|
529
|
-
`{% include %}` tag) and layouts. This means that plain references to other
|
530
|
-
documents (for example, the common case of iterating over `site.posts` in a
|
531
|
-
post listings page) will not be detected as a dependency.
|
532
|
-
|
533
|
-
To remedy some of these shortfalls, putting `regenerate: true` in the
|
534
|
-
front-matter of a document will force Jekyll to regenerate it regardless of
|
535
|
-
whether it has been modified. Note that this will generate the specified
|
536
|
-
document only; references to other documents' contents will not work since
|
537
|
-
they won't be re-rendered.
|
538
|
-
|
539
|
-
Incremental regeneration can be enabled via the `--incremental` flag (`-i` for
|
540
|
-
short) from the command-line or by setting `incremental: true` in your
|
541
|
-
configuration file.
|
data/lib/starter_web/pages/public/learn/core_web_vitals/_includes/documents/200_chapter.asciidoc
DELETED
@@ -1,33 +0,0 @@
|
|
1
|
-
== Jekyll Variables
|
2
|
-
|
3
|
-
Jekyll traverses your site looking for files to process. Any files with `YAML
|
4
|
-
front matter` are subject to processing. For each of these files, Jekyll makes
|
5
|
-
a variety of data available via the `Liquid templating system`.
|
6
|
-
|
7
|
-
The following is a reference of the available data.
|
8
|
-
|
9
|
-
=== Global Variables
|
10
|
-
|
11
|
-
include::../tables/global_variables.asciidoc[]
|
12
|
-
|
13
|
-
=== Site Variables
|
14
|
-
|
15
|
-
include::../tables/site_variables.asciidoc[]
|
16
|
-
|
17
|
-
=== Page Variables
|
18
|
-
|
19
|
-
include::../tables/page_variables.asciidoc[]
|
20
|
-
|
21
|
-
[TIP]
|
22
|
-
====
|
23
|
-
Use Custom Front Matter
|
24
|
-
|
25
|
-
Any custom front matter that you specify will be available under `page`.
|
26
|
-
For example, if you specify `custom_css: true` in a pages front matter,
|
27
|
-
that value will be available as `page.custom_css`.
|
28
|
-
|
29
|
-
If you specify front matter in a layout, access that via `layout`. For
|
30
|
-
example, if you specify `class: full_page` in a pages front matter,
|
31
|
-
that value will be available as `layout.class` in the layout and its
|
32
|
-
parents.
|
33
|
-
====
|
@@ -1,72 +0,0 @@
|
|
1
|
-
|
2
|
-
.Build Command Options
|
3
|
-
[cols="2a,2a,2a,6a", width="100%", options="header", role="rtable mt-4"]
|
4
|
-
|===
|
5
|
-
|Setting |Option |Flag |Description
|
6
|
-
|
7
|
-
|*Regeneration*
|
8
|
-
|`na`
|
9
|
-
|`-w, --[no-]watch`
|
10
|
-
|Enable auto-regeneration of the site when files are modified.
|
11
|
-
|
12
|
-
|*Configuration*
|
13
|
-
|`na`
|
14
|
-
|`--config FILE1 [,FILE2, ..]`
|
15
|
-
|Specify config files instead of using `_config.yml` automatically.
|
16
|
-
Settings in later files override settings in earlier files.
|
17
|
-
|
18
|
-
|*Drafts*
|
19
|
-
|`show_drafts: BOOL`
|
20
|
-
|`--drafts`
|
21
|
-
|Process and render draft posts.
|
22
|
-
|
23
|
-
|*Environment*
|
24
|
-
|`na`
|
25
|
-
|`na`
|
26
|
-
|Use a specific environment value `JEKYLL_ENV=production` in the build.
|
27
|
-
|
28
|
-
|*Future*
|
29
|
-
|`future: BOOL`
|
30
|
-
|`--future`
|
31
|
-
|Publish posts or collection documents with a future date.
|
32
|
-
|
33
|
-
|*LSI*
|
34
|
-
|`lsi: BOOL`
|
35
|
-
|`--lsi`
|
36
|
-
|Produce an index for related posts.
|
37
|
-
|
38
|
-
|*Limit Posts*
|
39
|
-
|`limit_posts: NUM`
|
40
|
-
|`--limit_posts NUM`
|
41
|
-
|Limit the number of posts to parse and publish.
|
42
|
-
|
43
|
-
|*Force polling*
|
44
|
-
|`na`
|
45
|
-
|`--force_polling`
|
46
|
-
|Force watch to use polling.
|
47
|
-
|
48
|
-
|*Verbose output*
|
49
|
-
|`na`
|
50
|
-
|`-V, --verbose`
|
51
|
-
|Print verbose output.
|
52
|
-
|
53
|
-
|*Silence Output*
|
54
|
-
|`na`
|
55
|
-
|`-q, --quiet`
|
56
|
-
|Silence the normal output from Jekyll during a build
|
57
|
-
|
58
|
-
|*Incremental build*
|
59
|
-
|`incremental: BOOL`
|
60
|
-
|`-I, --incremental`
|
61
|
-
|Enable the experimental incremental build feature. Incremental build
|
62
|
-
only re-builds posts and pages that have changed, resulting in
|
63
|
-
significant performance improvements for large sites, but may also break
|
64
|
-
site generation in certain cases.
|
65
|
-
|
66
|
-
|*Liquid profiler*
|
67
|
-
|`profile: BOOL`
|
68
|
-
|`--profile`
|
69
|
-
|Generate a Liquid rendering profile to help you identify performance
|
70
|
-
bottlenecks.
|
71
|
-
|
72
|
-
|===
|