j1-template 2023.6.0 → 2023.7.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/layouts/content_generator_news_panel_posts.html +11 -9
- data/_includes/themes/j1/layouts/content_generator_post.html +8 -6
- data/_includes/themes/j1/procedures/global/create_word_cloud.proc +1 -1
- data/_includes/themes/j1/procedures/layouts/module_writer.proc +1 -1
- data/_includes/themes/j1/procedures/posts/collate_timeline.proc +4 -4
- data/_includes/themes/j1/procedures/posts/pager.proc +1 -1
- data/_layouts/_home.html +88 -0
- data/_layouts/home.html +1 -1
- data/assets/data/banner.html +7 -7
- data/assets/data/panel.html +37 -25
- data/assets/data/quicklinks.html +40 -30
- data/assets/data/speak2me.html +219 -0
- data/assets/data/translator.html +32 -4
- data/assets/themes/j1/adapter/js/speak2me.js +425 -0
- data/assets/themes/j1/adapter/js/translator.js +10 -2
- data/assets/themes/j1/core/css/icon-fonts/mdib.css +21 -0
- data/assets/themes/j1/core/css/icon-fonts/mdib.min.css +1 -1
- data/assets/themes/j1/core/css/themes/unodark/bootstrap.css +43 -0
- data/assets/themes/j1/core/css/themes/unodark/bootstrap.min.css +1 -1
- data/assets/themes/j1/core/css/themes/unolight/bootstrap.css +141 -1
- data/assets/themes/j1/core/css/themes/unolight/bootstrap.min.css +1 -1
- data/assets/themes/j1/core/js/template.js +1658 -0
- data/assets/themes/j1/core/js/template.min.js +11 -5
- data/assets/themes/j1/core/js/template.min.js.map +1 -1
- data/assets/themes/j1/modules/speak2me/LICENSE +21 -0
- data/assets/themes/j1/modules/speak2me/js/speak2me.js +947 -0
- data/assets/themes/j1/modules/speak2me/js/speak2me.min.js +26 -0
- data/assets/themes/j1/modules/translator/js/translator.js +30 -13
- data/assets/themes/j1/modules/translator/js/translator.min.js +1 -1
- data/lib/j1/version.rb +1 -1
- data/lib/starter_web/Gemfile +4 -4
- data/lib/starter_web/README.md +5 -5
- data/lib/starter_web/_config.yml +7 -1
- data/lib/starter_web/_data/blocks/banner.yml +7 -6
- data/lib/starter_web/_data/blocks/panel.yml +37 -39
- data/lib/starter_web/_data/layouts/home.yml +1 -1
- data/lib/starter_web/_data/modules/advertising.yml +10 -88
- data/lib/starter_web/_data/modules/buymeacoffee.yml +30 -0
- data/lib/starter_web/_data/modules/defaults/advertising.yml +3 -1
- data/lib/starter_web/_data/modules/defaults/blog_navigator.yml +97 -164
- data/lib/starter_web/_data/modules/defaults/buymeacoffee.yml +30 -0
- data/lib/starter_web/_data/modules/defaults/navigator.yml +8 -4
- data/lib/starter_web/_data/modules/defaults/speak2me.yml +72 -0
- data/lib/starter_web/_data/modules/scroller.yml +1 -1
- data/lib/starter_web/_data/modules/speak2me.yml +33 -0
- data/lib/starter_web/_data/resources.yml +24 -1
- data/lib/starter_web/_data/templates/feed.xml +1 -1
- data/lib/starter_web/_includes/google/static/{google_ad_5128488466.html → google_ad__your-slot-id.html} +1 -1
- data/lib/starter_web/_plugins/asciidoctor/callout.rb +1 -1
- data/lib/starter_web/_plugins/asciidoctor/carousel-block.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/gallery-block.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/gist-block.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/google-ad-block.rb +1 -1
- data/lib/starter_web/_plugins/asciidoctor/lightbox-block.rb +2 -7
- data/lib/starter_web/_plugins/asciidoctor/masonry-block.rb +2 -3
- data/lib/starter_web/_plugins/asciidoctor/masterslider-block.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/mdib-icon-inline.rb +43 -0
- data/lib/starter_web/_plugins/asciidoctor/mdil-icon-inline.rb +1 -1
- data/lib/starter_web/_plugins/asciidoctor/range-slider-block.rb +1 -1
- data/lib/starter_web/_plugins/asciidoctor/slick-block.rb +2 -2
- data/lib/starter_web/_plugins/asciidoctor/textbook-block.rb +1 -1
- data/lib/starter_web/_plugins/filter/liquify.rb +22 -22
- 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/assets/images/collections/books/biography/becoming.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/biography/born_to_run.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/biography/forty_autumns.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/biography/not_dead_yet.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/biography/the_princess_diarist.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/biography/when_breath_becomes_air.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/harry-potter-deathly-hallows.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/harry-potter-philosophers-stone.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/mistborn-trilogy.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/ready-player-one.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/sword-of-destiny.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/fantasy/terry-pratchet-diary.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/breath-of-snow-and-ashes.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/it-ends-with-us.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/outlander-novel.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/outlander-short-story.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/the-fiery-cross.jpg +0 -0
- data/lib/starter_web/assets/images/collections/books/romance/the_dressmaker.jpg +0 -0
- data/lib/starter_web/collections/_biography/a-life-in-questions.adoc +13 -8
- data/lib/starter_web/collections/_biography/becoming.adoc +18 -12
- data/lib/starter_web/collections/_biography/born-to-run.adoc +17 -13
- data/lib/starter_web/collections/_biography/forty-autumns.adoc +14 -9
- data/lib/starter_web/collections/_biography/not-dead-yet.adoc +12 -7
- data/lib/starter_web/collections/_biography/princess-diarist-the.adoc +13 -8
- data/lib/starter_web/collections/_biography/when-breath-becomes-air.adoc +14 -9
- data/lib/starter_web/collections/_fantasy/harry-potter-deathly-hallows.adoc +13 -7
- data/lib/starter_web/collections/_fantasy/harry-potter-philosophers-stone.adoc +12 -8
- data/lib/starter_web/collections/_fantasy/mistborn-trilogy.adoc +14 -10
- data/lib/starter_web/collections/_fantasy/ready-player-one.adoc +12 -11
- data/lib/starter_web/collections/_fantasy/sword-of-destiny.adoc +15 -7
- data/lib/starter_web/collections/_fantasy/terry-pratchet-diary.adoc +11 -6
- data/lib/starter_web/collections/_romance/breath-of-snow-and-ashes.adoc +15 -10
- data/lib/starter_web/collections/_romance/it-ends-with-us.adoc +11 -6
- data/lib/starter_web/collections/_romance/outlander-novel.adoc +11 -6
- data/lib/starter_web/collections/_romance/{virgins-outlander-short-story.adoc → outlander-virgins-short-story.adoc} +11 -6
- data/lib/starter_web/collections/_romance/{dressmaker-the.adoc → the-dressmaker.adoc} +11 -6
- data/lib/starter_web/collections/_romance/{fiery-cross-the.adoc → the-fiery-cross.adoc} +11 -6
- data/lib/starter_web/collections/posts/public/featured/_posts/0000-00-00-welcome-to-j1.adoc.erb +6 -6
- data/lib/starter_web/collections/posts/public/featured/_posts/2021-01-01-about-cookies.adoc +12 -11
- data/lib/starter_web/collections/posts/public/featured/_posts/2021-02-01-static-site-generators.adoc +9 -7
- data/lib/starter_web/collections/posts/public/featured/_posts/2022-02-01-about-j1.adoc +8 -8
- data/lib/starter_web/dot.ruby-version +1 -1
- data/lib/starter_web/index.html +10 -8
- data/lib/starter_web/package.json +1 -1
- data/lib/starter_web/pages/public/about/features.adoc +7 -1
- data/lib/starter_web/pages/public/about/reporting_issues.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/000_intro.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/100_converter.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/200_themes.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/000_intro.asciidoc +1 -1
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/112_getting_started.asciidoc +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/_includes/documents/100_converter/113_themes.asciidoc +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/documentation/documentation.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/100_chapter.asciidoc +3 -1
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/_includes/documents/200_chapter.asciidoc +1 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/multi-document/multi.adoc +2 -0
- data/lib/starter_web/pages/public/asciidoc_skeletons/simple-document/simple.adoc +6 -0
- data/lib/starter_web/pages/public/blog/navigator/archive/allview.html +6 -13
- data/lib/starter_web/pages/public/blog/navigator/archive/categoryview.html +17 -11
- data/lib/starter_web/pages/public/blog/navigator/archive/dateview.html +7 -8
- data/lib/starter_web/pages/public/blog/navigator/archive/tagview.html +5 -7
- data/lib/starter_web/pages/public/blog/navigator/index.html +15 -14
- data/lib/starter_web/pages/public/features/general.adoc +7 -1
- data/lib/starter_web/pages/public/features/template.adoc +87 -128
- data/lib/starter_web/pages/public/learn/bookshelf/article_previewer/viewer_all_books.adoc +3 -0
- data/lib/starter_web/pages/public/learn/bookshelf/article_previewer/viewer_biography.adoc +1 -1
- data/lib/starter_web/pages/public/learn/bookshelf/article_previewer/viewer_fantasy.adoc +1 -0
- data/lib/starter_web/pages/public/learn/bookshelf/article_previewer/viewer_romance.adoc +1 -1
- data/lib/starter_web/pages/public/learn/bookshelf/jekyll_collections.adoc +11 -8
- data/lib/starter_web/pages/public/learn/bs_sass_variables/bs_sass_variables.adoc +4 -0
- data/lib/starter_web/pages/public/learn/core_web_vitals/core_web_vitals.adoc +8 -4
- data/lib/starter_web/pages/public/learn/roundtrip/_includes/documents/100_gistblock.asciidoc +2 -1
- data/lib/starter_web/pages/public/learn/roundtrip/_includes/documents/themes_bootstrap.asciidoc +27 -28
- data/lib/starter_web/pages/public/learn/roundtrip/asciidoc_extensions.adoc +164 -153
- data/lib/starter_web/pages/public/learn/roundtrip/bootstrap_themes.adoc +22 -16
- data/lib/starter_web/pages/public/learn/roundtrip/highlghter_rouge.adoc +3 -2
- data/lib/starter_web/pages/public/learn/roundtrip/icon_fonts.adoc +62 -74
- data/lib/starter_web/pages/public/learn/roundtrip/lunr_search.1.asciidoc +460 -0
- data/lib/starter_web/pages/public/learn/roundtrip/lunr_search.adoc +4 -0
- data/lib/starter_web/pages/public/learn/roundtrip/modal_extentions.adoc +21 -15
- data/lib/starter_web/pages/public/learn/roundtrip/present_images.adoc +470 -449
- data/lib/starter_web/pages/public/learn/roundtrip/present_videos.adoc +53 -54
- data/lib/starter_web/pages/public/learn/roundtrip/responsive_tables.adoc +46 -34
- data/lib/starter_web/pages/public/learn/roundtrip/typography.adoc +25 -22
- data/lib/starter_web/pages/public/learn/where_to_go.adoc +6 -2
- data/lib/starter_web/pages/public/legal/en/100_copyright.adoc +4 -0
- data/lib/starter_web/pages/public/legal/en/200_impress.adoc +2 -0
- data/lib/starter_web/pages/public/legal/en/300_privacy.adoc +22 -3
- data/lib/starter_web/pages/public/legal/en/400_comment_policy.adoc +5 -0
- data/lib/starter_web/pages/public/manuals/speak2me.adoc +412 -0
- data/lib/starter_web/pages/public/panels/intro_panel/panel.adoc +27 -19
- data/lib/starter_web/pages/public/plans/plans.adoc +3 -0
- data/lib/starter_web/pages/public/tools/cheatsheet/gem.adoc +2 -0
- data/lib/starter_web/pages/public/tools/cheatsheet/git.adoc +2 -0
- data/lib/starter_web/pages/public/tools/cheatsheet/j1.adoc +2 -0
- data/lib/starter_web/pages/public/tools/cheatsheet/yaml.adoc +6 -0
- data/lib/starter_web/pages/public/tools/previewer/preview_bootstrap_theme.adoc +17 -3
- data/lib/starter_web/utilsrv/_defaults/package.json +1 -1
- data/lib/starter_web/utilsrv/package.json +1 -1
- metadata +38 -7
- data/lib/starter_web/_includes/google/static/google_ad_7284712660.html +0 -19
@@ -1,17 +1,16 @@
|
|
1
1
|
---
|
2
2
|
title: Extensions
|
3
|
-
title_extention:
|
4
|
-
tagline:
|
3
|
+
title_extention: Jekyll One enhancements for the Asciidoc markup language
|
4
|
+
tagline: Asciidoc Markup Enhancements
|
5
5
|
|
6
6
|
date: 2020-11-07
|
7
7
|
#last_modified: 2023-01-01
|
8
8
|
|
9
9
|
description: >
|
10
|
-
J1 Template implements some handy Ruby-based enhancements
|
11
|
-
|
12
|
-
|
13
|
-
|
14
|
-
Asciidoctor Extensions Lab.
|
10
|
+
J1 Template implements some handy Ruby-based enhancements
|
11
|
+
for the markup language Asciidoc. Markup extensions for
|
12
|
+
is a unique feature of Jekyll One compared to other Jekyll
|
13
|
+
themes and templates.
|
15
14
|
keywords: >
|
16
15
|
open source, free, template, jekyll, jekyllone, web,
|
17
16
|
sites, static, jamstack, bootstrap,
|
@@ -61,12 +60,13 @@ resource_options:
|
|
61
60
|
// Page content
|
62
61
|
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
63
62
|
[role="dropcap"]
|
64
|
-
J1 Template implements some handy Ruby-based enhancements for
|
65
|
-
Providing extensions for a Jekyll theme is a unique feature
|
66
|
-
compared to other Jekyll themes and templates. All already
|
67
|
-
Asciidoctor extensions you'll find below. Additional valuable
|
68
|
-
to the markup language Asciidoc is made especially for documents
|
69
|
-
Jekyll content type
|
63
|
+
J1 Template implements some handy Ruby-based enhancements for the markup
|
64
|
+
language Asciidoc. Providing extensions for a Jekyll theme is a unique feature
|
65
|
+
of Jekyll One compared to other Jekyll themes and templates. All already
|
66
|
+
implemented Asciidoctor extensions you'll find below. Additional valuable
|
67
|
+
extensions to the markup language Asciidoc is made especially for documents
|
68
|
+
of the Jekyll content type *page*, but can be used for posts or collections
|
69
|
+
as well.
|
70
70
|
|
71
71
|
TIP: Most extensions are based on well-documented examples from the
|
72
72
|
link:{url-asciidoctor--extensions-lab}[Asciidoctor Extensions Lab, {browser-window--new}].
|
@@ -74,22 +74,27 @@ To create Asciidoc extensions on your own, it is highly recommended to read the
|
|
74
74
|
link:{url-asciidoctor--extensions-manual}[extensions section, {browser-window--new}] in
|
75
75
|
the Asciidoctor user manual.
|
76
76
|
|
77
|
+
mdi:clock-time-five-outline[24px, md-gray mt-4 mr-2]
|
78
|
+
*15 Minutes* to read
|
79
|
+
|
77
80
|
// Include sub-documents (if any)
|
78
81
|
// -----------------------------------------------------------------------------
|
79
|
-
[role="mt-
|
82
|
+
[role="mt-5"]
|
80
83
|
== Asciidoc Result Extension
|
81
84
|
|
82
|
-
J1 Template adds a simple Javascript based
|
83
|
-
|
84
|
-
|
85
|
-
|
86
|
-
clicking the toggle button `VIEW` displays (or hide) the content given by the
|
87
|
-
`result block`.
|
85
|
+
J1 Template adds a simple Javascript based functionality for the
|
86
|
+
*View Result Extension* to any listing block element `listingblock`. The
|
87
|
+
extension adds an interactive toggle button `VIEW` to the output of a listing
|
88
|
+
block placed to the top right of the example box.
|
88
89
|
|
89
|
-
|
90
|
-
|
90
|
+
If a result block `[.result]` is placed under a listing block, clicking the
|
91
|
+
toggle button *view* `VIEW` displays or hide the content given by the
|
92
|
+
result block.
|
91
93
|
|
92
|
-
|
94
|
+
TIP: The *View Result Extension* is quite helpful for sections discussing
|
95
|
+
code elements.
|
96
|
+
|
97
|
+
.This example place a button *VIEW* top right of the example box
|
93
98
|
[source, no_template, role="noclip"]
|
94
99
|
----
|
95
100
|
* displayed always
|
@@ -100,12 +105,13 @@ Asciidoc code and how the resulting (HTML) code would look alike.
|
|
100
105
|
displayed till clicked, but closed on second click (toggle)
|
101
106
|
====
|
102
107
|
|
108
|
+
[role="mt-5"]
|
103
109
|
== Asciidoc Admonitions
|
104
110
|
|
105
|
-
Admonition blocks draw
|
106
|
-
|
107
|
-
|
108
|
-
|
111
|
+
Admonition blocks draw the reader to certain statements by labeling
|
112
|
+
them as priorities displayed in separate blocks. These types of information
|
113
|
+
blocks are called *admonitions*. The AsciiDoc markuplanguage provides five
|
114
|
+
block types shown by the following examples.
|
109
115
|
|
110
116
|
.Admonition labels
|
111
117
|
[cols="3a,9a", subs=+macros, options="header", width="100%", role="rtable mt-3"]
|
@@ -113,32 +119,33 @@ five admonition types represented by the following labels:
|
|
113
119
|
|Name |Description
|
114
120
|
|
115
121
|
|`NOTE`
|
116
|
-
|Additional
|
117
|
-
the
|
122
|
+
|Additional details on the currently discussed topic that may help the
|
123
|
+
reader to understand the following content better.
|
118
124
|
|
119
125
|
|`TIP`
|
120
|
-
|
|
121
|
-
|
126
|
+
|Provides facts that may help the reader *to go further* or points to
|
127
|
+
additional *options* available that can be used.
|
122
128
|
|
123
129
|
|`IMPORTANT`
|
124
|
-
|Emphasis on what is currently being discussed and facts that
|
125
|
-
be
|
126
|
-
|
127
|
-
|`CAUTION`
|
128
|
-
|Advise the reader to act carefully and point to potential tripping
|
130
|
+
|Emphasis on what is currently being discussed and provide facts that
|
131
|
+
should be remembered.
|
129
132
|
|
130
133
|
|`WARNING`
|
131
|
-
|
|
134
|
+
|instructs readers of potential danger, harm, or consequences for the
|
135
|
+
wrong usage.
|
136
|
+
|
137
|
+
|`CAUTION`
|
138
|
+
|Advise the reader to act carefully and point to potential risks or
|
139
|
+
trippings.
|
132
140
|
|
133
141
|
|===
|
134
142
|
|
135
143
|
NOTE: All colors for all default admonition blocks set to the standard
|
136
|
-
|
137
|
-
|
144
|
+
color set. Find available block types and their colors below.
|
138
145
|
|
139
146
|
When you want to call attention to a single paragraph, start the first
|
140
147
|
line of the paragraph with the label you want to use. The label must be
|
141
|
-
uppercase and followed by a colon
|
148
|
+
uppercase and followed by a colon `:`.
|
142
149
|
|
143
150
|
.Admonition paragraph syntax
|
144
151
|
[source, config]
|
@@ -160,8 +167,8 @@ The block text (multiline)
|
|
160
167
|
====
|
161
168
|
----
|
162
169
|
|
163
|
-
To add an *additional* title element on an admonition, place a dot
|
164
|
-
|
170
|
+
To add an *additional* title element on an admonition, place a dot `.`
|
171
|
+
directly followed by the text of the title.
|
165
172
|
|
166
173
|
.Admonition block syntax and additional title
|
167
174
|
[source, config]
|
@@ -189,26 +196,28 @@ WARNING: Icon background-color: yellow
|
|
189
196
|
CAUTION: Icon background-color: red
|
190
197
|
|
191
198
|
|
199
|
+
[role="mt-5"]
|
192
200
|
== Asciidoc Quote elements
|
193
201
|
|
194
202
|
Quote elements cite a passage or phrase from a book, speech, or the like,
|
195
|
-
such as authority, illustration, etc. the quote elements are controlled
|
196
|
-
the following *attributes*:
|
203
|
+
such as authority, illustration, etc. the quote elements are controlled
|
204
|
+
by the following *attributes*:
|
197
205
|
|
198
206
|
attribution::
|
199
207
|
The attribute `attribution` specifies the name of *who* the content
|
200
|
-
is attributed to
|
208
|
+
is attributed to.
|
201
209
|
|
202
210
|
information::
|
203
211
|
The attribute `information` is optional and specifies the general or
|
204
212
|
bibliographical information of the book, speech, play, poem, etc.,
|
205
|
-
where the content was *drawn from
|
213
|
+
where the content was *drawn from*.
|
206
214
|
|
215
|
+
[role="mt-4"]
|
207
216
|
=== Quoted paragraph
|
208
217
|
|
209
218
|
If the text element to be quoted is a single line or paragraph, the attribute
|
210
|
-
list `[quote, attribution, information]`
|
211
|
-
text.
|
219
|
+
list quote, attribution, and information `[quote, attribution, information]`
|
220
|
+
can be placed directly *above* the text.
|
212
221
|
|
213
222
|
.Synopsis
|
214
223
|
[source, text]
|
@@ -217,17 +226,13 @@ text.
|
|
217
226
|
Quote or excerpt text
|
218
227
|
----
|
219
228
|
|
220
|
-
Example of a quoted *paragraph*:
|
221
|
-
|
222
|
-
[quote, Captain James T. Kirk, Star Trek IV: The Voyage Home]
|
223
|
-
Everybody remember where we parked.
|
224
|
-
|
225
229
|
A *single* paragraph can be turned into a blockquote by:
|
226
230
|
|
227
|
-
. surrounding the quoted paragraph with double-quotes
|
228
|
-
. adding an
|
229
|
-
*below* the quoted text
|
231
|
+
. surrounding the quoted paragraph with double-quotes `"`
|
232
|
+
. adding an optional attribution `attribution`, prefixed by two
|
233
|
+
dashes `--` *below* the quoted text
|
230
234
|
|
235
|
+
[role="mt-3 mb-5"]
|
231
236
|
.Synopsis
|
232
237
|
[source, text]
|
233
238
|
----
|
@@ -235,19 +240,18 @@ A *single* paragraph can be turned into a blockquote by:
|
|
235
240
|
-- attribution
|
236
241
|
----
|
237
242
|
|
238
|
-
"
|
239
|
-
|
240
|
-
-- Thomas Jefferson, Papers of Thomas Jefferson: Volume 11
|
241
|
-
|
243
|
+
"Don't do stupid things twice. The selection is too big for that."
|
244
|
+
-- Jean-Paul Sartre
|
242
245
|
|
246
|
+
[role="mt-4"]
|
243
247
|
=== Quote block
|
244
248
|
|
245
|
-
If the text element
|
246
|
-
place the
|
247
|
-
*underscores*
|
249
|
+
If the text element, or excerpt, to be quoted is more than one paragraph,
|
250
|
+
place the multine text between delimiter lines consisting of four
|
251
|
+
*underscores* `____`.
|
248
252
|
|
253
|
+
[role="mt-3 mb-4"]
|
249
254
|
.Synopsis
|
250
|
-
|
251
255
|
[source, text]
|
252
256
|
----
|
253
257
|
[quote, attribution]
|
@@ -260,58 +264,57 @@ Example of a quoted *block*:
|
|
260
264
|
|
261
265
|
[quote, Monty Python and the Holy Grail]
|
262
266
|
____
|
263
|
-
Dennis:
|
264
|
-
|
267
|
+
Dennis: Oh, what a giveaway! Did you hear that? Did you hear that, eh? +
|
268
|
+
That's what I'm on about! Did you see him repressing me?
|
265
269
|
|
266
|
-
|
267
|
-
|
268
|
-
Dennis: Oh, what a giveaway! Did you hear that? Did you hear that, eh?
|
269
|
-
That's what I'm on about! Did you see him repressing me? You saw him,
|
270
|
-
Didn't you?
|
270
|
+
You saw him, Didn't you?
|
271
271
|
____
|
272
272
|
|
273
273
|
|
274
|
+
[role="mt-5"]
|
274
275
|
== Lightboxes
|
275
276
|
|
276
|
-
A
|
277
|
-
screen-filling versions of images
|
277
|
+
A lightbox is, in general, a helper which displays enlarged, almost
|
278
|
+
screen-filling versions of images while dimming the remainder
|
278
279
|
of the page. The technique, introduced by Lightbox V2, gained widespread
|
279
280
|
popularity thanks to its simple style. The term lightbox has been employed
|
280
281
|
since then for Javascript libraries to support such functionality.
|
281
282
|
|
282
283
|
To make the use of the built-in lightbox easier, the J1 Template offers an
|
283
|
-
Asciidoc extension: the lightBox block macro. The block macro
|
284
|
-
embeds one or more images into the output document and puts
|
285
|
-
lightbox for J1 automatically on. The images
|
286
|
-
`caption text` and
|
287
|
-
using this macro.
|
284
|
+
Asciidoc extension: the lightBox block macro. The lightbox block macro
|
285
|
+
`lightbox::` embeds one or more images into the output document and puts
|
286
|
+
the default lightbox for J1 automatically on. The images width and additional
|
287
|
+
a addtional caption text `caption text` and CSS styles are configurable for
|
288
|
+
all images using this macro.
|
288
289
|
|
289
290
|
.Lightbox block for single images
|
290
291
|
[source, no_template, role="noclip"]
|
291
292
|
----
|
292
293
|
.block_title
|
293
|
-
lightbox::<block_id>[ <images_width>, <images_data_id>, <role="
|
294
|
+
lightbox::<block_id>[ <images_width>, <images_data_id>, <role="CSS styles"> ]
|
294
295
|
----
|
295
296
|
|
296
297
|
.Lightbox block for image groups
|
297
298
|
[source, no_template, role="noclip"]
|
298
299
|
----
|
299
300
|
.block_title
|
300
|
-
lightbox::<block_id>[ <images_width>, <images_data_id>, <group_name>, <role="
|
301
|
+
lightbox::<block_id>[ <images_width>, <images_data_id>, <group_name>, <role="CSS styles"> ]
|
301
302
|
----
|
302
303
|
|
303
304
|
[NOTE]
|
304
305
|
====
|
305
|
-
The `role`
|
306
|
-
macros *optional* and can be omitted.
|
306
|
+
The role parameter `role` to specify additional CSS styles is for all
|
307
|
+
lightbox macros `lightbox::` *optional* and can be omitted.
|
307
308
|
|
308
|
-
For a
|
309
|
+
For a lightbox block, images are placed in the output document
|
309
310
|
without any other scaling than in width - they are placed using simple
|
310
|
-
HTML
|
311
|
-
For images in different sizes, a gallery should be used as a
|
312
|
-
to rearrange images and make them fit at their best for the
|
311
|
+
HTML img tags `<img>`. This technique is fine for images that are even
|
312
|
+
in size. For images in different sizes, a gallery should be used as a
|
313
|
+
J1 Gallery to rearrange images and make them fit at their best for the
|
314
|
+
available space.
|
313
315
|
====
|
314
316
|
|
317
|
+
[role="mt-4"]
|
315
318
|
=== Standalone Images
|
316
319
|
|
317
320
|
For your convenience and better readability, the image data should be
|
@@ -330,20 +333,20 @@ of data pairs:
|
|
330
333
|
:data-images: "pages/image-1.jpg, Description 1, "pages/image-2.jpg, Description 2"
|
331
334
|
----
|
332
335
|
|
333
|
-
The base path for all image-related data is a
|
334
|
-
configuration
|
335
|
-
The base path is automatically added to
|
336
|
-
default asset path for images, a relative
|
337
|
-
`path/to/image`.
|
336
|
+
The base path for all image-related data is a configuration placed in
|
337
|
+
the side-wide project configuration *_config.yml* and points per default
|
338
|
+
to images path `/assets/images`. The base path is automatically added to
|
339
|
+
each image. If you want to use the default asset path for images, a relative
|
340
|
+
path needs to be given like path-to-image `path/to/image`.
|
338
341
|
|
339
|
-
WARNING: If an absolute path
|
340
|
-
path gets ignored
|
342
|
+
WARNING: If an absolute path `/path/to/image` is configured, the base
|
343
|
+
path gets ignored. This is the default behavior of the Asciidoc Markup
|
341
344
|
processor. If an absolute path is given, the full path to the images
|
342
345
|
used has to be configured.
|
343
346
|
|
344
|
-
The parameter `group` for the `lightbox::`
|
345
|
-
|
346
|
-
standalone.
|
347
|
+
The group parameter `group` for the lightbox block `lightbox::` is optional.
|
348
|
+
If *no* group parameter is given for a block, the related images are treated
|
349
|
+
as standalone.
|
347
350
|
|
348
351
|
.Lightbox block for standalone images
|
349
352
|
[source, no_template, role="noclip"]
|
@@ -354,12 +357,13 @@ lightbox::<block_id>[ 800, {<data-images-id>} ]
|
|
354
357
|
.Lightbox block for standalone images
|
355
358
|
lightbox::images-standalone[ 800, {data-images-standalone} ]
|
356
359
|
|
360
|
+
[role="mt-4"]
|
357
361
|
=== Grouped Images
|
358
362
|
|
359
|
-
If more than a single image is given for a
|
360
|
-
can be grouped to enable a simple sliding functionality through
|
361
|
-
of related images. Enabling this function, the
|
362
|
-
configured for the block.
|
363
|
+
If more than a single image is given for a lightbox block `lightbox::`,
|
364
|
+
the images can be grouped to enable a simple sliding functionality through
|
365
|
+
this group of related images. Enabling this function, the group option
|
366
|
+
`group` needs to be configured for the block.
|
363
367
|
|
364
368
|
.Lightbox block for grouped images
|
365
369
|
[source, no_template, role="noclip"]
|
@@ -370,6 +374,7 @@ lightbox::<block_id>[ 400, {<data-images-group_id>}, <group_name> ]
|
|
370
374
|
.Lightbox block for grouped images
|
371
375
|
lightbox::images-group[ 400, {data-images-group}, group_name ]
|
372
376
|
|
377
|
+
[role="mt-5"]
|
373
378
|
== Galleries
|
374
379
|
|
375
380
|
JustifiedGallery, the default gallery for J1, is a great jQuery plugin to
|
@@ -377,12 +382,11 @@ create responsive, infinite, and high-quality justified image galleries.
|
|
377
382
|
J1 Template combines the Gallery with the lightboxes supported to enlarge
|
378
383
|
the images of a gallery.
|
379
384
|
|
380
|
-
Pictures you’ve made are typically not even in size. Images may have the
|
381
|
-
|
385
|
+
Pictures you’ve made are typically not even in size. Images may have the
|
386
|
+
same resolution, but some are orientated landscapes, or others may be
|
382
387
|
portrait. For that reason, a more powerful gallery is needed to create
|
383
|
-
a so-called masonry grid layout
|
384
|
-
position based on available horizontal and vertical space.
|
385
|
-
fitting stones in a wall.
|
388
|
+
a so-called *masonry grid layout*. It works by placing elements in an
|
389
|
+
optimal position based on available horizontal and vertical space.
|
386
390
|
|
387
391
|
.Gallerie macro for images and videos
|
388
392
|
[source, no_template, role="noclip"]
|
@@ -409,7 +413,8 @@ visitors by making a more meaningful presentation.
|
|
409
413
|
The J1 Template comes with full support of country flags for Asciidoc
|
410
414
|
documents included.
|
411
415
|
|
412
|
-
Country flags can be used as inline icons by using the
|
416
|
+
Country flags can be used as inline icons by using the flag inline
|
417
|
+
macro `flag:`:
|
413
418
|
|
414
419
|
[source, no_template, role="noclip"]
|
415
420
|
----
|
@@ -439,7 +444,7 @@ flag:de[squared, 2x, ml-3 mr-3 mb-2] Germany (square)
|
|
439
444
|
Flag Icons is a collection of all country flags in the SVG vector format.
|
440
445
|
All icons can be automatically resized with no loss in display quality.
|
441
446
|
|
442
|
-
.Example flag sizes
|
447
|
+
.Example of responsive flag sizes
|
443
448
|
[cols="2a,3a,4a,^", options="header", width="100%", role="rtable mt-3"]
|
444
449
|
|===
|
445
450
|
|Size |Style |Markup |Render
|
@@ -497,19 +502,21 @@ flag:es[rectangle, xl]
|
|
497
502
|
|===
|
498
503
|
|
499
504
|
|
505
|
+
[role="mt-5"]
|
500
506
|
== Icon Fonts
|
501
507
|
|
502
|
-
The J1 Template comes with full icon support for Asciidoc documents
|
503
|
-
All icon fonts are supported:
|
508
|
+
The J1 Template comes with full icon support for Asciidoc based documents
|
509
|
+
included. All icon fonts are supported of type:
|
504
510
|
|
505
|
-
* FA
|
506
|
-
* MDI
|
507
|
-
* Iconify
|
511
|
+
* FA -- FontAwesome
|
512
|
+
* MDI -- MaterialDesign icons
|
513
|
+
* II -- Iconify
|
508
514
|
|
509
|
-
|
515
|
+
[role="mt-4"]
|
516
|
+
=== Material Designs Icons
|
510
517
|
|
511
518
|
Material Designs Icons can be used as inline icons by using
|
512
|
-
the
|
519
|
+
the MDI inline macro `mdi:`:
|
513
520
|
|
514
521
|
[source, no_template, role="noclip"]
|
515
522
|
----
|
@@ -521,7 +528,7 @@ mdi:icon_name[icon_size, modifier] <1> <2> <3>
|
|
521
528
|
<3> The `modifier` can be used to set the e.g the color (md-blue), an
|
522
529
|
animation (fa-pulsed) or the orientation (fa-rotate-45)
|
523
530
|
|
524
|
-
.Click on button `VIEW` to see how it's looks alike
|
531
|
+
.Click on the VIEW button `VIEW` to see how it's looks alike
|
525
532
|
[source, no_template, role="noclip"]
|
526
533
|
----
|
527
534
|
mdi:home[2x, mdi-pulsed ml-3 mr-2 mb-2] Symbol icon (pulsed) +
|
@@ -536,14 +543,15 @@ mdi:font-awesome[2x, ml-3 mr-2 mb-2] Brand icon +
|
|
536
543
|
mdi:apple[2x, md-indigo ml-3 mr-2] Brand icon (colored)
|
537
544
|
====
|
538
545
|
|
539
|
-
NOTE: Parameters `icon_size` and `modifier` are
|
540
|
-
the icons `size` is set to default
|
541
|
-
settings for
|
546
|
+
NOTE: Parameters for icon size `icon_size` and modifiers `modifier` are
|
547
|
+
optional. If not given, the icons size `size` is set to default `1x`, the
|
548
|
+
color to *black* and no settings for *modifiers* `modifier` are applied.
|
542
549
|
|
543
|
-
|
550
|
+
[role="mt-4"]
|
551
|
+
=== Font Awesome Icons
|
544
552
|
|
545
|
-
Font Awesome Icons can be used as inline icons by using
|
546
|
-
|
553
|
+
Font Awesome Icons can be used as inline icons by using the macro *fas* `fas:`
|
554
|
+
for *standard* icons or the macro *fab* `fab` for *brand* icons.
|
547
555
|
|
548
556
|
[source, no_template, role="noclip"]
|
549
557
|
----
|
@@ -570,15 +578,16 @@ fab:font-awesome[2x, ml-3 mr-2 mb-2] Brand icon +
|
|
570
578
|
fab:apple[2x, md-indigo ml-3 mr-2] Brand icon (colored)
|
571
579
|
====
|
572
580
|
|
573
|
-
NOTE: Parameters `icon_size` and `modifier` are
|
574
|
-
the icons
|
575
|
-
settings for
|
581
|
+
NOTE: Parameters for icon size `icon_size` and modifiers `modifier` are
|
582
|
+
optional. If not given, the icons size is set to default `1x`, the color
|
583
|
+
to *black* and no settings for modifiers `modifier` are applied.
|
576
584
|
|
577
585
|
|
578
|
-
|
586
|
+
[role="mt-4"]
|
587
|
+
=== Iconify Icons
|
579
588
|
|
580
|
-
Iconify Icons can be used as inline icons by using the
|
581
|
-
|
589
|
+
Iconify Icons can be used as inline icons by using the iconify inline
|
590
|
+
macro `iconify:`.
|
582
591
|
|
583
592
|
[source, no_template, role="noclip"]
|
584
593
|
----
|
@@ -590,7 +599,7 @@ iconify:icon_name[icon_size, modifier] <1> <2> <3>
|
|
590
599
|
<3> The `modifier` can be used to set e.g the color (md-blue) or additional
|
591
600
|
positioning classes for margings and padding
|
592
601
|
|
593
|
-
.Click on button `VIEW` to see how it's looks alike
|
602
|
+
.Click on the VIEW button `VIEW` to see how it's looks alike
|
594
603
|
[source, no_template, role="noclip"]
|
595
604
|
----
|
596
605
|
iconify:logos:opensource[2x, ml-4 mr-2 mb-2] Brand icon OpenSource +
|
@@ -610,19 +619,20 @@ link:{url-iconify--icon-sets}[Iconify Icon Sets, {browser-window--new}].
|
|
610
619
|
|
611
620
|
[NOTE]
|
612
621
|
====
|
613
|
-
Parameters `icon_size` and `modifier` are
|
614
|
-
the icons
|
615
|
-
settings for
|
622
|
+
Parameters for icon size `icon_size` and modifiers `modifier` are
|
623
|
+
optional. If not given, the icons size is set to default `1x`, the color
|
624
|
+
to *black* and no settings for modifiers `modifier` are applied.
|
616
625
|
|
617
|
-
Not all icon sets support the color settings for
|
618
|
-
|
626
|
+
Not all icon sets support the color settings for modifiers. If applied,
|
627
|
+
the color settings will have no effect.
|
619
628
|
====
|
620
629
|
|
621
630
|
|
622
|
-
|
631
|
+
[role="mt-5"]
|
632
|
+
== Blind Text
|
623
633
|
|
624
|
-
The Ruby
|
625
|
-
set of great helpers for generating random text content. The
|
634
|
+
The Ruby GEM *Middleman*, a Ruby-based static site generator, provides a
|
635
|
+
set of great helpers for generating random text content. The lorem
|
626
636
|
inline macro `lorem:` adapted this functionality from Middleman to use
|
627
637
|
Asciidoc-based documents processed by Jekyll.
|
628
638
|
|
@@ -631,8 +641,9 @@ content is available initially. It is quite useful to place blind text
|
|
631
641
|
first to get a better impression of how a page will look-alike that is not
|
632
642
|
finished yet.
|
633
643
|
|
634
|
-
Placeholders for blind text comes in several flavors given by
|
635
|
-
syntax for the
|
644
|
+
Placeholders for blind text comes in several flavors given by their name
|
645
|
+
`macro`. The syntax for the lorem inline macro `lorem:` is simple like
|
646
|
+
this:
|
636
647
|
|
637
648
|
[source, no_template, role="noclip"]
|
638
649
|
----
|
@@ -651,10 +662,11 @@ lorem:sentences[5]
|
|
651
662
|
lorem:sentences[5]
|
652
663
|
====
|
653
664
|
|
665
|
+
[role="mt-4"]
|
654
666
|
=== Lorem Types
|
655
667
|
|
656
|
-
All macro types available for `lorem:` to be used for blind
|
657
|
-
found with the following table below.
|
668
|
+
All macro types available for the lorem macro `lorem:` to be used for blind
|
669
|
+
text can be found with the following table below.
|
658
670
|
|
659
671
|
.Macros available
|
660
672
|
[cols="5,2,5a", options="header", role="rtable mb-2"]
|
@@ -717,21 +729,20 @@ lorem:email[]
|
|
717
729
|
// -----------------------------------------------------------------------------
|
718
730
|
include::{documentdir}/100_gistblock.asciidoc[]
|
719
731
|
|
732
|
+
[role="mt-5"]
|
720
733
|
== What next
|
721
734
|
|
722
|
-
Asciidoc
|
723
|
-
|
724
|
-
|
725
|
-
|
726
|
-
|
727
|
-
|
728
|
-
J1 Template supports a set of advanced Bootstrap Modals that add dialogs
|
729
|
-
web pages for user notifications. The advanced Modals highlight
|
730
|
-
information to your visitors.
|
731
|
-
the document so that messages get the full user's
|
732
|
-
|
733
|
-
The next preview is focussing on advanced Bootstrap Modals, a great option
|
734
|
-
to customize your user dialogues using them!
|
735
|
+
Asciidoc extensions open up the Markup language to new use cases. Using
|
736
|
+
the full power of programming languages to extend what's needed. The number
|
737
|
+
of extensions will grow - to get handy and powerful functionality needed
|
738
|
+
for modern web pages based on the Asciidoc Markup language generated by
|
739
|
+
Jekyll and J1 Template.
|
740
|
+
|
741
|
+
J1 Template supports a set of advanced Bootstrap Modals that add dialogs
|
742
|
+
to your web pages for user notifications. The advanced Modals highlight
|
743
|
+
important information to your visitors. The dialogs are positioned over
|
744
|
+
everything else in the document so that messages get the full user's
|
745
|
+
attention.
|
735
746
|
|
736
747
|
Have a look for the link:{url-roundtrip--extended-modals}[Modal Extensions]
|
737
748
|
feature of J1 Template.
|
@@ -28,7 +28,7 @@ image:
|
|
28
28
|
regenerate: false
|
29
29
|
permalink: /pages/public/learn/roundtrip/themes/
|
30
30
|
|
31
|
-
resources: [ animate, rouge, clipboard
|
31
|
+
resources: [ animate, rouge, clipboard ]
|
32
32
|
resource_options:
|
33
33
|
- attic:
|
34
34
|
slides:
|
@@ -62,27 +62,33 @@ resource_options:
|
|
62
62
|
// Page content
|
63
63
|
// ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
|
64
64
|
[role="dropcap"]
|
65
|
-
Bootstrap themes
|
65
|
+
Bootstrap themes for the J1 Template are based on the free and open-source
|
66
66
|
CSS front-end framework of version V5. The Bootstrap theme feature enables
|
67
67
|
the presentation of different versions of the same site using already prepared
|
68
|
-
Bootstrap CSS
|
68
|
+
Bootstrap CSS style sets.
|
69
69
|
|
70
|
-
link:{url-bs--home}[Bootstrap, {browser-window--new}] is an HTML, CSS and
|
70
|
+
NOTE: link:{url-bs--home}[Bootstrap, {browser-window--new}] is an HTML, CSS and
|
71
71
|
Javascripts Library that focuses on simplifying the development of modern web
|
72
72
|
pages. The primary purpose of applying the framework to J1 is to provide a
|
73
73
|
general standard for colors, sizes, fonts, and the overall layout of a
|
74
|
-
|
74
|
+
based site.
|
75
75
|
|
76
|
-
Using
|
77
|
-
|
78
|
-
|
79
|
-
|
80
|
-
|
76
|
+
Using themes results in a uniform appearance for the content in terms of the
|
77
|
+
overall layout, text, tables, and form elements across all modern web browsers
|
78
|
+
available on the market. In addition, developers can take advantage of CSS
|
79
|
+
classes defined in Bootstrap to customize a layout individually.
|
80
|
+
|
81
|
+
mdi:clock-time-five-outline[24px, md-gray mt-4 mr-2]
|
82
|
+
*3 Minutes* to read
|
83
|
+
|
84
|
+
mdi:clock-time-five-outline[24px, md-gray mt-4 mr-2]
|
85
|
+
*3 Minutes* to read
|
81
86
|
|
82
87
|
// Include sub-documents (if any)
|
83
88
|
// -----------------------------------------------------------------------------
|
84
89
|
include::{documentdir}/themes_bootstrap.asciidoc[]
|
85
90
|
|
91
|
+
[role="mt-5"]
|
86
92
|
== What next
|
87
93
|
|
88
94
|
J1 Template is an excellent base for documentation websites. J1 supports
|
@@ -90,15 +96,15 @@ powerful code highlighting to distinguish different source code elements
|
|
90
96
|
visually. Highlighting makes the code more readable and easier to understand
|
91
97
|
by applying different colors or styles to different parts of the code.
|
92
98
|
|
93
|
-
|
99
|
+
Programming languages have specific syntax rules and conventions,
|
94
100
|
so code highlighting is tailored to each language. For example, in a typical
|
95
|
-
JavaScript syntax highlighting scheme, keywords like
|
96
|
-
|
101
|
+
JavaScript syntax highlighting scheme, keywords like *if*, *for*, or
|
102
|
+
function be displayed in one color, while variables and strings are
|
97
103
|
displayed in another.
|
98
104
|
|
99
|
-
The highlighter _Rouge_ is a native Ruby themeable syntax highlighter
|
100
|
-
integrated
|
101
|
-
and generates HTML output using standard ANSI
|
105
|
+
The highlighter _Rouge_ is a native Ruby-based themeable syntax highlighter
|
106
|
+
integrated by J1 Template. The highlighter supports 100+ different languages
|
107
|
+
and generates HTML output using 256 standard *ANSI* colors displayed by all
|
102
108
|
current browsers.
|
103
109
|
|
104
110
|
To check the code highlighter J1 Template offers, go for the
|