@kubb/parser-md 5.8.4 → 5.9.0

package/dist/index.cjs

@@ -9,7 +9,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.8.4";
+var version = "5.9.0";
 //#endregion
 //#region src/utils.ts
 /**

package/dist/index.js

@@ -8,7 +8,7 @@ var compatibility = {
 };
 //#endregion
 //#region package.json
-var version = "5.8.4";
+var version = "5.9.0";
 //#endregion
 //#region src/utils.ts
 /**

package/docs/options.md

@@ -25,7 +25,7 @@ const file = ast.factory.createFile({
   meta: {
     frontmatter: { title: 'API Reference', layout: 'doc' },
   },
-  sources: [ast.factory.createSource({ nodes: [ast.factory.createText('# API Reference')] })],
+  sources: [ast.factory.createSource({ nodes: [ast.factory.createText('Endpoints generated from the OpenAPI spec.')] })],
 })
 ```
 
@@ -35,7 +35,7 @@ title: API Reference
 layout: doc
 ---
 
-# API Reference
+Endpoints generated from the OpenAPI spec.
 ```
 
 ::

package/docs/overview.md

@@ -1,24 +1,37 @@
-# Markdown parser
+# Markdown
 
-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.
+The Markdown parser joins a file's source blocks as plain Markdown, separated by blank lines. When a file sets `meta.frontmatter`, the parser writes that object as YAML frontmatter above the content, after the file banner if one is set.
 
 ## 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. Files no parser claims are written as their source text.
+With `defineConfig` from `kubb/config`, Kubb registers the parser by default, next to `parserTs` and `parserTsx`, so no setup is needed. Bundler integrations leave it out. Add it yourself only when you set a custom `parsers` array, because that array replaces the default set. List every parser your plugins need. Files that no parser claims are written as their source text only, without imports, exports, banner, or footer.
+
+## Options worth knowing
+
+The parser takes no options. Plugins control the output through `meta.frontmatter` on each file, and an empty object writes none.
+
+See [Options](https://kubb.dev/extensions/kubb-labs/parser-md/options) for how a plugin sets frontmatter.
 
 ## Example
 
+The config below sets a custom `parsers` array and keeps the Markdown parser in it.
+
 ```typescript [kubb.config.ts]
 import { defineConfig } from 'kubb/config'
 import { parserMd } from '@kubb/parser-md'
 import { parserTs, parserTsx } from '@kubb/parser-ts'
+import { pluginTs } from '@kubb/plugin-ts'
 
 export default defineConfig({
   input: './petStore.yaml',
   output: { path: './src/gen' },
-  parsers: [parserTs(), parserTsx(), parserMd()],
-  plugins: [],
+  parsers: [
+    parserTs(),
+    parserTsx(),
+    parserMd(),
+  ],
+  plugins: [
+    pluginTs(),
+  ],
 })
 ```

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@kubb/parser-md",
-  "version": "5.8.4",
+  "version": "5.9.0",
   "description": "Markdown source file parser for Kubb. Converts the universal AST to `.md` source and renders YAML frontmatter via the `print` helper.",
   "keywords": [
     "codegen",
@@ -60,7 +60,7 @@
     "registry": "https://registry.npmjs.org/"
   },
   "dependencies": {
-    "@kubb/kit": "5.8.4",
+    "@kubb/kit": "5.9.0",
     "yaml": "^2.9.1"
   },
   "engines": {