@headwall/markdown-to-blocks 1.0.0
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/CHANGELOG.md +44 -0
- package/LICENSE +21 -0
- package/README.md +260 -0
- package/dist/chunk-27IDEF4L.js +19871 -0
- package/dist/chunk-27IDEF4L.js.map +1 -0
- package/dist/cli.d.ts +1 -0
- package/dist/cli.js +121 -0
- package/dist/cli.js.map +1 -0
- package/dist/index.d.ts +54 -0
- package/dist/index.js +13 -0
- package/dist/index.js.map +1 -0
- package/package.json +68 -0
package/dist/cli.d.ts
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
package/dist/cli.js
ADDED
|
@@ -0,0 +1,121 @@
|
|
|
1
|
+
#!/usr/bin/env node
|
|
2
|
+
import { createRequire as __md2b_cr } from 'module';
|
|
3
|
+
const require = __md2b_cr(import.meta.url);
|
|
4
|
+
import {
|
|
5
|
+
markdownToBlocks,
|
|
6
|
+
parseMarkdownDocument
|
|
7
|
+
} from "./chunk-27IDEF4L.js";
|
|
8
|
+
|
|
9
|
+
// src/cli.ts
|
|
10
|
+
import { readFileSync, writeFileSync } from "fs";
|
|
11
|
+
var HELP = `md2blocks \u2014 convert Markdown to WordPress/Gutenberg block markup
|
|
12
|
+
|
|
13
|
+
Usage:
|
|
14
|
+
md2blocks -i <file.md> [-o <out.html>]
|
|
15
|
+
md2blocks <file.md>
|
|
16
|
+
cat doc.md | md2blocks -
|
|
17
|
+
|
|
18
|
+
Options:
|
|
19
|
+
-i, --input <file> Input Markdown file (use "-" or omit for stdin)
|
|
20
|
+
-o, --output <file> Output file (default: stdout)
|
|
21
|
+
--frontmatter Emit JSON { frontmatter, blocks } instead of markup
|
|
22
|
+
--heading-shift <n> Shift all heading levels by n (default 0)
|
|
23
|
+
--min-heading-level <n> Clamp heading levels to [n, 6] (default 2)
|
|
24
|
+
--code-language <mode> 'drop' (default) or 'class' (emit language-xxx)
|
|
25
|
+
--unsupported <mode> 'html' (default) or 'skip'
|
|
26
|
+
--no-gfm Disable GFM (tables, strikethrough, autolinks)
|
|
27
|
+
-h, --help Show this help
|
|
28
|
+
-v, --version Show version
|
|
29
|
+
`;
|
|
30
|
+
function parseArgs(argv) {
|
|
31
|
+
const args = {
|
|
32
|
+
frontmatter: false,
|
|
33
|
+
help: false,
|
|
34
|
+
version: false,
|
|
35
|
+
options: {}
|
|
36
|
+
};
|
|
37
|
+
let positional;
|
|
38
|
+
for (let i = 0; i < argv.length; i++) {
|
|
39
|
+
const arg = argv[i];
|
|
40
|
+
switch (arg) {
|
|
41
|
+
case "-i":
|
|
42
|
+
case "--input":
|
|
43
|
+
args.input = argv[++i];
|
|
44
|
+
break;
|
|
45
|
+
case "-o":
|
|
46
|
+
case "--output":
|
|
47
|
+
args.output = argv[++i];
|
|
48
|
+
break;
|
|
49
|
+
case "--frontmatter":
|
|
50
|
+
args.frontmatter = true;
|
|
51
|
+
break;
|
|
52
|
+
case "--heading-shift":
|
|
53
|
+
args.options.headingShift = Number(argv[++i]);
|
|
54
|
+
break;
|
|
55
|
+
case "--min-heading-level":
|
|
56
|
+
args.options.minHeadingLevel = Number(argv[++i]);
|
|
57
|
+
break;
|
|
58
|
+
case "--code-language":
|
|
59
|
+
args.options.codeLanguage = argv[++i];
|
|
60
|
+
break;
|
|
61
|
+
case "--unsupported":
|
|
62
|
+
args.options.unsupported = argv[++i];
|
|
63
|
+
break;
|
|
64
|
+
case "--no-gfm":
|
|
65
|
+
args.options.gfm = false;
|
|
66
|
+
break;
|
|
67
|
+
case "-h":
|
|
68
|
+
case "--help":
|
|
69
|
+
args.help = true;
|
|
70
|
+
break;
|
|
71
|
+
case "-v":
|
|
72
|
+
case "--version":
|
|
73
|
+
args.version = true;
|
|
74
|
+
break;
|
|
75
|
+
default:
|
|
76
|
+
if (arg != null && !arg.startsWith("-") && positional == null) {
|
|
77
|
+
positional = arg;
|
|
78
|
+
}
|
|
79
|
+
break;
|
|
80
|
+
}
|
|
81
|
+
}
|
|
82
|
+
if (args.input == null && positional != null) {
|
|
83
|
+
args.input = positional;
|
|
84
|
+
}
|
|
85
|
+
return args;
|
|
86
|
+
}
|
|
87
|
+
function readInput(input) {
|
|
88
|
+
const source = input == null || input === "-" ? 0 : input;
|
|
89
|
+
return readFileSync(source, "utf8");
|
|
90
|
+
}
|
|
91
|
+
function run(argv) {
|
|
92
|
+
const args = parseArgs(argv);
|
|
93
|
+
if (args.help) {
|
|
94
|
+
process.stdout.write(HELP);
|
|
95
|
+
return 0;
|
|
96
|
+
}
|
|
97
|
+
if (args.version) {
|
|
98
|
+
process.stdout.write(`${"1.0.0"}
|
|
99
|
+
`);
|
|
100
|
+
return 0;
|
|
101
|
+
}
|
|
102
|
+
const markdown = readInput(args.input);
|
|
103
|
+
const result = args.frontmatter ? `${JSON.stringify(parseMarkdownDocument(markdown, args.options), null, 2)}
|
|
104
|
+
` : `${markdownToBlocks(markdown, args.options)}
|
|
105
|
+
`;
|
|
106
|
+
if (args.output != null) {
|
|
107
|
+
writeFileSync(args.output, result);
|
|
108
|
+
} else {
|
|
109
|
+
process.stdout.write(result);
|
|
110
|
+
}
|
|
111
|
+
return 0;
|
|
112
|
+
}
|
|
113
|
+
try {
|
|
114
|
+
process.exit(run(process.argv.slice(2)));
|
|
115
|
+
} catch (error) {
|
|
116
|
+
const message = error instanceof Error ? error.message : String(error);
|
|
117
|
+
process.stderr.write(`md2blocks: ${message}
|
|
118
|
+
`);
|
|
119
|
+
process.exit(1);
|
|
120
|
+
}
|
|
121
|
+
//# sourceMappingURL=cli.js.map
|
package/dist/cli.js.map
ADDED
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":["../src/cli.ts"],"sourcesContent":["#!/usr/bin/env node\nimport { readFileSync, writeFileSync } from \"node:fs\";\nimport { markdownToBlocks } from \"./convert.js\";\nimport { parseMarkdownDocument } from \"./document.js\";\nimport type { ConvertOptions } from \"./types.js\";\n\nconst HELP = `md2blocks — convert Markdown to WordPress/Gutenberg block markup\n\nUsage:\n md2blocks -i <file.md> [-o <out.html>]\n md2blocks <file.md>\n cat doc.md | md2blocks -\n\nOptions:\n -i, --input <file> Input Markdown file (use \"-\" or omit for stdin)\n -o, --output <file> Output file (default: stdout)\n --frontmatter Emit JSON { frontmatter, blocks } instead of markup\n --heading-shift <n> Shift all heading levels by n (default 0)\n --min-heading-level <n> Clamp heading levels to [n, 6] (default 2)\n --code-language <mode> 'drop' (default) or 'class' (emit language-xxx)\n --unsupported <mode> 'html' (default) or 'skip'\n --no-gfm Disable GFM (tables, strikethrough, autolinks)\n -h, --help Show this help\n -v, --version Show version\n`;\n\ninterface CliArgs {\n input?: string;\n output?: string;\n frontmatter: boolean;\n help: boolean;\n version: boolean;\n options: ConvertOptions;\n}\n\nfunction parseArgs(argv: string[]): CliArgs {\n const args: CliArgs = {\n frontmatter: false,\n help: false,\n version: false,\n options: {},\n };\n let positional: string | undefined;\n\n for (let i = 0; i < argv.length; i++) {\n const arg = argv[i];\n switch (arg) {\n case \"-i\":\n case \"--input\":\n args.input = argv[++i];\n break;\n case \"-o\":\n case \"--output\":\n args.output = argv[++i];\n break;\n case \"--frontmatter\":\n args.frontmatter = true;\n break;\n case \"--heading-shift\":\n args.options.headingShift = Number(argv[++i]);\n break;\n case \"--min-heading-level\":\n args.options.minHeadingLevel = Number(argv[++i]);\n break;\n case \"--code-language\":\n args.options.codeLanguage = argv[++i] as ConvertOptions[\"codeLanguage\"];\n break;\n case \"--unsupported\":\n args.options.unsupported = argv[++i] as ConvertOptions[\"unsupported\"];\n break;\n case \"--no-gfm\":\n args.options.gfm = false;\n break;\n case \"-h\":\n case \"--help\":\n args.help = true;\n break;\n case \"-v\":\n case \"--version\":\n args.version = true;\n break;\n default:\n if (arg != null && !arg.startsWith(\"-\") && positional == null) {\n positional = arg;\n }\n break;\n }\n }\n\n // A bare positional file acts as input when -i wasn't given.\n if (args.input == null && positional != null) {\n args.input = positional;\n }\n return args;\n}\n\nfunction readInput(input: string | undefined): string {\n // \"-\" or no input → read stdin; otherwise read the named file.\n const source = input == null || input === \"-\" ? 0 : input;\n return readFileSync(source, \"utf8\");\n}\n\nfunction run(argv: string[]): number {\n const args = parseArgs(argv);\n\n if (args.help) {\n process.stdout.write(HELP);\n return 0;\n }\n if (args.version) {\n process.stdout.write(`${VERSION}\\n`);\n return 0;\n }\n\n const markdown = readInput(args.input);\n const result = args.frontmatter\n ? `${JSON.stringify(parseMarkdownDocument(markdown, args.options), null, 2)}\\n`\n : `${markdownToBlocks(markdown, args.options)}\\n`;\n\n if (args.output != null) {\n writeFileSync(args.output, result);\n } else {\n process.stdout.write(result);\n }\n return 0;\n}\n\n// Replaced at build time by tsup `define`; falls back for ts-node/dev runs.\ndeclare const VERSION: string;\n\ntry {\n process.exit(run(process.argv.slice(2)));\n} catch (error) {\n const message = error instanceof Error ? error.message : String(error);\n process.stderr.write(`md2blocks: ${message}\\n`);\n process.exit(1);\n}\n"],"mappings":";;;;;;;;;AACA,SAAS,cAAc,qBAAqB;AAK5C,IAAM,OAAO;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AA6Bb,SAAS,UAAU,MAAyB;AAC1C,QAAM,OAAgB;AAAA,IACpB,aAAa;AAAA,IACb,MAAM;AAAA,IACN,SAAS;AAAA,IACT,SAAS,CAAC;AAAA,EACZ;AACA,MAAI;AAEJ,WAAS,IAAI,GAAG,IAAI,KAAK,QAAQ,KAAK;AACpC,UAAM,MAAM,KAAK,CAAC;AAClB,YAAQ,KAAK;AAAA,MACX,KAAK;AAAA,MACL,KAAK;AACH,aAAK,QAAQ,KAAK,EAAE,CAAC;AACrB;AAAA,MACF,KAAK;AAAA,MACL,KAAK;AACH,aAAK,SAAS,KAAK,EAAE,CAAC;AACtB;AAAA,MACF,KAAK;AACH,aAAK,cAAc;AACnB;AAAA,MACF,KAAK;AACH,aAAK,QAAQ,eAAe,OAAO,KAAK,EAAE,CAAC,CAAC;AAC5C;AAAA,MACF,KAAK;AACH,aAAK,QAAQ,kBAAkB,OAAO,KAAK,EAAE,CAAC,CAAC;AAC/C;AAAA,MACF,KAAK;AACH,aAAK,QAAQ,eAAe,KAAK,EAAE,CAAC;AACpC;AAAA,MACF,KAAK;AACH,aAAK,QAAQ,cAAc,KAAK,EAAE,CAAC;AACnC;AAAA,MACF,KAAK;AACH,aAAK,QAAQ,MAAM;AACnB;AAAA,MACF,KAAK;AAAA,MACL,KAAK;AACH,aAAK,OAAO;AACZ;AAAA,MACF,KAAK;AAAA,MACL,KAAK;AACH,aAAK,UAAU;AACf;AAAA,MACF;AACE,YAAI,OAAO,QAAQ,CAAC,IAAI,WAAW,GAAG,KAAK,cAAc,MAAM;AAC7D,uBAAa;AAAA,QACf;AACA;AAAA,IACJ;AAAA,EACF;AAGA,MAAI,KAAK,SAAS,QAAQ,cAAc,MAAM;AAC5C,SAAK,QAAQ;AAAA,EACf;AACA,SAAO;AACT;AAEA,SAAS,UAAU,OAAmC;AAEpD,QAAM,SAAS,SAAS,QAAQ,UAAU,MAAM,IAAI;AACpD,SAAO,aAAa,QAAQ,MAAM;AACpC;AAEA,SAAS,IAAI,MAAwB;AACnC,QAAM,OAAO,UAAU,IAAI;AAE3B,MAAI,KAAK,MAAM;AACb,YAAQ,OAAO,MAAM,IAAI;AACzB,WAAO;AAAA,EACT;AACA,MAAI,KAAK,SAAS;AAChB,YAAQ,OAAO,MAAM,GAAG,OAAO;AAAA,CAAI;AACnC,WAAO;AAAA,EACT;AAEA,QAAM,WAAW,UAAU,KAAK,KAAK;AACrC,QAAM,SAAS,KAAK,cAChB,GAAG,KAAK,UAAU,sBAAsB,UAAU,KAAK,OAAO,GAAG,MAAM,CAAC,CAAC;AAAA,IACzE,GAAG,iBAAiB,UAAU,KAAK,OAAO,CAAC;AAAA;AAE/C,MAAI,KAAK,UAAU,MAAM;AACvB,kBAAc,KAAK,QAAQ,MAAM;AAAA,EACnC,OAAO;AACL,YAAQ,OAAO,MAAM,MAAM;AAAA,EAC7B;AACA,SAAO;AACT;AAKA,IAAI;AACF,UAAQ,KAAK,IAAI,QAAQ,KAAK,MAAM,CAAC,CAAC,CAAC;AACzC,SAAS,OAAO;AACd,QAAM,UAAU,iBAAiB,QAAQ,MAAM,UAAU,OAAO,KAAK;AACrE,UAAQ,OAAO,MAAM,cAAc,OAAO;AAAA,CAAI;AAC9C,UAAQ,KAAK,CAAC;AAChB;","names":[]}
|
package/dist/index.d.ts
ADDED
|
@@ -0,0 +1,54 @@
|
|
|
1
|
+
/** A WordPress image resolved from a Markdown image reference. */
|
|
2
|
+
interface ResolvedImage {
|
|
3
|
+
url: string;
|
|
4
|
+
alt?: string;
|
|
5
|
+
/** WordPress attachment ID → enables wp-image-{id} + size class. */
|
|
6
|
+
id?: number;
|
|
7
|
+
/** e.g. 'large', 'full'; only used when id is present. */
|
|
8
|
+
sizeSlug?: string;
|
|
9
|
+
caption?: string;
|
|
10
|
+
}
|
|
11
|
+
interface ConvertOptions {
|
|
12
|
+
/**
|
|
13
|
+
* Shift every heading level by this amount. Default 0.
|
|
14
|
+
* Set to 1 for docs whose first section is `#`, so `#`→h2 and body never emits h1.
|
|
15
|
+
*/
|
|
16
|
+
headingShift?: number;
|
|
17
|
+
/** Clamp resulting heading levels into [min, 6]. Default min = 2 (avoid body h1). */
|
|
18
|
+
minHeadingLevel?: number;
|
|
19
|
+
/**
|
|
20
|
+
* Resolve a Markdown image to a WordPress image. Return undefined to emit an
|
|
21
|
+
* "external" image block (no attachment id). The agent supplies this after
|
|
22
|
+
* uploading to the media library.
|
|
23
|
+
*/
|
|
24
|
+
resolveImage?: (src: string, alt: string, title?: string) => ResolvedImage | undefined;
|
|
25
|
+
/**
|
|
26
|
+
* 'drop' (default): core behaviour, language is discarded.
|
|
27
|
+
* 'class': add `language-xxx` to the <code> for a Prism/highlight.js plugin.
|
|
28
|
+
*/
|
|
29
|
+
codeLanguage?: "drop" | "class";
|
|
30
|
+
/** How to handle unsupported / raw-HTML nodes. 'html' (default) → core/html. 'skip' → omit. */
|
|
31
|
+
unsupported?: "html" | "skip";
|
|
32
|
+
/** Enable GFM (tables, strikethrough, autolinks). Default true. */
|
|
33
|
+
gfm?: boolean;
|
|
34
|
+
}
|
|
35
|
+
interface ParsedDocument {
|
|
36
|
+
frontmatter: Record<string, unknown>;
|
|
37
|
+
blocks: string;
|
|
38
|
+
}
|
|
39
|
+
|
|
40
|
+
/** Convert Markdown to one string per top-level block. */
|
|
41
|
+
declare function markdownToBlockList(markdown: string, options?: ConvertOptions): string[];
|
|
42
|
+
/** Convert Markdown to a single serialised block-markup string. */
|
|
43
|
+
declare function markdownToBlocks(markdown: string, options?: ConvertOptions): string;
|
|
44
|
+
|
|
45
|
+
/**
|
|
46
|
+
* Strip YAML frontmatter off the top of a document and convert only the body.
|
|
47
|
+
*
|
|
48
|
+
* The agent uses the returned `frontmatter` to populate REST fields (title,
|
|
49
|
+
* slug, date, …); those must never appear in `post_content`. Only the body is
|
|
50
|
+
* serialised to blocks.
|
|
51
|
+
*/
|
|
52
|
+
declare function parseMarkdownDocument(markdown: string, options?: ConvertOptions): ParsedDocument;
|
|
53
|
+
|
|
54
|
+
export { type ConvertOptions, type ParsedDocument, type ResolvedImage, markdownToBlockList, markdownToBlocks, parseMarkdownDocument };
|
package/dist/index.js
ADDED
|
@@ -0,0 +1,13 @@
|
|
|
1
|
+
import { createRequire as __md2b_cr } from 'module';
|
|
2
|
+
const require = __md2b_cr(import.meta.url);
|
|
3
|
+
import {
|
|
4
|
+
markdownToBlockList,
|
|
5
|
+
markdownToBlocks,
|
|
6
|
+
parseMarkdownDocument
|
|
7
|
+
} from "./chunk-27IDEF4L.js";
|
|
8
|
+
export {
|
|
9
|
+
markdownToBlockList,
|
|
10
|
+
markdownToBlocks,
|
|
11
|
+
parseMarkdownDocument
|
|
12
|
+
};
|
|
13
|
+
//# sourceMappingURL=index.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"sources":[],"sourcesContent":[],"mappings":"","names":[]}
|
package/package.json
ADDED
|
@@ -0,0 +1,68 @@
|
|
|
1
|
+
{
|
|
2
|
+
"name": "@headwall/markdown-to-blocks",
|
|
3
|
+
"version": "1.0.0",
|
|
4
|
+
"description": "Convert Markdown into serialised WordPress/Gutenberg block markup (core blocks, with <!-- wp:... --> delimiters).",
|
|
5
|
+
"keywords": [
|
|
6
|
+
"markdown",
|
|
7
|
+
"wordpress",
|
|
8
|
+
"gutenberg",
|
|
9
|
+
"blocks",
|
|
10
|
+
"remark",
|
|
11
|
+
"cli"
|
|
12
|
+
],
|
|
13
|
+
"type": "module",
|
|
14
|
+
"license": "MIT",
|
|
15
|
+
"author": "Paul Faulkner <paul@headwall-hosting.com>",
|
|
16
|
+
"homepage": "https://github.com/headwalluk/markdown-to-blocks#readme",
|
|
17
|
+
"repository": {
|
|
18
|
+
"type": "git",
|
|
19
|
+
"url": "git+https://github.com/headwalluk/markdown-to-blocks.git"
|
|
20
|
+
},
|
|
21
|
+
"bugs": {
|
|
22
|
+
"url": "https://github.com/headwalluk/markdown-to-blocks/issues"
|
|
23
|
+
},
|
|
24
|
+
"engines": {
|
|
25
|
+
"node": ">=18"
|
|
26
|
+
},
|
|
27
|
+
"exports": {
|
|
28
|
+
".": {
|
|
29
|
+
"types": "./dist/index.d.ts",
|
|
30
|
+
"import": "./dist/index.js"
|
|
31
|
+
}
|
|
32
|
+
},
|
|
33
|
+
"main": "./dist/index.js",
|
|
34
|
+
"module": "./dist/index.js",
|
|
35
|
+
"types": "./dist/index.d.ts",
|
|
36
|
+
"bin": {
|
|
37
|
+
"md2blocks": "dist/cli.js"
|
|
38
|
+
},
|
|
39
|
+
"files": [
|
|
40
|
+
"dist",
|
|
41
|
+
"CHANGELOG.md"
|
|
42
|
+
],
|
|
43
|
+
"sideEffects": false,
|
|
44
|
+
"scripts": {
|
|
45
|
+
"build": "tsup",
|
|
46
|
+
"dev": "tsup --watch",
|
|
47
|
+
"test": "vitest run",
|
|
48
|
+
"test:watch": "vitest",
|
|
49
|
+
"typecheck": "tsc --noEmit",
|
|
50
|
+
"prepublishOnly": "npm run build && npm test"
|
|
51
|
+
},
|
|
52
|
+
"devDependencies": {
|
|
53
|
+
"@types/mdast": "^4.0.4",
|
|
54
|
+
"@types/node": "^22.10.0",
|
|
55
|
+
"@wordpress/block-library": "^10.0.0",
|
|
56
|
+
"@wordpress/blocks": "^15.22.0",
|
|
57
|
+
"jsdom": "^29.1.1",
|
|
58
|
+
"remark-frontmatter": "^5.0.0",
|
|
59
|
+
"remark-gfm": "^4.0.0",
|
|
60
|
+
"remark-parse": "^11.0.0",
|
|
61
|
+
"tsup": "^8.3.5",
|
|
62
|
+
"typescript": "^5.7.2",
|
|
63
|
+
"unified": "^11.0.5",
|
|
64
|
+
"unist-util-visit": "^5.0.0",
|
|
65
|
+
"vitest": "^2.1.8",
|
|
66
|
+
"yaml": "^2.6.1"
|
|
67
|
+
}
|
|
68
|
+
}
|