@fusion.dev/helix-docs 0.108.2 → 0.109.1
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.
- package/content/introduction.mdx +1 -0
- package/content/metrics.mdx +1 -1
- package/content/recipes.mdx +12 -4
- package/dist/sources.generated.js +14 -5
- package/package.json +3 -3
package/content/introduction.mdx
CHANGED
|
@@ -62,6 +62,7 @@ each framework.
|
|
|
62
62
|
| `@fusion.dev/helix-headless` | You want the behavior and none of the styling |
|
|
63
63
|
| `@fusion.dev/helix-theme` | You are generating or validating a theme |
|
|
64
64
|
| `@fusion.dev/helix-icons` | You are drawing an icon outside a component |
|
|
65
|
+
| `@fusion.dev/helix-map` | You are drawing a map with MapLibre, Leaflet, or a renderer of your own. See [Maps](./maps) |
|
|
65
66
|
| `@fusion.dev/helix-core` | You are building a new Helix component |
|
|
66
67
|
|
|
67
68
|
React uses the elements directly. Helix ships a `jsx.d.ts` that types every
|
package/content/metrics.mdx
CHANGED
|
@@ -403,7 +403,7 @@ stripped column shows the bytes we removed.
|
|
|
403
403
|
| `@fusion.dev/helix-icons` | 150,162 | 21 | 50,346 | `svgo` |
|
|
404
404
|
| `@fusion.dev/helix-styles` | 102,108 | 6 | 0 | none |
|
|
405
405
|
| `@fusion.dev/helix-theme` | 465,413 | 8 | 4,703 | none |
|
|
406
|
-
| `@fusion.dev/helix` | 14,
|
|
406
|
+
| `@fusion.dev/helix` | 14,191,826 | 870 | 370,788 | `@fusion.dev/helix-core`, `@fusion.dev/helix-headless`, `@fusion.dev/helix-styles` |
|
|
407
407
|
|
|
408
408
|
## Not measured yet
|
|
409
409
|
|
package/content/recipes.mdx
CHANGED
|
@@ -112,7 +112,7 @@ In prose:
|
|
|
112
112
|
|
|
113
113
|
See [Typography](./typography).
|
|
114
114
|
|
|
115
|
-
|
|
115
|
+
Three Markdown constructs need components, because HTML alone cannot hold what
|
|
116
116
|
they need:
|
|
117
117
|
|
|
118
118
|
- **Fenced code** becomes `helix-code-block`, with the fence's language as its
|
|
@@ -121,8 +121,13 @@ they need:
|
|
|
121
121
|
tone. `NOTE` becomes `tone="info"`, `TIP` becomes `success`, `WARNING` becomes
|
|
122
122
|
`warning`, and `CAUTION` becomes `danger`. `IMPORTANT` has no tone. Each
|
|
123
123
|
callout is headed by its kind, as GitHub shows it.
|
|
124
|
+
- **Tables** become `helix-table`. A `<table>` squeezes its columns to fit, so
|
|
125
|
+
a narrow screen breaks a value such as `eu-central-1` across lines. The
|
|
126
|
+
header row becomes the table's columns, each aligned as the Markdown aligned
|
|
127
|
+
it. A column of short values stays whole, a column of sentences wraps, and a
|
|
128
|
+
table wider than the screen scrolls in its own box.
|
|
124
129
|
|
|
125
|
-
The `rehype` plugin from `@fusion.dev/helix/rehype` makes
|
|
130
|
+
The `rehype` plugin from `@fusion.dev/helix/rehype` makes all three changes in the
|
|
126
131
|
tree your Markdown library has already built. It parses nothing, so your
|
|
127
132
|
library, its dialect, and your sanitizing stay yours. Add it to any pipeline
|
|
128
133
|
that reaches rehype, such as `remark` with `remark-rehype`, `react-markdown`, or
|
|
@@ -141,10 +146,13 @@ const html = await unified()
|
|
|
141
146
|
|
|
142
147
|
Code that a highlighter colored before the plugin ran keeps its colors. Pass
|
|
143
148
|
`fences: false` if your page draws its own code blocks, `alerts: false` to keep
|
|
144
|
-
alerts as quotes,
|
|
149
|
+
alerts as quotes, `tables: false` to keep tables as HTML, and `headings` to
|
|
150
|
+
name each kind in your page's language. A table with a caption, a cell that
|
|
151
|
+
spans more than one column or row, or a heading cell outside its header row
|
|
152
|
+
stays HTML, because the grid cannot draw it as written.
|
|
145
153
|
|
|
146
154
|
> [!NOTE]
|
|
147
|
-
> The plugin changes only these
|
|
155
|
+
> The plugin changes only these three constructs. If the Markdown comes from your
|
|
148
156
|
> users, sanitize it in your pipeline before the plugin runs.
|
|
149
157
|
|
|
150
158
|
Prose spaces each component the same as the element it replaces.
|
|
@@ -2070,6 +2070,7 @@ each framework.
|
|
|
2070
2070
|
| \`@fusion.dev/helix-headless\` | You want the behavior and none of the styling |
|
|
2071
2071
|
| \`@fusion.dev/helix-theme\` | You are generating or validating a theme |
|
|
2072
2072
|
| \`@fusion.dev/helix-icons\` | You are drawing an icon outside a component |
|
|
2073
|
+
| \`@fusion.dev/helix-map\` | You are drawing a map with MapLibre, Leaflet, or a renderer of your own. See [Maps](./maps) |
|
|
2073
2074
|
| \`@fusion.dev/helix-core\` | You are building a new Helix component |
|
|
2074
2075
|
|
|
2075
2076
|
React uses the elements directly. Helix ships a \`jsx.d.ts\` that types every
|
|
@@ -3156,7 +3157,7 @@ stripped column shows the bytes we removed.
|
|
|
3156
3157
|
| \`@fusion.dev/helix-icons\` | 150,162 | 21 | 50,346 | \`svgo\` |
|
|
3157
3158
|
| \`@fusion.dev/helix-styles\` | 102,108 | 6 | 0 | none |
|
|
3158
3159
|
| \`@fusion.dev/helix-theme\` | 465,413 | 8 | 4,703 | none |
|
|
3159
|
-
| \`@fusion.dev/helix\` | 14,
|
|
3160
|
+
| \`@fusion.dev/helix\` | 14,191,826 | 870 | 370,788 | \`@fusion.dev/helix-core\`, \`@fusion.dev/helix-headless\`, \`@fusion.dev/helix-styles\` |
|
|
3160
3161
|
|
|
3161
3162
|
## Not measured yet
|
|
3162
3163
|
|
|
@@ -3904,7 +3905,7 @@ In prose:
|
|
|
3904
3905
|
|
|
3905
3906
|
See [Typography](./typography).
|
|
3906
3907
|
|
|
3907
|
-
|
|
3908
|
+
Three Markdown constructs need components, because HTML alone cannot hold what
|
|
3908
3909
|
they need:
|
|
3909
3910
|
|
|
3910
3911
|
- **Fenced code** becomes \`helix-code-block\`, with the fence's language as its
|
|
@@ -3913,8 +3914,13 @@ they need:
|
|
|
3913
3914
|
tone. \`NOTE\` becomes \`tone="info"\`, \`TIP\` becomes \`success\`, \`WARNING\` becomes
|
|
3914
3915
|
\`warning\`, and \`CAUTION\` becomes \`danger\`. \`IMPORTANT\` has no tone. Each
|
|
3915
3916
|
callout is headed by its kind, as GitHub shows it.
|
|
3917
|
+
- **Tables** become \`helix-table\`. A \`<table>\` squeezes its columns to fit, so
|
|
3918
|
+
a narrow screen breaks a value such as \`eu-central-1\` across lines. The
|
|
3919
|
+
header row becomes the table's columns, each aligned as the Markdown aligned
|
|
3920
|
+
it. A column of short values stays whole, a column of sentences wraps, and a
|
|
3921
|
+
table wider than the screen scrolls in its own box.
|
|
3916
3922
|
|
|
3917
|
-
The \`rehype\` plugin from \`@fusion.dev/helix/rehype\` makes
|
|
3923
|
+
The \`rehype\` plugin from \`@fusion.dev/helix/rehype\` makes all three changes in the
|
|
3918
3924
|
tree your Markdown library has already built. It parses nothing, so your
|
|
3919
3925
|
library, its dialect, and your sanitizing stay yours. Add it to any pipeline
|
|
3920
3926
|
that reaches rehype, such as \`remark\` with \`remark-rehype\`, \`react-markdown\`, or
|
|
@@ -3933,10 +3939,13 @@ const html = await unified()
|
|
|
3933
3939
|
|
|
3934
3940
|
Code that a highlighter colored before the plugin ran keeps its colors. Pass
|
|
3935
3941
|
\`fences: false\` if your page draws its own code blocks, \`alerts: false\` to keep
|
|
3936
|
-
alerts as quotes,
|
|
3942
|
+
alerts as quotes, \`tables: false\` to keep tables as HTML, and \`headings\` to
|
|
3943
|
+
name each kind in your page's language. A table with a caption, a cell that
|
|
3944
|
+
spans more than one column or row, or a heading cell outside its header row
|
|
3945
|
+
stays HTML, because the grid cannot draw it as written.
|
|
3937
3946
|
|
|
3938
3947
|
> [!NOTE]
|
|
3939
|
-
> The plugin changes only these
|
|
3948
|
+
> The plugin changes only these three constructs. If the Markdown comes from your
|
|
3940
3949
|
> users, sanitize it in your pipeline before the plugin runs.
|
|
3941
3950
|
|
|
3942
3951
|
Prose spaces each component the same as the element it replaces.
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@fusion.dev/helix-docs",
|
|
3
3
|
"description": "Versioned documentation content and registry for Helix.",
|
|
4
|
-
"version": "0.
|
|
4
|
+
"version": "0.109.1",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"author": "Ross Sheppard <ross.sheppard@fusion.dev>",
|
|
7
7
|
"repository": {
|
|
@@ -36,8 +36,8 @@
|
|
|
36
36
|
},
|
|
37
37
|
"bugs": "https://github.com/project-fusion/fusion/issues",
|
|
38
38
|
"devDependencies": {
|
|
39
|
-
"@fusion.dev/helix-cem": "0.
|
|
40
|
-
"@fusion.dev/helix-testing": "0.
|
|
39
|
+
"@fusion.dev/helix-cem": "0.109.1",
|
|
40
|
+
"@fusion.dev/helix-testing": "0.109.1",
|
|
41
41
|
"@fusion.dev/scripts": "0.0.0-dev",
|
|
42
42
|
"lit": "^3.2.1",
|
|
43
43
|
"playwright": "^1.62.1"
|