jekyll-webawesome 0.10.0 → 0.13.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 +4 -4
- data/CHANGELOG.md +23 -0
- data/README.md +68 -13
- data/jekyll-webawesome.gemspec +1 -1
- data/lib/jekyll/webawesome/version.rb +1 -1
- metadata +3 -3
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: b54cfbaeca69a4a2c50d6b5da23ba58ac0af58f03f9c812f10ea165cedf31d5c
|
|
4
|
+
data.tar.gz: ac81039d7f111315bc44919f6c482141d9f0ce02e4e28187a992178567d29c2c
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 430ee12ec78d0c67ba7a5ac0a21eb538f9f2aaf93c8d1cec7cd8beeb9c17b1ee6c19ad21b55c6bc91cfb36db1bee54ddc62c9202e7b2bc88d57638f761548062
|
|
7
|
+
data.tar.gz: 23f9ebd7d40036ead017b802360dc59e387257b58fea64fa9961d0f13c26c1d834d936be427ce36e77f0af5264ede260f4d770c2ca7af06d219fe1a6abadf687
|
data/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,29 @@ All notable changes to this project will be documented in this file.
|
|
|
4
4
|
|
|
5
5
|
The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/)
|
|
6
6
|
|
|
7
|
+
## [0.13.0] - 2026-02-16
|
|
8
|
+
|
|
9
|
+
### Added
|
|
10
|
+
|
|
11
|
+
- **Icon sizes** — Append a size token to icons (`$$$settings:lg`, `$$$home:2x`) for predefined font-size scaling. Available sizes: `xs`, `sm`, `lg`, `xl`, `2x`, `3x`, `4x`
|
|
12
|
+
- **Custom SVG icons** — Use a file path (`$$$/assets/icons/shoe.svg`) to render `<wa-icon src="...">` instead of a named icon. Sizes work with custom paths too
|
|
13
|
+
- Icons section added to README and example site
|
|
14
|
+
- Updated `markawesome` dependency to `~> 0.7`
|
|
15
|
+
|
|
16
|
+
## [0.12.0] - 2026-02-14
|
|
17
|
+
|
|
18
|
+
### Changed
|
|
19
|
+
|
|
20
|
+
- **BREAKING: Card header syntax** — Card headers now use `**bold text**` instead of `# heading` via markawesome 0.6.0. The first bold-only line inside a card block becomes the header slot. This avoids markdownlint warnings (MD025, MD001) and better reflects that card titles are not semantic document headings.
|
|
21
|
+
- Updated `markawesome` dependency to `~> 0.6`
|
|
22
|
+
- Example site updated with new card header syntax
|
|
23
|
+
|
|
24
|
+
## [0.11.0] - 2026-02-10
|
|
25
|
+
|
|
26
|
+
### Added
|
|
27
|
+
|
|
28
|
+
- Icon component and layout utilities table added to README
|
|
29
|
+
|
|
7
30
|
## [0.10.0] - 2026-02-10
|
|
8
31
|
|
|
9
32
|
### Added
|
data/README.md
CHANGED
|
@@ -23,6 +23,7 @@ This plugin focuses on the most commonly used Web Awesome components for Jekyll
|
|
|
23
23
|
| **Copy Button** | `<<<placement? disabled? duration? labels?` | `:::wa-copy-button attributes?` | `<wa-copy-button value="content" tooltip-placement="right" disabled>` |
|
|
24
24
|
| **Details** | `^^^appearance? icon-placement?` | `:::wa-details appearance? icon-placement?` | `<wa-details appearance="..." icon-placement="...">content</wa-details>` |
|
|
25
25
|
| **Dialog** | `???params?` | `:::wa-dialog params?` | `<wa-dialog>` with trigger button and content |
|
|
26
|
+
| **Icon** | `$$$icon-name` or `$$$icon-name:size` | `:::wa-icon name [size]` | `<wa-icon name="icon-name"></wa-icon>` |
|
|
26
27
|
| **Tab Group** | `++++++` | `:::wa-tabs` | `<wa-tab-group><wa-tab>content</wa-tab></wa-tab-group>` |
|
|
27
28
|
| **Tag** | `@@@brand` | `:::wa-tag brand` | `<wa-tag variant="brand">content</wa-tag>` |
|
|
28
29
|
|
|
@@ -30,6 +31,21 @@ Not all components will make sense to include here, to be included in the "prose
|
|
|
30
31
|
|
|
31
32
|
Both syntax styles work identically and can be mixed within the same document.
|
|
32
33
|
|
|
34
|
+
### Layout utilities
|
|
35
|
+
|
|
36
|
+
Layout containers use `::::` (quadruple colon) syntax to wrap content in Web Awesome CSS layout utilities. Layouts compose with component syntax — use `:::` components inside `::::` layouts.
|
|
37
|
+
|
|
38
|
+
| Layout | Primary Syntax | Key Attributes | Description |
|
|
39
|
+
|--------|----------------|----------------|-------------|
|
|
40
|
+
| **Grid** | `::::grid` | `min:SIZE`, `gap:SIZE` | Responsive auto-wrapping grid |
|
|
41
|
+
| **Stack** | `::::stack` | `gap:SIZE` | Vertical spacing |
|
|
42
|
+
| **Cluster** | `::::cluster` | `gap:SIZE`, `justify:VALUE` | Inline wrapping elements (tag clouds, button groups) |
|
|
43
|
+
| **Split** | `::::split` | `gap:SIZE`, `row`/`column` | Even two-column/row distribution |
|
|
44
|
+
| **Flank** | `::::flank` | `size:SIZE`, `content:SIZE`, `gap:SIZE` | Sidebar + main content |
|
|
45
|
+
| **Frame** | `::::frame` | `landscape`/`portrait`/`square`, `radius:VALUE` | Aspect ratio containers |
|
|
46
|
+
|
|
47
|
+
Common attributes across all layouts: `gap:SIZE`, `align:VALUE`, `justify:VALUE`. Alternative `::::wa-*` syntax is supported for all layout types.
|
|
48
|
+
|
|
33
49
|
## Installation
|
|
34
50
|
|
|
35
51
|
Add this line to your application's Gemfile:
|
|
@@ -208,11 +224,11 @@ This is a basic card with just content.
|
|
|
208
224
|
|
|
209
225
|
#### Cards with Headers
|
|
210
226
|
|
|
211
|
-
The first
|
|
227
|
+
The first bold line (`**text**`) automatically becomes the card header:
|
|
212
228
|
|
|
213
229
|
```markdown
|
|
214
230
|
===
|
|
215
|
-
|
|
231
|
+
**Card Title**
|
|
216
232
|
This is the card content that appears in the main area.
|
|
217
233
|
===
|
|
218
234
|
```
|
|
@@ -224,7 +240,7 @@ The first image automatically becomes the card media:
|
|
|
224
240
|
```markdown
|
|
225
241
|
===
|
|
226
242
|

|
|
227
|
-
|
|
243
|
+
**Featured Content**
|
|
228
244
|
This card includes both an image and a title.
|
|
229
245
|
===
|
|
230
246
|
```
|
|
@@ -235,8 +251,8 @@ Links at the end of the card content automatically become footer buttons:
|
|
|
235
251
|
|
|
236
252
|
```markdown
|
|
237
253
|
===
|
|
238
|
-
|
|
239
|
-
Ready to begin your journey?
|
|
254
|
+
**Get Started**
|
|
255
|
+
Ready to begin your journey?
|
|
240
256
|
[Learn More](https://example.com)
|
|
241
257
|
===
|
|
242
258
|
```
|
|
@@ -248,7 +264,7 @@ You can combine all elements for rich content cards:
|
|
|
248
264
|
```markdown
|
|
249
265
|
===filled
|
|
250
266
|

|
|
251
|
-
|
|
267
|
+
**Complete Example**
|
|
252
268
|
This card has media, header, content, and footer with a filled appearance.
|
|
253
269
|
[Get Started](https://example.com)
|
|
254
270
|
===
|
|
@@ -260,22 +276,22 @@ You can specify different visual styles:
|
|
|
260
276
|
|
|
261
277
|
```markdown
|
|
262
278
|
===filled
|
|
263
|
-
|
|
279
|
+
**Filled Card**
|
|
264
280
|
This card uses the filled appearance.
|
|
265
281
|
===
|
|
266
282
|
|
|
267
283
|
===plain
|
|
268
|
-
|
|
284
|
+
**Plain Card**
|
|
269
285
|
This card uses the plain appearance.
|
|
270
286
|
===
|
|
271
287
|
|
|
272
288
|
===filled-outlined
|
|
273
|
-
|
|
289
|
+
**Filled Outlined Card**
|
|
274
290
|
This card uses the filled-outlined appearance.
|
|
275
291
|
===
|
|
276
292
|
|
|
277
293
|
===accent
|
|
278
|
-
|
|
294
|
+
**Accent Card**
|
|
279
295
|
This card uses the accent appearance for emphasis.
|
|
280
296
|
===
|
|
281
297
|
```
|
|
@@ -287,13 +303,13 @@ Cards can be displayed in horizontal layout for side-by-side presentation:
|
|
|
287
303
|
```markdown
|
|
288
304
|
===horizontal
|
|
289
305
|

