vizmatic 0.1.10 → 0.1.11
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/PROMPT.md +11 -5
- package/README.md +9 -3
- package/docs/PROMPT.md +11 -5
- package/package.json +1 -1
package/PROMPT.md
CHANGED
|
@@ -6,13 +6,19 @@ Use Vizmatic to create polished, theme-aware diagrams, figures, dashboards, pres
|
|
|
6
6
|
|
|
7
7
|
Use the package manager already present in the project.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Install the CLI once:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
pnpm
|
|
12
|
+
pnpm add -g vizmatic
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Then render any frame directly:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
vizmatic ./frame.tsx --out ./dist/frames --theme dark,light
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Install in the project when the project needs scripts, editor types, or direct renderer APIs:
|
|
16
22
|
|
|
17
23
|
```bash
|
|
18
24
|
pnpm add vizmatic react
|
|
@@ -96,7 +102,7 @@ height = 560;
|
|
|
96
102
|
Render it:
|
|
97
103
|
|
|
98
104
|
```bash
|
|
99
|
-
|
|
105
|
+
vizmatic frames --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right
|
|
100
106
|
```
|
|
101
107
|
|
|
102
108
|
For direct CLI frames, skip imports, `defineIllustration`, and `c` props by default. The CLI injects Vizmatic primitives and theme colors. Use the full module form when you need custom dependencies, direct renderer APIs, advanced reusable JSX helpers, or animation exports.
|
|
@@ -127,7 +133,7 @@ export const watermark = (
|
|
|
127
133
|
Render animated frames with `createScenes(theme)`:
|
|
128
134
|
|
|
129
135
|
```bash
|
|
130
|
-
|
|
136
|
+
vizmatic gif frames/animated-pipeline.tsx --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right --scale 1
|
|
131
137
|
```
|
|
132
138
|
|
|
133
139
|
## Create an animated frame
|
package/README.md
CHANGED
|
@@ -31,15 +31,21 @@
|
|
|
31
31
|
|
|
32
32
|
## Quick Start
|
|
33
33
|
|
|
34
|
-
|
|
34
|
+
Install the CLI once:
|
|
35
35
|
|
|
36
36
|
```bash
|
|
37
|
-
pnpm
|
|
37
|
+
pnpm add -g vizmatic
|
|
38
|
+
```
|
|
39
|
+
|
|
40
|
+
Then render any frame directly:
|
|
41
|
+
|
|
42
|
+
```bash
|
|
43
|
+
vizmatic ./frame.tsx --out ./dist/frames --theme dark,light
|
|
38
44
|
```
|
|
39
45
|
|
|
40
46
|
Bare CLI frames auto-import Vizmatic primitives and inject theme colors. Use normal imports when a frame needs helpers, data loading, custom dependencies, or direct renderer APIs.
|
|
41
47
|
|
|
42
|
-
Install it when you want
|
|
48
|
+
Install it in the project when you want scripts, editor types, or direct renderer APIs:
|
|
43
49
|
|
|
44
50
|
```bash
|
|
45
51
|
pnpm add vizmatic react
|
package/docs/PROMPT.md
CHANGED
|
@@ -6,13 +6,19 @@ Use Vizmatic to create polished, theme-aware diagrams, figures, dashboards, pres
|
|
|
6
6
|
|
|
7
7
|
Use the package manager already present in the project.
|
|
8
8
|
|
|
9
|
-
|
|
9
|
+
Install the CLI once:
|
|
10
10
|
|
|
11
11
|
```bash
|
|
12
|
-
pnpm
|
|
12
|
+
pnpm add -g vizmatic
|
|
13
13
|
```
|
|
14
14
|
|
|
15
|
-
|
|
15
|
+
Then render any frame directly:
|
|
16
|
+
|
|
17
|
+
```bash
|
|
18
|
+
vizmatic ./frame.tsx --out ./dist/frames --theme dark,light
|
|
19
|
+
```
|
|
20
|
+
|
|
21
|
+
Install in the project when the project needs scripts, editor types, or direct renderer APIs:
|
|
16
22
|
|
|
17
23
|
```bash
|
|
18
24
|
pnpm add vizmatic react
|
|
@@ -96,7 +102,7 @@ height = 560;
|
|
|
96
102
|
Render it:
|
|
97
103
|
|
|
98
104
|
```bash
|
|
99
|
-
|
|
105
|
+
vizmatic frames --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right
|
|
100
106
|
```
|
|
101
107
|
|
|
102
108
|
For direct CLI frames, skip imports, `defineIllustration`, and `c` props by default. The CLI injects Vizmatic primitives and theme colors. Use the full module form when you need custom dependencies, direct renderer APIs, advanced reusable JSX helpers, or animation exports.
|
|
@@ -127,7 +133,7 @@ export const watermark = (
|
|
|
127
133
|
Render animated frames with `createScenes(theme)`:
|
|
128
134
|
|
|
129
135
|
```bash
|
|
130
|
-
|
|
136
|
+
vizmatic gif frames/animated-pipeline.tsx --out public/vizmatic --theme dark,light --watermark "Your Product" --watermark-image ./logo.svg --watermark-position top-right --scale 1
|
|
131
137
|
```
|
|
132
138
|
|
|
133
139
|
## Create an animated frame
|
package/package.json
CHANGED