@kubb/parser-md 5.8.2 → 5.8.4

package/README.md

@@ -10,7 +10,7 @@
 [![Node][node-src]][node-href]
 
 <h4>
-<a href="https://kubb.dev" target="_blank">Documentation</a>
+<a href="https://kubb.dev/extensions/kubb-labs/parser-md" target="_blank">Documentation</a>
 <span> · </span>
 <a href="https://github.com/kubb-labs/kubb/issues/" target="_blank">Report Bug</a>
 <span> · </span>

package/dist/index.cjs

@@ -4,12 +4,12 @@ let _kubb_kit = require("@kubb/kit");
 let yaml = require("yaml");
 //#region kubb-extension.json
 var compatibility = {
-	"kubb": ">=5.8.0",
+	"kubb": ">=5.8.3",
 	"node": ">=22"
 };
 //#endregion
 //#region package.json
-var version = "5.8.2";
+var version = "5.8.4";
 //#endregion
 //#region src/utils.ts
 /**

package/dist/index.js

@@ -3,12 +3,12 @@ import { ast, defineExtension } from "@kubb/kit";
 import { stringify } from "yaml";
 //#region kubb-extension.json
 var compatibility = {
-	"kubb": ">=5.8.0",
+	"kubb": ">=5.8.3",
 	"node": ">=22"
 };
 //#endregion
 //#region package.json
-var version = "5.8.2";
+var version = "5.8.4";
 //#endregion
 //#region src/utils.ts
 /**

package/docs/options.md

@@ -0,0 +1,44 @@
+# Options
+
+`parserMd()` takes no options. You control its output through file metadata, such as the YAML frontmatter at the top of a generated page.
+
+## Frontmatter
+
+Set `file.meta.frontmatter` inside a plugin. Any serializable object becomes a YAML block at the top of the generated page.
+
+::field-group
+
+:::field{name="meta.frontmatter" type="Record<string, unknown> | null"}
+YAML frontmatter prepended to the generated Markdown file.
+:::
+
+::
+
+::code-group
+
+```typescript [plugin.ts]
+import { ast } from 'kubb/kit'
+
+const file = ast.factory.createFile({
+  baseName: 'README.md',
+  path: './src/gen/README.md',
+  meta: {
+    frontmatter: { title: 'API Reference', layout: 'doc' },
+  },
+  sources: [ast.factory.createSource({ nodes: [ast.factory.createText('# API Reference')] })],
+})
+```
+
+```md [README.md]
+---
+title: API Reference
+layout: doc
+---
+
+# API Reference
+```
+
+::
+
+- `parserMd().print` accepts objects and Markdown strings, joined with blank lines.
+- `parserMd().print({ title: 'Pets', layout: 'doc' })` returns `---\ntitle: Pets\nlayout: doc\n---`.

package/{OVERVIEW.md → docs/overview.md}

@@ -1,14 +1,16 @@
 # Markdown parser
 
-The Markdown parser writes `.md` and `.markdown` files. It joins a file's source blocks as plain Markdown, separated by blank lines. When the file sets `meta.frontmatter`, it adds that object as YAML frontmatter at the top.
+The Markdown parser writes `.md` and `.markdown` files. It joins a file's source blocks as plain Markdown, separated by blank lines. When the file sets [`meta.frontmatter`](https://kubb.dev/extensions/kubb-labs/parser-md/options#frontmatter), it adds that object as YAML frontmatter at the top.
 
 It takes no options. Kubb registers it by default with the TypeScript parsers.
 
 ## Setup
 
-Add it yourself only when you set a custom `parsers` array, since that array replaces the default set. List every parser your plugins need.
+Add it yourself only when you set a custom `parsers` array, since that array replaces the default set. List every parser your plugins need. Files no parser claims are written as their source text.
 
-```ts
+## Example
+
+```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { parserMd } from '@kubb/parser-md'
 import { parserTs, parserTsx } from '@kubb/parser-ts'

package/kubb-extension.json

@@ -10,9 +10,10 @@
     "light": "https://kubb.dev/feature/markdown.svg"
   },
   "tags": ["markdown", "frontmatter", "parser", "docs", "yaml"],
-  "docs": "https://kubb.dev/parsers/parser-md",
+  "docs": "https://kubb.dev/extensions/kubb-labs/parser-md",
+  "maintainers": [{ "name": "Stijn Van Hulle", "github": "stijnvanhulle" }],
   "compatibility": {
-    "kubb": ">=5.8.0",
+    "kubb": ">=5.8.3",
     "node": ">=22"
   }
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/parser-md",
-  "version": "5.8.2",
+  "version": "5.8.4",
   "description": "Markdown source file parser for Kubb. Converts the universal AST to `.md` source and renders YAML frontmatter via the `print` helper.",
   "keywords": [
     "codegen",
@@ -11,7 +11,7 @@
     "parser",
     "yaml"
   ],
-  "homepage": "https://kubb.dev/parsers/parser-md",
+  "homepage": "https://kubb.dev/extensions/kubb-labs/parser-md",
   "license": "MIT",
   "author": "stijnvanhulle",
   "repository": {
@@ -36,7 +36,7 @@
   "files": [
     "dist",
     "kubb-extension.json",
-    "OVERVIEW.md",
+    "docs",
     "!/**/**.test.**",
     "!/**/__tests__/**",
     "!/**/__snapshots__/**"
@@ -60,7 +60,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/kit": "5.8.2",
+    "@kubb/kit": "5.8.4",
     "yaml": "^2.9.1"
   },
   "engines": {