jekyll-theme-endless 0.19.6 → 0.20.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
checksums.yaml CHANGED
@@ -1,7 +1,7 @@
1
1
  ---
2
2
  SHA256:
3
- metadata.gz: 38ee02aeccc68d70b0b8a33fc8f7d2be011d9a2a3bee1d5b2d4cbe937c1db18a
4
- data.tar.gz: 1ff6d1009a40510eece921d7966e30f7bd85c2201e14c89c278c60697bd27268
3
+ metadata.gz: 83a4d3d3d8a4956babdd236500d9ad6c8adaa08a2e58db2b925743d47c72cfa2
4
+ data.tar.gz: ba8e6d3c2dccca9e8e33f976852569e793d1b890a4e831fcbde23f6fbaa350a9
5
5
  SHA512:
6
- metadata.gz: 5fd6ccced658e8719aebd81bf2cfda4248a7e2d36e578770750d48a0fe02ecc791b8fe5ee8a2f215b617080325301b7021d5dabb8d66d1ed9e0a8f302dab941f
7
- data.tar.gz: 8a57c6cdc7bf3711d4b91459e25c903a88d39ac74e1d22b08eaf503cb425a0aa30f66a2e18372fb8ecfbd191d8a5d87250c7ab26af916893c76ab3ff01891fc1
6
+ metadata.gz: a5d90794c1dba9bdcaa7df46d6bf7385c65a5e2552cba9b03839410cc30f3c5a93d80b94fb075458e40d51bbd192c66d5eb26368a0712f0e3e1978a44da74515
7
+ data.tar.gz: 858963547a2dc75125453bc79c572a3da42ff763f7c9c41ce96d767676af2e46e0b0c01fe67a33b16c78ee8f16dafe42bb3d1917e2a2f56be3c0bacdfae14e95
data/README.adoc CHANGED
@@ -164,13 +164,13 @@ Contains a *navigation bar* with a configurable brand-label.
164
164
  Set `brand` in your `_config.yml`, to determine what is shown on the left side of the navigation.
165
165
  Example:
166
166
 
167
- TIP: The values for `brand`, `title` and `subtitle` are _not_ escaped by the layout. Thus, you _can_ use HTML-commands.
168
-
169
167
  [source, yaml]
170
168
  ----
171
169
  brand: '"<i>endless</i>"-Theme'
172
170
  ----
173
171
 
172
+ TIP: The values for `brand`, `title` and `subtitle` are _not_ escaped by the layout. Thus, you _can_ use HTML-commands.
173
+
174
174
  Contains a configurable *title bar*.
175
175
  Set `title` and `subtitle` in your `_config.yml`, to determine what is shown below the navigation bar.
176
176
  If none of the two values is set, the title bar is omitted.
@@ -196,6 +196,15 @@ disclaimer: >- # this means to ignore newlines until the next entry
196
196
  Therefore, many things (e.g. the support of AsciiDoc) are based on personal requirements.
197
197
  You are welcome to use the theme (at your own risk) and contribute to the development.
198
198
  ----
199
+
200
+ Set `navigation-left` to `true` in your `_config.yml`, to show the navigation on the left side and the main content on the right side
201
+ (by default, the navigation is shown on the right side).
202
+ Example:
203
+ [source, yaml]
204
+ ----
205
+ navigation-left: true
206
+ ----
207
+
199
208
  --
200
209
 
201
210
 
data/_config.yml CHANGED
@@ -30,6 +30,14 @@ url: "" # the base hostname & protocol for your site, e.g. http://example.com
30
30
 
31
31
 
32
32
 
33
+ # Layout settings
34
+ ###############################################################################
35
+ navigation-left: false # If true, the navigation bar is rendered on the left and the main content on the right. Default: false.
36
+
37
+
38
+
39
+
40
+
33
41
  # AsciiDoc settings
34
42
  ###############################################################################
35
43
  asciidoctor:
@@ -68,11 +68,33 @@ layout: html
68
68
 
69
69
  <div class="row">
70
70
 
71
- <div class="col-lg-8 pb-5">
71
+ {%- comment -%}
72
+ Assign default Bootstrap grid classes to content and aside sections.
73
+ This allows for responsive layout with content taking 8 columns and aside taking 4 columns on large screens.
74
+ {%- endcomment -%}
75
+ {% assign content_class = "col-lg-8 pb-5" %}
76
+ {% assign aside_class = "col-lg-4 pb-5" %}
77
+
78
+ {%- comment -%}
79
+ If 'navigation-left' is enabled in site config, swap the order of content and aside on large screens
80
+ by appending 'order-lg-1' and 'order-lg-2' classes respectively.
81
+ This enables flexible layout positioning without changing the HTML structure.
82
+ {%- endcomment -%}
83
+ {% if site.navigation-left %}
84
+ {% assign content_class = content_class | append: " order-lg-2" %}
85
+ {% assign aside_class = aside_class | append: " order-lg-1" %}
86
+ {% endif %}
87
+
88
+
89
+ {%- comment -%}
90
+ Renders main content and aside sections.
91
+ 'content' holds page-specific data and is placed first, so it appears before the aside on small devices.
92
+ The aside contains components like top section, navigation, and info.
93
+ {%- endcomment -%}
94
+ <div class="{{ content_class }}">
72
95
  {{ content }}
