markawesome 0.5.0 → 0.6.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 +6 -0
- data/README.md +33 -3
- data/lib/markawesome/transformers/card_transformer.rb +5 -4
- data/lib/markawesome/version.rb +1 -1
- metadata +1 -1
checksums.yaml
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
---
|
|
2
2
|
SHA256:
|
|
3
|
-
metadata.gz:
|
|
4
|
-
data.tar.gz:
|
|
3
|
+
metadata.gz: 2c03fbaecd8dec3c16fa5e2ddeb07b12d2eb35ad2fbc8389a49b725d77a3c2cf
|
|
4
|
+
data.tar.gz: 6b530bf8caae7b8717411b111e6e3e6f9fb6766373d0b80238cb3fa4ec7f98d6
|
|
5
5
|
SHA512:
|
|
6
|
-
metadata.gz:
|
|
7
|
-
data.tar.gz:
|
|
6
|
+
metadata.gz: 6e2b2e8804309e702139068db433be5cbb62132eede58ff45a25d871b721bc2adab4a23d34b820ed8dda26907de2d51ab277b30a13f5d9037e3d26efd123d91f
|
|
7
|
+
data.tar.gz: 8ba50a46d31a068af6ae3d2dc28c2832d26b665e4a006fc74b34f5c59ee0a12596f4f8a7a1a98d7412f0150fe25215d3772521fe6fcaff5f1154c69ac91fc684
|
data/CHANGELOG.md
CHANGED
|
@@ -4,6 +4,12 @@ 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.0.0/) and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
|
|
6
6
|
|
|
7
|
+
## [0.6.0] - 2026-02-14
|
|
8
|
+
|
|
9
|
+
### Changed
|
|
10
|
+
|
|
11
|
+
- **BREAKING: Card header syntax** — Card headers now use `**bold text**` instead of `# heading`. The first bold-only line inside a card block becomes the header slot. This avoids markdownlint warnings about multiple top-level headings (MD025) and incorrect heading levels (MD001), and better reflects that card titles are not semantic document headings.
|
|
12
|
+
|
|
7
13
|
## [0.5.0] - 2026-02-10
|
|
8
14
|
|
|
9
15
|
### Added
|
data/README.md
CHANGED
|
@@ -10,22 +10,52 @@ Used as the transformation engine for the [jekyll-webawesome](https://github.com
|
|
|
10
10
|
- 🚀 **Simple Syntax** - Clean, intuitive Markdown extensions
|
|
11
11
|
- ⚙️ **Configurable** - Customize icons, variants, and component behavior
|
|
12
12
|
|
|
13
|
-
## Supported
|
|
13
|
+
## Supported Components
|
|
14
14
|
|
|
15
15
|
| Component | Primary Syntax | Alternative Syntax | HTML Output |
|
|
16
16
|
|-----------|----------------|-------------------|-------------|
|
|
17
17
|
| **Badge** | `!!!variant` | `:::wa-badge variant` | `<wa-badge variant="brand">content</wa-badge>` |
|
|
18
18
|
| **Button** | `%%%variant` | `:::wa-button variant` | `<wa-button variant="brand" href="url">text</wa-button>` or `<wa-button variant="brand">text</wa-button>` |
|
|
19
|
-
| **
|
|
19
|
+
| **Callout** | `:::info` | `:::wa-callout info` | `<wa-callout variant="brand"><wa-icon ...></wa-icon>content</wa-callout>` |
|
|
20
20
|
| **Card** | `===` | `:::wa-card` | `<wa-card>content</wa-card>` |
|
|
21
21
|
| **Carousel** | `~~~~~~` | `:::wa-carousel` | `<wa-carousel>` with carousel items |
|
|
22
22
|
| **Comparison** | `\|\|\|` or `\|\|\|25` | `:::wa-comparison` or `:::wa-comparison 25` | `<wa-comparison>` with before/after slots |
|
|
23
23
|
| **Copy Button** | `<<<` | `:::wa-copy-button` | `<wa-copy-button value="content">content</wa-copy-button>` |
|
|
24
|
-
| **Details** | `^^^appearance? icon-placement?` | `:::wa-details appearance? icon-placement?` | `<wa-details
|
|
24
|
+
| **Details** | `^^^appearance? icon-placement?` | `:::wa-details appearance? icon-placement?` | `<wa-details>content</wa-details>` |
|
|
25
25
|
| **Dialog** | `???params?` | `:::wa-dialog params?` | `<wa-dialog>` with trigger button and content |
|
|
26
|
+
| **Icon** | `$$$icon-name` | `:::wa-icon icon-name` | `<wa-icon name="icon-name"></wa-icon>` |
|
|
27
|
+
| **Image Dialog** | `` | — | Wraps images in clickable `<wa-dialog>` overlays |
|
|
26
28
|
| **Tab Group** | `++++++` | `:::wa-tabs` | `<wa-tab-group><wa-tab>content</wa-tab></wa-tab-group>` |
|
|
27
29
|
| **Tag** | `@@@brand` | `:::wa-tag brand` | `<wa-tag variant="brand">content</wa-tag>` |
|
|
28
30
|
|
|
31
|
+
## Layout Utilities
|
|
32
|
+
|
|
33
|
+
Layout utilities use `::::` (quadruple colon) syntax to wrap content in CSS layout containers. Inner content is not markdown-converted, so component `:::` syntax inside layouts works normally.
|
|
34
|
+
|
|
35
|
+
| Layout | Primary Syntax | Alternative Syntax | HTML Output |
|
|
36
|
+
|--------|----------------|-------------------|-------------|
|
|
37
|
+
| **Grid** | `::::grid` | `::::wa-grid` | `<div class="wa-grid">content</div>` |
|
|
38
|
+
| **Stack** | `::::stack` | `::::wa-stack` | `<div class="wa-stack">content</div>` |
|
|
39
|
+
| **Cluster** | `::::cluster` | `::::wa-cluster` | `<div class="wa-cluster">content</div>` |
|
|
40
|
+
| **Split** | `::::split` | `::::wa-split` | `<div class="wa-split">content</div>` |
|
|
41
|
+
| **Flank** | `::::flank` | `::::wa-flank` | `<div class="wa-flank">content</div>` |
|
|
42
|
+
| **Frame** | `::::frame` | `::::wa-frame` | `<div class="wa-frame">content</div>` |
|
|
43
|
+
|
|
44
|
+
### Common layout attributes
|
|
45
|
+
|
|
46
|
+
All layouts support these key:value attributes:
|
|
47
|
+
|
|
48
|
+
- `gap:SIZE` — Sets spacing (`0`, `3xs`, `2xs`, `xs`, `s`, `m`, `l`, `xl`, `2xl`, `3xl`)
|
|
49
|
+
- `align:VALUE` — Align items (`start`, `end`, `center`, `stretch`, `baseline`)
|
|
50
|
+
- `justify:VALUE` — Justify content (`start`, `end`, `center`, `space-between`, `space-around`, `space-evenly`)
|
|
51
|
+
|
|
52
|
+
### Layout-specific attributes
|
|
53
|
+
|
|
54
|
+
- **Grid**: `min:CSS_VALUE` — Minimum column size (e.g., `min:200px`)
|
|
55
|
+
- **Split**: `row` or `column` — Direction modifier
|
|
56
|
+
- **Flank**: `start` or `end` — Position modifier; `size:CSS_VALUE`, `content:PCT`
|
|
57
|
+
- **Frame**: `landscape`, `portrait`, or `square` — Aspect ratio; `radius:SIZE` (`s`, `m`, `l`, `pill`, `circle`, `square`)
|
|
58
|
+
|
|
29
59
|
## Installation
|
|
30
60
|
|
|
31
61
|
Add this line to your application's Gemfile:
|
|
@@ -10,6 +10,7 @@ module Markawesome
|
|
|
10
10
|
# Supported attributes:
|
|
11
11
|
# appearance: outlined (default), filled, filled-outlined, plain, accent
|
|
12
12
|
# orientation: vertical (default), horizontal
|
|
13
|
+
# Card header: first **bold** line (not a heading) becomes the header slot
|
|
13
14
|
class CardTransformer < BaseTransformer
|
|
14
15
|
CARD_ATTRIBUTES = {
|
|
15
16
|
appearance: %w[outlined filled filled-outlined plain accent],
|
|
@@ -57,11 +58,11 @@ module Markawesome
|
|
|
57
58
|
content = content.sub(/^!\[([^\]]*)\]\(([^)]+)\)\n?/, '')
|
|
58
59
|
end
|
|
59
60
|
|
|
60
|
-
# Extract first
|
|
61
|
-
if content.match(
|
|
61
|
+
# Extract first bold line as header
|
|
62
|
+
if content.match(/^\*\*(.+)\*\*$/)
|
|
62
63
|
parts[:header] = ::Regexp.last_match(1).strip
|
|
63
|
-
# Remove the
|
|
64
|
-
content = content.sub(
|
|
64
|
+
# Remove the bold line from content
|
|
65
|
+
content = content.sub(/^\*\*(.+)\*\*\n?/, '')
|
|
65
66
|
end
|
|
66
67
|
|
|
67
68
|
# Extract trailing buttons/links as footer
|
data/lib/markawesome/version.rb
CHANGED