@markdy/cli 0.7.19 → 0.7.21
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/README.md +27 -1
- package/package.json +3 -3
package/README.md
CHANGED
|
@@ -8,6 +8,30 @@ First-party command-line tooling for MarkdyScript.
|
|
|
8
8
|
npm i -D @markdy/cli
|
|
9
9
|
```
|
|
10
10
|
|
|
11
|
+
If you install it into a project, run it with `npx markdy ...` or `npm exec markdy ...` from that project.
|
|
12
|
+
To make `markdy` available as a shell command everywhere, install it globally with `npm i -g @markdy/cli`.
|
|
13
|
+
|
|
14
|
+
## Package position (text)
|
|
15
|
+
|
|
16
|
+
```text
|
|
17
|
+
@markdy/cli
|
|
18
|
+
-> reads .markdy files from disk
|
|
19
|
+
-> uses parser/runtime packages internally
|
|
20
|
+
-> outputs diagnostics, formatted source, or rendered HTML
|
|
21
|
+
```
|
|
22
|
+
|
|
23
|
+
## Output preview
|
|
24
|
+
|
|
25
|
+
<p align="center">
|
|
26
|
+
<img src="https://raw.githubusercontent.com/HoangYell/markdy-com/main/website/public/images/markdy-output-preview.webp" alt="Markdy output preview" width="900" />
|
|
27
|
+
</p>
|
|
28
|
+
|
|
29
|
+
Use this command to generate a local HTML preview:
|
|
30
|
+
|
|
31
|
+
```bash
|
|
32
|
+
npx markdy render examples/00-love-story.markdy --out examples/xscene.html
|
|
33
|
+
```
|
|
34
|
+
|
|
11
35
|
## Commands
|
|
12
36
|
|
|
13
37
|
```bash
|
|
@@ -27,4 +51,6 @@ markdy check-all .
|
|
|
27
51
|
|
|
28
52
|
- The CLI resolves `import "file.markdy" as ns` from disk before parsing.
|
|
29
53
|
- `fmt` prints a canonicalized scene and may expand higher-level sugar into its parsed form.
|
|
30
|
-
- `render --out` writes a self-contained HTML preview
|
|
54
|
+
- `render --out` writes a self-contained HTML preview to the exact path you pass in.
|
|
55
|
+
- If the path is relative, it is resolved from the current working directory.
|
|
56
|
+
- If you see `zsh: command not found: markdy`, the package is installed locally but that directory is not on your PATH.
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@markdy/cli",
|
|
3
|
-
"version": "0.7.
|
|
3
|
+
"version": "0.7.21",
|
|
4
4
|
"description": "First-party CLI for MarkdyScript: lint, format, explain, render, and local playground tooling.",
|
|
5
5
|
"license": "MIT",
|
|
6
6
|
"type": "module",
|
|
@@ -41,8 +41,8 @@
|
|
|
41
41
|
"access": "public"
|
|
42
42
|
},
|
|
43
43
|
"dependencies": {
|
|
44
|
-
"@markdy/core": "0.7.
|
|
45
|
-
"@markdy/renderer-dom": "0.7.
|
|
44
|
+
"@markdy/core": "0.7.21",
|
|
45
|
+
"@markdy/renderer-dom": "0.7.21"
|
|
46
46
|
},
|
|
47
47
|
"devDependencies": {
|
|
48
48
|
"@types/node": "^25.9.5",
|