73
96
  </div>
74
-
75
- <div class="col-lg-4 pb-5">
97
+ <div class="{{ aside_class }}">
76
98
  {% include aside_top.html %}
77
99
  {% include aside_navigation.html %}
78
100
  {% include aside_info.html %}
data/_sass/adoc-code.scss CHANGED
@@ -39,24 +39,24 @@
39
39
  * Ensure that code annotation symbols are not selected along with the code.
40
40
  */
41
41
  i.conum, i.conum + b {
42
- user-select: none;
42
+ user-select: none;
43
43
  }
44
44
 
45
45
  i.conum + b {
46
- display: none; // Hides the <b> element
46
+ display: none; // Hides the <b> element
47
47
  }
48
48
 
49
49
  i.conum::after {
50
- content: attr(data-value); // Displays the value of data-value in the <i> element
51
- font-weight: bold; // Optional: for bold styling if desired
50
+ content: attr(data-value); // Displays the value of data-value in the <i> element
51
+ font-weight: bold; // Optional: for bold styling if desired
52
52
 
53
- display: inline-block; // Enables circular styling
54
- background-color: #f0f0f0; // Light gray background
55
- border: 1px solid #555; // Thin dark gray border
56
- border-radius: 50%; // Rounds the element into a circle
57
- padding: 2px 6px; // Adjusts spacing for a circular shape
58
- text-align: center; // Centers the text in the circle
59
- line-height: 1; // Ensures the character is vertically centered
53
+ display: inline-block; // Enables circular styling
54
+ background-color: #f0f0f0; // Light gray background
55
+ border: 1px solid #555; // Thin dark gray border
56
+ border-radius: 50%; // Rounds the element into a circle
57
+ padding: 2px 6px; // Adjusts spacing for a circular shape
58
+ text-align: center; // Centers the text in the circle
59
+ line-height: 1; // Ensures the character is vertically centered
60
60
  margin: 0 .5em;
61
61
  }
62
62
 