|
|
290
|
-
|
|
306
|
+
**Horizontal Card**
|
|
291
307
|
This card displays with a side-by-side layout where media appears on the left.
|
|
292
308
|
===
|
|
293
309
|
|
|
294
310
|
===filled horizontal
|
|
295
311
|

|
|
296
|
-
|
|
312
|
+
**Combined Attributes**
|
|
297
313
|
You can combine appearance and orientation in any order.
|
|
298
314
|
===
|
|
299
315
|
```
|
|
@@ -653,6 +669,45 @@ Status: @@@ warning Beta @@@ - testing in progress
|
|
|
653
669
|
Combine inline @@@ pill small success Ready @@@ with attributes
|
|
654
670
|
```
|
|
655
671
|
|
|
672
|
+
### Icons
|
|
673
|
+
|
|
674
|
+
Insert icons inline using the `$$$` syntax:
|
|
675
|
+
|
|
676
|
+
```markdown
|
|
677
|
+
Click $$$settings to open settings.
|
|
678
|
+
|
|
679
|
+
A larger icon: $$$home:2x
|
|
680
|
+
|
|
681
|
+
Custom SVG: $$$/assets/icons/logo.svg
|
|
682
|
+
```
|
|
683
|
+
|
|
684
|
+
#### Icon Sizes
|
|
685
|
+
|
|
686
|
+
Append a size token after `:` to control the icon size:
|
|
687
|
+
|
|
688
|
+
```markdown
|
|
689
|
+
$$$star:xs Extra small (0.75em)
|
|
690
|
+
$$$star:sm Small (0.875em)
|
|
691
|
+
$$$star Default (inherits font size)
|
|
692
|
+
$$$star:lg Large (1.25em)
|
|
693
|
+
$$$star:xl Extra large (1.5em)
|
|
694
|
+
$$$star:2x 2x (2em)
|
|
695
|
+
$$$star:3x 3x (3em)
|
|
696
|
+
$$$star:4x 4x (4em)
|
|
697
|
+
```
|
|
698
|
+
|
|
699
|
+
#### Custom SVG Icons
|
|
700
|
+
|
|
701
|
+
Use a file path starting with `/` or `./` to render a custom SVG instead of a named icon:
|
|
702
|
+
|
|
703
|
+
```markdown
|
|
704
|
+
$$$/assets/icons/shoe.svg
|
|
705
|
+
$$$/assets/icons/shoe.svg:2x
|
|
706
|
+
$$$./icons/logo.svg:xl
|
|
707
|
+
```
|
|
708
|
+
|
|
709
|
+
This outputs `<wa-icon src="...">` instead of `<wa-icon name="...">`.
|
|
710
|
+
|
|
656
711
|
### Copy Buttons
|
|
657
712
|
|
|
658
713
|
Create copy-to-clipboard buttons using the `<<<` syntax:
|
|
@@ -1394,7 +1449,7 @@ Cards support flexible attribute ordering using space-separated parameters:
|
|
|
1394
1449
|
Cards automatically parse content into these slots:
|
|
1395
1450
|
|
|
1396
1451
|
- **Media**: First image becomes media slot
|
|
1397
|
-
- **Header**: First
|
|
1452
|
+
- **Header**: First `**bold line**` becomes header slot
|
|
1398
1453
|
- **Content**: Remaining content becomes main content
|
|
1399
1454
|
- **Footer**: Trailing links become footer buttons
|
|
1400
1455
|
|
data/jekyll-webawesome.gemspec
CHANGED
|
@@ -33,7 +33,7 @@ Gem::Specification.new do |spec|
|
|
|
33
33
|
spec.require_paths = ['lib']
|
|
34
34
|
|
|
35
35
|
spec.add_dependency 'jekyll', '>= 3.7', '< 5.0'
|
|
36
|
-
spec.add_dependency 'markawesome', '~> 0.
|
|
36
|
+
spec.add_dependency 'markawesome', '~> 0.7'
|
|
37
37
|
|
|
38
38
|
spec.add_development_dependency 'bundler', '~> 2.0'
|
|
39
39
|
spec.add_development_dependency 'rake', '~> 13.0'
|
metadata
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
--- !ruby/object:Gem::Specification
|
|
2
2
|
name: jekyll-webawesome
|
|
3
3
|
version: !ruby/object:Gem::Version
|
|
4
|
-
version: 0.
|
|
4
|
+
version: 0.13.0
|
|
5
5
|
platform: ruby
|
|
6
6
|
authors:
|
|
7
7
|
- Janne Waren
|
|
@@ -35,14 +35,14 @@ dependencies:
|
|
|
35
35
|
requirements:
|
|
36
36
|
- - "~>"
|
|
37
37
|
- !ruby/object:Gem::Version
|
|
38
|
-
version: '0.
|
|
38
|
+
version: '0.7'
|
|
39
39
|
type: :runtime
|
|
40
40
|
prerelease: false
|
|
41
41
|
version_requirements: !ruby/object:Gem::Requirement
|
|
42
42
|
requirements:
|
|
43
43
|
- - "~>"
|
|
44
44
|
- !ruby/object:Gem::Version
|
|
45
|
-
version: '0.
|
|
45
|
+
version: '0.7'
|
|
46
46
|
- !ruby/object:Gem::Dependency
|
|
47
47
|
name: bundler
|
|
48
48
|
requirement: !ruby/object:Gem::Requirement
|