orz-mdhtml 0.1.0 → 0.1.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/README.md +12 -9
- package/assets/app.js +3 -0
- package/dist/orzmd.browser.js +50 -50
- package/orz-mdhtml-skills/SKILL.md +14 -9
- package/package.json +2 -2
|
@@ -30,18 +30,22 @@ document, so the file reproduces itself.
|
|
|
30
30
|
|
|
31
31
|
## Generate a file
|
|
32
32
|
|
|
33
|
-
Node 18+.
|
|
33
|
+
Node 18+. The CLI is on npm — run it with `npx` (no install), or `npm i -g
|
|
34
|
+
orz-mdhtml`, or `npm run gen --` in a clone:
|
|
34
35
|
|
|
35
36
|
```bash
|
|
36
|
-
orz-mdhtml <input.md> [options]
|
|
37
|
+
npx orz-mdhtml <input.md> [options]
|
|
37
38
|
-o, --out <file> output path (default: <input>.md.html)
|
|
38
39
|
--theme <name> default theme id (default: light-academic-1)
|
|
39
|
-
--
|
|
40
|
-
--
|
|
40
|
+
--cdn reference the renderer from jsDelivr (default; small files)
|
|
41
|
+
--inline embed the renderer bundle (larger file, no renderer fetch)
|
|
41
42
|
--title <text> document <title>
|
|
42
43
|
```
|
|
43
44
|
|
|
44
|
-
|
|
45
|
+
Default `--cdn` produces small files that fetch the renderer
|
|
46
|
+
(`orz-mdhtml-browser`) from jsDelivr on first open (cached after). Use
|
|
47
|
+
`--inline` only when you want the file to carry its own renderer (~750 KB);
|
|
48
|
+
note even `--inline` still fetches themes and editor libraries from CDN.
|
|
45
49
|
|
|
46
50
|
Theme ids: `light-academic-1/2`, `light-neat-1/2`, `light-playful-1/2`,
|
|
47
51
|
`beige-decent-1/2`, `dark-elegant-1/2`.
|
|
@@ -62,10 +66,11 @@ edit the `.md` and regenerate (or edit in the browser and Save).
|
|
|
62
66
|
|
|
63
67
|
## What the generated file needs at view time
|
|
64
68
|
|
|
65
|
-
"Self-contained" means *one file*, **not** *offline*.
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
highlight.js, Mermaid, and — only on first edit — CodeMirror, Split.js,
|
|
69
|
+
"Self-contained" means *one file*, **not** *offline*. **Viewing requires
|
|
70
|
+
internet**: the renderer (`orz-mdhtml-browser` from jsDelivr by default, or
|
|
71
|
+
embedded with `--inline`), theme CSS (jsDelivr `orz-markdown/themes/...`), KaTeX
|
|
72
|
+
CSS, highlight.js, Mermaid, and — only on first edit — CodeMirror, Split.js,
|
|
73
|
+
morphdom. All are CDN-cached after first load.
|
|
69
74
|
|
|
70
75
|
## Deploying / sharing
|
|
71
76
|
|
package/package.json
CHANGED
|
@@ -1,6 +1,6 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "orz-mdhtml",
|
|
3
|
-
"version": "0.1.
|
|
3
|
+
"version": "0.1.1",
|
|
4
4
|
"description": "Generate self-contained, editable .md.html files from Markdown using orz-markdown — preview + edit modes, source-aware copy, in-place save.",
|
|
5
5
|
"type": "module",
|
|
6
6
|
"bin": {
|
|
@@ -29,7 +29,7 @@
|
|
|
29
29
|
"author": "Yu Wang <yuwang@orz.how>",
|
|
30
30
|
"license": "MIT",
|
|
31
31
|
"dependencies": {
|
|
32
|
-
"orz-markdown": "^1.2.
|
|
32
|
+
"orz-markdown": "^1.2.2"
|
|
33
33
|
},
|
|
34
34
|
"devDependencies": {
|
|
35
35
|
"@types/node": "^20.11.0",
|