@@ -15,16 +15,16 @@ b.button {
15
15
  * Styles for the output of the AsciiDoc command `kbd`.
16
16
  */
17
17
  .keyseq kbd {
18
- display: inline-block;
19
- padding: 0.42em 0.71em;
20
- margin: 0 0.2em;
21
- background: #f5f5f5;
22
- color: #000;
23
- font: 600 0.85em/0.85 monospace;
24
- letter-spacing: .05em;
25
- white-space: nowrap;
26
- border: 1px solid #bbb;
27
- border-radius: .1em;
28
- box-shadow: 2px 2px 0 #888;
18
+ display: inline-block;
19
+ padding: 0.42em 0.71em;
20
+ margin: 0 0.2em;
21
+ background: #f5f5f5;
22
+ color: #000;
23
+ font: 600 0.85em/0.85 monospace;
24
+ letter-spacing: .05em;
25
+ white-space: nowrap;
26
+ border: 1px solid #bbb;
27
+ border-radius: .1em;
28
+ box-shadow: 2px 2px 0 #888;
29
29
  }
30
30
 
@@ -6,10 +6,10 @@ li {
6
6
  }
7
7
 
8
8
  ul, ol {
9
- padding-left: 1.5em;
9
+ padding-left: 1.5em;
10
10
 
11
- ul, ol {
12
- padding-left: 1em;
13
- }
11
+ ul, ol {
12
+ padding-left: 1em;
13
+ }
14
14
  }
15
15
 
@@ -0,0 +1,19 @@
1
+ div.sidebarblock {
2
+ margin: 1em 0;
3
+ padding: 0.5em;
4
+ border: 1px solid #ccc;
5
+ border-radius: 13px;
6
+ background-color: lightgoldenrodyellow;
7
+
8
+ > .content {
9
+ padding: 0 0.5em;
10
+
11
+ > .title {
12
+ margin: 0 0 0.5em 0;
13
+ font-weight: bold;
14
+ font-size: 1.3em;
15
+ text-align: center;
16
+ border-bottom: 1px solid #ccc;
17
+ }
18
+ }
19
+ }
data/_sass/adoc-toc.scss CHANGED
@@ -24,9 +24,9 @@ ul.sectlevel2,
24
24
  ul.sectlevel3,
25
25
  ul.sectlevel4,
26
26
  ul.sectlevel5 {
27
- list-style-type: none;
28
- padding-left: 1.3em;
29
- margin: 4px 0;
27
+ list-style-type: none;
28
+ padding-left: 1.3em;
29
+ margin: 4px 0;
30
30
  }
31
31
 
32
32
  li {
data/_sass/glossary.scss CHANGED
@@ -61,8 +61,8 @@ div.glossary-index {
61
61
  h2.glossary {
62
62
 
63
63
  display: flex;
64
- justify-content: space-between;
65
- align-items: baseline;
64
+ justify-content: space-between;
65
+ align-items: baseline;
66
66
  font-weight: bold;
67
67
 
68
68
  border-bottom: 2px dotted #ccc;
data/_sass/postlists.scss CHANGED
@@ -3,45 +3,45 @@
3
3
  */
4
4
 
5
5
  ul.post-list-short {
6
- margin-left: 0;
6
+ margin-left: 0;
7
7
  list-style-type: "⇒ ";
8
8
  }
9
9
 
10
10
  ul.post-list-long {
11
11
 
12
- list-style: none;
13
- padding: 0;
14
- margin: 0;
12
+ list-style: none;
13
+ padding: 0;
14
+ margin: 0;
15
15
 
16
- li {
17
- margin-bottom: 20px;
16
+ li {
17
+ margin-bottom: 20px;
18
18
 
19
- h2 {
20
- margin-left: .25em;
19
+ h2 {
20
+ margin-left: .25em;
21
21
  font-size: 1.7em;
22
- }
22
+ }
23
23
 
24
24
  p.summary {
25
25
  margin-bottom: 1.5em;
26
26
  }
27
27
 
28
- div {
29
- position: relative;
30
- margin-left: 3em;
28
+ div {
29
+ position: relative;
30
+ margin-left: 3em;
31
31
  padding: .5em 0;
32
32
 
33
- // Blurred bar on the left side of the div
34
- &::before {
35
- content: '';
36
- position: absolute;
37
- left: -2em;
38
- top: 0;
39
- bottom: 0;
40
- width: 1em;
41
- background-color: rgba(0, 0, 111, 0.1);
42
- filter: blur(3px);
43
- border-radius: 5px;
44
- }
45
- }
46
- }
33
+ // Blurred bar on the left side of the div
34
+ &::before {
35
+ content: '';
36
+ position: absolute;
37
+ left: -2em;
38
+ top: 0;
39
+ bottom: 0;
40
+ width: 1em;
41
+ background-color: rgba(0, 0, 111, 0.1);
42
+ filter: blur(3px);
43
+ border-radius: 5px;
44
+ }
45
+ }
46
+ }
47
47
  }
data/assets/css/main.scss CHANGED
@@ -33,6 +33,7 @@
33
33
  */
34
34
  @use "adoc";
35
35
  @use "adoc-admonition";
36
+ @use "adoc-sidebarblock";
36
37
  @use "adoc-tables";
37
38
  @use "adoc-lists";
38
39
  @use "adoc-quote";
@@ -1,5 +1,5 @@
1
1
  module Jekyll
2
2
  module Endless
3
- VERSION = '0.19.6'
3
+ VERSION = '0.20.0'
4
4
  end
5
5
  end
@@ -234,6 +234,34 @@ Code for the *block* command (here for a NOTE):
234
234
 
235
235
 
236
236
 
237
+ [[sidebarblock]]
238
+ == Sidebar/Aside blocks
239
+
240
+ .Excursus: Sidebar block with a code example
241
+ ****
242
+ Sidebars are used to visually separate auxiliary bits of content
243
+ that supplement the main text.
244
+ They typically contain more information than a simple admonition block.
245
+
246
+ TIP: They can contain any type of content.
247
+
248
+ // The standard sidebar block delimiter (****) cannot be used directly inside a code block, and escaping it does not work either.
249
+ // As a workaround, I defined a custom attribute "block-delimiter" and substituted it into the code block below.
250
+ :block-delimiter: ****
251
+
252
+ .Source code you can use to create a sidebar block. The block-delimiter is `\****`.
253
+ [source, asciidoc, subs="attributes"]
254
+ ----
255
+ .Title of the sidebar block
256
+ {block-delimiter}
257
+ Content of the sidebar block.
258
+ {block-delimiter}
259
+ ----
260
+
261
+ ****
262
+
263
+
264
+
237
265
 
238
266
 
239
267
  == Tables
@@ -315,7 +343,6 @@ The result is:
315
343
 
316
344
 
317
345
 
318
-
319
346
  == Images
320
347
 
321
348
  // AsciiDoc commands are not stripped/processed when used within `alt=""`.
metadata CHANGED
@@ -1,7 +1,7 @@
1
1
  --- !ruby/object:Gem::Specification
2
2
  name: jekyll-theme-endless
3
3
  version: !ruby/object:Gem::Version
4
- version: 0.19.6
4
+ version: 0.20.0
5
5
  platform: ruby
6
6
  authors:
7
7
  - Sven Boekhoff
@@ -270,6 +270,7 @@ files:
270
270
  - _sass/adoc-images.scss
271
271
  - _sass/adoc-lists.scss
272
272
  - _sass/adoc-quote.scss
273
+ - _sass/adoc-sidebarblock.scss
273
274
  - _sass/adoc-stem.scss
274
275
  - _sass/adoc-tables.scss
275
276
  - _sass/adoc-text.scss