@wireweave/markdown-plugin 1.2.12-beta.11 → 1.2.12-beta.12

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.
Files changed (2) hide show
  1. package/README.md +15 -94
  2. package/package.json +2 -2
package/README.md CHANGED
@@ -1,108 +1,29 @@
1
1
  # @wireweave/markdown-plugin
2
2
 
3
- Render Wireweave wireframes from fenced code blocks in Markdown.
3
+ Markdown adapters that render Wireweave code fences through Core.
4
4
 
5
- ## What it does
5
+ The [public tool contract](../../docs/spec/TOOLING.md#editor-integrations) defines this package's APIs, behavior, configuration and compatibility. The [language contract](../../docs/spec/LANGUAGE.md) defines the DSL. [Package metadata](package.json) owns package versions, exports, dependencies and scripts.
6
6
 
7
- `@wireweave/markdown-plugin` lets you embed Wireweave DSL directly in Markdown. A fenced `wireframe` code block is parsed and rendered into HTML, an HTML preview container, SVG, or a base64 SVG `<img>` tag. Rendering is delegated to `@wireweave/core`.
7
+ ## Installation
8
8
 
9
- Adapters are provided for the three major Markdown engines, each as its own subpath export:
10
-
11
- - `@wireweave/markdown-plugin/markdown-it`
12
- - `@wireweave/markdown-plugin/marked`
13
- - `@wireweave/markdown-plugin/remarkable`
14
-
15
- Each engine is an **optional peer dependency** — install only the one you use. The package root also exports `renderWireframe`, the standalone renderer the adapters are built on.
16
-
17
- ## Install
9
+ Use Node.js >=22.13.0. Replace `<pinned-version>` with the release selected for your toolchain.
18
10
 
19
11
  ```bash
20
- npm i @wireweave/markdown-plugin
21
- ```
22
-
23
- ## Usage
24
-
25
- A fenced block tagged `wireframe` is rendered:
26
-
27
- ````markdown
28
- ```wireframe
29
- page "Home" {
30
- button "Get Started" primary
31
- }
12
+ pnpm add --save-exact '@wireweave/markdown-plugin@<pinned-version>'
32
13
  ```
33
- ````
34
-
35
- ### markdown-it
36
14
 
37
- ```typescript
38
- import MarkdownIt from 'markdown-it'
39
- import { markdownItWireframe } from '@wireweave/markdown-plugin/markdown-it'
15
+ Install the Markdown engine used by your selected adapter as a peer dependency. Adapter entries and registration are defined by the tool contract.
40
16
 
41
- const md = new MarkdownIt()
42
- md.use(markdownItWireframe, { format: 'svg-img', theme: 'light' })
43
-
44
- const html = md.render(source)
45
- ```
46
-
47
- ### marked
48
-
49
- ```typescript
50
- import { marked } from 'marked'
51
- import { markedWireframe } from '@wireweave/markdown-plugin/marked'
52
-
53
- marked.use(markedWireframe({ format: 'svg', theme: 'dark' }))
54
-
55
- const html = marked.parse(source)
56
- ```
17
+ ## Development
57
18
 
58
- ### remarkable
19
+ Run from the monorepo root after the [workspace setup](../../README.md).
59
20
 
60
- ```typescript
61
- import { Remarkable } from 'remarkable'
62
- import { remarkableWireframe } from '@wireweave/markdown-plugin/remarkable'
63
-
64
- const md = new Remarkable()
65
- remarkableWireframe(md, { format: 'html-preview' })
66
-
67
- const html = md.render(source)
68
- ```
69
-
70
- ### Standalone renderer
71
-
72
- ```typescript
73
- import { renderWireframe } from '@wireweave/markdown-plugin'
74
-
75
- const html = renderWireframe('page { button "OK" primary }', {
76
- format: 'html',
77
- theme: 'light',
78
- })
21
+ ```bash
22
+ pnpm --filter @wireweave/markdown-plugin run build
23
+ pnpm --filter @wireweave/markdown-plugin run typecheck
24
+ pnpm --filter @wireweave/markdown-plugin run lint
25
+ pnpm --filter @wireweave/markdown-plugin run test
26
+ pnpm --filter @wireweave/markdown-plugin run format:check
79
27
  ```
80
28
 
81
- ## Options
82
-
83
- `WireframePluginOptions`:
84
-
85
- | Option | Values | Default | Description |
86
- | ---------------- | ------------------------------------------------------ | ----------------------- | --------------------------------------------------------------------------------------------------------------------- |
87
- | `format` | `'html'` \| `'html-preview'` \| `'svg'` \| `'svg-img'` | `'svg-img'` | Output format. `html-preview` wraps output in a scalable preview container; `svg-img` emits a base64-encoded `<img>`. |
88
- | `theme` | `'light'` \| `'dark'` | `'light'` | Rendering theme. |
89
- | `containerClass` | `string` | `'wireframe-container'` | Wrapper element class. |
90
- | `errorHandling` | `'code'` \| `'error'` \| `'both'` | `'both'` | What to show when a block fails to parse. |
91
- | `containerWidth` | `number` | `0` | Target width (px) for `html-preview` scaling. `0` disables scaling. |
92
- | `maxScale` | `number` | `1` | Upper bound on the preview scale factor. |
93
-
94
- ## Main API
95
-
96
- | Export | Description |
97
- | -------------------------------------- | -------------------------------------- |
98
- | `renderWireframe(code, options?)` | Render a DSL string to an HTML string. |
99
- | `markdownItWireframe` (`/markdown-it`) | markdown-it plugin. |
100
- | `markedWireframe` (`/marked`) | marked extension factory. |
101
- | `remarkableWireframe` (`/remarkable`) | remarkable plugin. |
102
- | `WireframePluginOptions` | Shared options type. |
103
-
104
- Part of the [Wireweave monorepo](https://github.com/wireweave/wireweave).
105
-
106
- ## License
107
-
108
- MIT
29
+ License: MIT.
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@wireweave/markdown-plugin",
3
- "version": "1.2.12-beta.11",
3
+ "version": "1.2.12-beta.12",
4
4
  "description": "Markdown plugins for wireweave",
5
5
  "type": "module",
6
6
  "sideEffects": false,
@@ -73,7 +73,7 @@
73
73
  }
74
74
  },
75
75
  "dependencies": {
76
- "@wireweave/core": "3.1.0-beta.11"
76
+ "@wireweave/core": "4.0.0-beta.12"
77
77
  },
78
78
  "devDependencies": {
79
79
  "@commitlint/cli": "^21.0.2",