@vmz/vmz-skills 0.1.20 → 0.1.22
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/package.json
CHANGED
|
@@ -17,6 +17,23 @@ SSR/resume behavior, `vmz test`, or deployment artifact.
|
|
|
17
17
|
- Keep server-only imports behind `#server`; never leak secrets or repositories into browser output.
|
|
18
18
|
- Prefer the official `@vmz/core`, `@vmz/ui`, `vmz`, and `@vmz/test` surfaces already present in the project.
|
|
19
19
|
|
|
20
|
+
## Code highlighting (Shiki — preferred)
|
|
21
|
+
|
|
22
|
+
When the user needs **syntax-colored** source (docs, marketing snippets, API samples, tutorials):
|
|
23
|
+
|
|
24
|
+
1. Install and wire **`@vmz/plugin-shiki`** (peer `shiki` is fine as a dependency of the app).
|
|
25
|
+
2. In `vmz.config.ts`: `plugins: [shiki({ themes: […] })]` and usually `engines: { code: 'shiki' }`.
|
|
26
|
+
3. In templates use **`<Shiki :code="…" lang="…" theme="…" />`** or **`<Code :code="…" lang="…" />`** (facade after engines).
|
|
27
|
+
4. Restart **`vmz dev`** after changing `vmz.config.*` (config is not watch-reloaded).
|
|
28
|
+
|
|
29
|
+
**Do not:**
|
|
30
|
+
|
|
31
|
+
- Import `shiki` / `createHighlighter` in app components and paint HTML by hand.
|
|
32
|
+
- Invent a local `*.vmz` highlighter, copy `Shiki.vmz` from the plugin into the app as a permanent substitute, or wrap raw `<pre>` as a fake highlighter.
|
|
33
|
+
- Expect `@vmz/ui` **`CodeBlock`** to colorize — it is caption/Copy/`<pre>` chrome only (`CodeBlock ≠ Shiki`).
|
|
34
|
+
|
|
35
|
+
Plain uncolored samples → `CodeBlock`. Colored reading experience → plugin Shiki. Editors → Monaco / CodeMirror plugins, not Shiki stretched into an editor.
|
|
36
|
+
|
|
20
37
|
## Delivery / dist layout (multi-artifact)
|
|
21
38
|
|
|
22
39
|
- `vmz build` is **multi-artifact**. Default `--out-dir` is `dist` (workspace root) — **not** the CDN publish tree.
|