@vendure-io/docs-provider 0.1.1 → 0.3.0

package/README.md

@@ -8,6 +8,7 @@ Contract types and utilities for Vendure documentation packages. This package de
 - [Creating a Docs Package](./docs/creating-a-docs-package.md) - Step-by-step guide to building a documentation package
 - [Manifest Reference](./docs/manifest-reference.md) - Complete API documentation for manifest types and utilities
 - [Frontmatter Reference](./docs/frontmatter-reference.md) - All available MDX frontmatter options
+- [MDX Components Reference](./docs/mdx-components-reference.md) - Available MDX components for reference documentation
 - [Publishing](./docs/publishing.md) - How to publish and integrate with vendure.io
 
 ## Installation
@@ -171,6 +172,17 @@ if (hasFrontmatter(mdxContent)) {
 | `LoadedDocsPackage`   | Result of loading a docs package                      |
 | `GitHubConfig`        | GitHub repository configuration for edit links        |
 
+### MDX Component Props
+
+| Type                       | Description                             |
+| -------------------------- | --------------------------------------- |
+| `GenerationInfoProps`      | Props for GenerationInfo component      |
+| `MemberInfoProps`          | Props for MemberInfo component          |
+| `MemberDescriptionProps`   | Props for MemberDescription component   |
+| `CustomFieldPropertyProps` | Props for CustomFieldProperty component |
+| `StackblitzProps`          | Props for Stackblitz component          |
+| `MdxComponentProps`        | Union type of all MDX component props   |
+
 ### Schemas (Zod)
 
 All types have corresponding Zod schemas for runtime validation:

package/dist/index.cjs

@@ -1 +1 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./manifest-D2yANQB-.cjs");function i(o){const a=[];return r(o.navigation,a),a}function r(o,a){for(const t of o)t.file&&a.push(t.file),t.children&&r(t.children,a)}exports.BreadcrumbItemSchema=e.BreadcrumbItemSchema;exports.DocPageMetaSchema=e.DocPageMetaSchema;exports.DocPageSchema=e.DocPageSchema;exports.DocsPackageManifestSchema=e.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=e.FlatNavigationNodeSchema;exports.FrontmatterParseError=e.FrontmatterParseError;exports.GitHubConfigSchema=e.GitHubConfigSchema;exports.LoadedDocsPackageSchema=e.LoadedDocsPackageSchema;exports.ManifestValidationError=e.ManifestValidationError;exports.NavigationNodeSchema=e.NavigationNodeSchema;exports.SearchConfigSchema=e.SearchConfigSchema;exports.VendureVersionSchema=e.VendureVersionSchema;exports.buildBreadcrumbs=e.buildBreadcrumbs;exports.extractFrontmatterData=e.extractFrontmatterData;exports.findNavigationNode=e.findNavigationNode;exports.flattenNavigation=e.flattenNavigation;exports.getLeafNodes=e.getLeafNodes;exports.getNodesAtDepth=e.getNodesAtDepth;exports.getPrevNextNodes=e.getPrevNextNodes;exports.hasFrontmatter=e.hasFrontmatter;exports.isNodeActive=e.isNodeActive;exports.parseFrontmatter=e.parseFrontmatter;exports.validateFrontmatter=e.validateFrontmatter;exports.validateManifest=e.validateManifest;exports.getAllFilePaths=i;
+"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const e=require("./manifest-CNnJGNwK.cjs");function i(o){const a=[];return r(o.navigation,a),a}function r(o,a){for(const t of o)t.file&&a.push(t.file),t.children&&r(t.children,a)}exports.BreadcrumbItemSchema=e.BreadcrumbItemSchema;exports.DocPageMetaSchema=e.DocPageMetaSchema;exports.DocPageSchema=e.DocPageSchema;exports.DocsPackageManifestSchema=e.DocsPackageManifestSchema;exports.FlatNavigationNodeSchema=e.FlatNavigationNodeSchema;exports.FrontmatterParseError=e.FrontmatterParseError;exports.GitHubConfigSchema=e.GitHubConfigSchema;exports.LoadedDocsPackageSchema=e.LoadedDocsPackageSchema;exports.ManifestValidationError=e.ManifestValidationError;exports.NavigationNodeSchema=e.NavigationNodeSchema;exports.SearchConfigSchema=e.SearchConfigSchema;exports.VendureVersionSchema=e.VendureVersionSchema;exports.buildBreadcrumbs=e.buildBreadcrumbs;exports.extractFrontmatterData=e.extractFrontmatterData;exports.findNavigationNode=e.findNavigationNode;exports.flattenNavigation=e.flattenNavigation;exports.getLeafNodes=e.getLeafNodes;exports.getNodesAtDepth=e.getNodesAtDepth;exports.getPrevNextNodes=e.getPrevNextNodes;exports.hasFrontmatter=e.hasFrontmatter;exports.isNodeActive=e.isNodeActive;exports.parseFrontmatter=e.parseFrontmatter;exports.validateFrontmatter=e.validateFrontmatter;exports.validateManifest=e.validateManifest;exports.getAllFilePaths=i;

package/dist/index.d.ts

@@ -4,4 +4,5 @@ export { FrontmatterParseError, extractFrontmatterData, hasFrontmatter, parseFro
 export type { ParsedFrontmatter } from './frontmatter';
 export { ManifestValidationError, buildBreadcrumbs, findNavigationNode, flattenNavigation, getLeafNodes, getNodesAtDepth, getPrevNextNodes, isNodeActive, validateManifest, } from './manifest';
 export { getAllFilePaths } from './navigation-utils';
+export type { CustomFieldPropertyProps, GenerationInfoProps, GraphQLDocProps, MdxComponentProps, MemberDescriptionProps, MemberInfoProps, StackblitzProps, } from './mdx-components';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAA;AAGhB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AAGjB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAGtD,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GACjB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../src/index.ts"],"names":[],"mappings":"AACA,YAAY,EACV,cAAc,EACd,OAAO,EACP,WAAW,EACX,mBAAmB,EACnB,kBAAkB,EAClB,YAAY,EACZ,iBAAiB,EACjB,cAAc,EACd,YAAY,EACZ,cAAc,GACf,MAAM,SAAS,CAAA;AAGhB,OAAO,EACL,oBAAoB,EACpB,iBAAiB,EACjB,aAAa,EACb,yBAAyB,EACzB,wBAAwB,EACxB,kBAAkB,EAClB,uBAAuB,EACvB,oBAAoB,EACpB,kBAAkB,EAClB,oBAAoB,GACrB,MAAM,UAAU,CAAA;AAGjB,OAAO,EACL,qBAAqB,EACrB,sBAAsB,EACtB,cAAc,EACd,gBAAgB,EAChB,mBAAmB,GACpB,MAAM,eAAe,CAAA;AACtB,YAAY,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAA;AAGtD,OAAO,EACL,uBAAuB,EACvB,gBAAgB,EAChB,kBAAkB,EAClB,iBAAiB,EACjB,YAAY,EACZ,eAAe,EACf,gBAAgB,EAChB,YAAY,EACZ,gBAAgB,GACjB,MAAM,YAAY,CAAA;AAGnB,OAAO,EAAE,eAAe,EAAE,MAAM,oBAAoB,CAAA;AAGpD,YAAY,EACV,wBAAwB,EACxB,mBAAmB,EACnB,eAAe,EACf,iBAAiB,EACjB,sBAAsB,EACtB,eAAe,EACf,eAAe,GAChB,MAAM,kBAAkB,CAAA"}

package/dist/index.js

@@ -1,4 +1,4 @@
-import { B as n, D as c, a as d, b as m, F as h, c as f, G as l, L as g, M as N, N as S, S as v, V as u, d as F, e as P, f as D, g as p, i as b, j as M, k as x, h as V, l as k, p as A, v as B, m as L } from "./manifest-B1CxKK1i.js";
+import { B as n, D as c, a as d, b as m, F as h, c as f, G as l, L as g, M as N, N as S, S as v, V as u, d as F, e as P, f as D, g as p, i as b, j as M, k as x, h as V, l as k, p as A, v as B, m as L } from "./manifest-BJ3t6hu2.js";
 function o(t) {
   const a = [];
   return s(t.navigation, a), a;

package/dist/loader.cjs

@@ -1 +1 @@
-"use strict";var g=Object.defineProperty;var h=(e,r,t)=>r in e?g(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>h(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const P=require("fs/promises"),m=require("module"),u=require("./manifest-D2yANQB-.cjs");var c=typeof document<"u"?document.currentScript:null;class a extends Error{constructor(t,n){super(t);i(this,"packageName");this.name="DocsPackageLoadError",this.packageName=n}}async function p(e,r={}){try{const t=r.resolver?await r.resolver(e):l(e),n=await import(e);if(!n.manifest)throw new a(`Package "${e}" does not export a manifest`,e);return{manifest:u.validateManifest(n.manifest),basePath:t}}catch(t){throw t instanceof a?t:new a(`Failed to load docs package "${e}": ${t instanceof Error?t.message:String(t)}`,e)}}function l(e){try{return m.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("loader.cjs",document.baseURI).href).resolve(`${e}/package.json`).replace(/\/package\.json$/,"")}catch{throw new a(`Cannot resolve package "${e}". Make sure it is installed.`,e)}}async function d(e,r){try{const t=`${e.basePath}/${r}`,n=await P.readFile(t,"utf-8"),{meta:o,content:s}=u.parseFrontmatter(n,r);return{meta:o,content:s,filePath:r}}catch(t){throw new a(`Failed to load doc page "${r}": ${t instanceof Error?t.message:String(t)}`,e.manifest.id)}}async function $(e,r){const t=f(e.manifest.navigation,r.split("/"));if(t!=null&&t.file)return d(e,t.file)}function f(e,r){if(r.length===0)return;const[t,...n]=r,o=e.find(s=>s.slug===t);if(o){if(n.length===0)return o;if(o.children)return f(o.children,n)}}function v(e,r){if(r.file)return`${e.basePath}/${r.file}`}function y(e){try{return l(e),!0}catch{return!1}}exports.DocsPackageLoadError=a;exports.isDocsPackageInstalled=y;exports.loadDocPage=d;exports.loadDocPageBySlug=$;exports.loadDocsPackage=p;exports.resolveFilePath=v;
+"use strict";var g=Object.defineProperty;var h=(e,r,t)=>r in e?g(e,r,{enumerable:!0,configurable:!0,writable:!0,value:t}):e[r]=t;var i=(e,r,t)=>h(e,typeof r!="symbol"?r+"":r,t);Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const P=require("fs/promises"),m=require("module"),u=require("./manifest-CNnJGNwK.cjs");var c=typeof document<"u"?document.currentScript:null;class a extends Error{constructor(t,n){super(t);i(this,"packageName");this.name="DocsPackageLoadError",this.packageName=n}}async function p(e,r={}){try{const t=r.resolver?await r.resolver(e):l(e),n=await import(e);if(!n.manifest)throw new a(`Package "${e}" does not export a manifest`,e);return{manifest:u.validateManifest(n.manifest),basePath:t}}catch(t){throw t instanceof a?t:new a(`Failed to load docs package "${e}": ${t instanceof Error?t.message:String(t)}`,e)}}function l(e){try{return m.createRequire(typeof document>"u"?require("url").pathToFileURL(__filename).href:c&&c.tagName.toUpperCase()==="SCRIPT"&&c.src||new URL("loader.cjs",document.baseURI).href).resolve(`${e}/package.json`).replace(/\/package\.json$/,"")}catch{throw new a(`Cannot resolve package "${e}". Make sure it is installed.`,e)}}async function d(e,r){try{const t=`${e.basePath}/${r}`,n=await P.readFile(t,"utf-8"),{meta:o,content:s}=u.parseFrontmatter(n,r);return{meta:o,content:s,filePath:r}}catch(t){throw new a(`Failed to load doc page "${r}": ${t instanceof Error?t.message:String(t)}`,e.manifest.id)}}async function $(e,r){const t=f(e.manifest.navigation,r.split("/"));if(t!=null&&t.file)return d(e,t.file)}function f(e,r){if(r.length===0)return;const[t,...n]=r,o=e.find(s=>s.slug===t);if(o){if(n.length===0)return o;if(o.children)return f(o.children,n)}}function v(e,r){if(r.file)return`${e.basePath}/${r.file}`}function y(e){try{return l(e),!0}catch{return!1}}exports.DocsPackageLoadError=a;exports.isDocsPackageInstalled=y;exports.loadDocPage=d;exports.loadDocPageBySlug=$;exports.loadDocsPackage=p;exports.resolveFilePath=v;

package/dist/loader.js

@@ -3,7 +3,7 @@ var l = (t, e, r) => e in t ? f(t, e, { enumerable: !0, configurable: !0, writab
 var i = (t, e, r) => l(t, typeof e != "symbol" ? e + "" : e, r);
 import { readFile as d } from "fs/promises";
 import { createRequire as h } from "module";
-import { m as g, p as m } from "./manifest-B1CxKK1i.js";
+import { m as g, p as m } from "./manifest-BJ3t6hu2.js";
 class a extends Error {
   constructor(r, n) {
     super(r);

package/dist/{manifest-B1CxKK1i.js → manifest-BJ3t6hu2.js}

@@ -1,31 +1,32 @@
 var N = Object.defineProperty;
-var S = (r, e, n) => e in r ? N(r, e, { enumerable: !0, configurable: !0, writable: !0, value: n }) : r[e] = n;
-var l = (r, e, n) => S(r, typeof e != "symbol" ? e + "" : e, n);
-import g from "gray-matter";
+var P = (r, e, n) => e in r ? N(r, e, { enumerable: !0, configurable: !0, writable: !0, value: n }) : r[e] = n;
+var l = (r, e, n) => P(r, typeof e != "symbol" ? e + "" : e, n);
+import u from "gray-matter";
 import { z as t } from "zod";
-const P = t.enum(["v1", "v2", "v3"]), j = t.object({
+const S = t.enum(["v1", "v2", "v3"]), j = t.object({
   indexFields: t.array(t.enum(["title", "description", "content", "keywords"])),
   boosts: t.record(t.string(), t.number()).optional()
 }), $ = t.object({
   repository: t.string().regex(/^[^/]+\/[^/]+$/, 'Repository must be in format "owner/repo"'),
   branch: t.string().optional(),
   docsPath: t.string().optional()
-}), u = t.lazy(
+}), g = t.lazy(
   () => t.object({
     title: t.string().min(1, "Navigation title is required"),
     slug: t.string().min(1, "Navigation slug is required"),
     file: t.string().optional(),
-    children: t.array(u).optional(),
+    children: t.array(g).optional(),
     badge: t.string().optional()
   })
 ), f = t.object({
   id: t.string().min(1, "Package ID is required"),
   name: t.string().min(1, "Package name is required"),
   version: t.string().regex(/^\d+\.\d+\.\d+/, "Version must be valid semver"),
-  vendureVersion: P,
-  navigation: t.array(u),
+  vendureVersion: S,
+  navigation: t.array(g),
   search: j.optional(),
-  github: $.optional()
+  github: $.optional(),
+  basePath: t.string().optional()
 }), m = t.object({
   title: t.string().min(1, "Page title is required"),
   description: t.string().optional(),
@@ -47,7 +48,7 @@ const P = t.enum(["v1", "v2", "v3"]), j = t.object({
   title: t.string(),
   slug: t.string(),
   file: t.string().optional(),
-  children: t.array(t.lazy(() => u)).optional(),
+  children: t.array(t.lazy(() => g)).optional(),
   badge: t.string().optional(),
   path: t.string(),
   depth: t.number().int().min(0),
@@ -63,7 +64,7 @@ class d extends Error {
 }
 function q(r, e) {
   try {
-    const { data: n, content: i } = g(r);
+    const { data: n, content: i } = u(r);
     return {
       meta: y(n, e),
       content: i.trim()
@@ -94,7 +95,7 @@ function L(r) {
   return r.trimStart().startsWith("---");
 }
 function z(r) {
-  const { data: e } = g(r);
+  const { data: e } = u(r);
   return e;
 }
 class x extends Error {
@@ -186,9 +187,9 @@ export {
   $ as G,
   B as L,
   x as M,
-  u as N,
+  g as N,
   j as S,
-  P as V,
+  S as V,
   M as a,
   f as b,
   d as c,

package/dist/{manifest-D2yANQB-.cjs → manifest-CNnJGNwK.cjs}

@@ -1,3 +1,3 @@
-"use strict";var y=Object.defineProperty;var D=(r,e,n)=>e in r?y(r,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):r[e]=n;var d=(r,e,n)=>D(r,typeof e!="symbol"?e+"":e,n);const h=require("gray-matter"),t=require("zod"),z=t.z.enum(["v1","v2","v3"]),p=t.z.object({indexFields:t.z.array(t.z.enum(["title","description","content","keywords"])),boosts:t.z.record(t.z.string(),t.z.number()).optional()}),v=t.z.object({repository:t.z.string().regex(/^[^/]+\/[^/]+$/,'Repository must be in format "owner/repo"'),branch:t.z.string().optional(),docsPath:t.z.string().optional()}),g=t.z.lazy(()=>t.z.object({title:t.z.string().min(1,"Navigation title is required"),slug:t.z.string().min(1,"Navigation slug is required"),file:t.z.string().optional(),children:t.z.array(g).optional(),badge:t.z.string().optional()})),u=t.z.object({id:t.z.string().min(1,"Package ID is required"),name:t.z.string().min(1,"Package name is required"),version:t.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:z,navigation:t.z.array(g),search:p.optional(),github:v.optional()}),m=t.z.object({title:t.z.string().min(1,"Page title is required"),description:t.z.string().optional(),keywords:t.z.array(t.z.string()).optional(),sidebarLabel:t.z.string().optional(),hidden:t.z.boolean().optional()}),x=t.z.object({meta:m,content:t.z.string(),filePath:t.z.string()}),M=t.z.object({manifest:u,basePath:t.z.string()}),w=t.z.object({title:t.z.string(),slug:t.z.string(),path:t.z.string()}),E=t.z.object({title:t.z.string(),slug:t.z.string(),file:t.z.string().optional(),children:t.z.array(t.z.lazy(()=>g)).optional(),badge:t.z.string().optional(),path:t.z.string(),depth:t.z.number().int().min(0),parentPath:t.z.string().optional()});class l extends Error{constructor(n,i,a){super(n);d(this,"filePath");d(this,"originalError");this.name="FrontmatterParseError",this.filePath=i,this.originalError=a}}function k(r,e){try{const{data:n,content:i}=h(r);return{meta:b(n,e),content:i.trim()}}catch(n){throw n instanceof l?n:new l(`Failed to parse frontmatter${e?` in ${e}`:""}`,e,n)}}function b(r,e){const n=m.safeParse(r);if(!n.success){const i=n.error.issues.map(a=>`  - ${a.path.join(".")}: ${a.message}`).join(`
+"use strict";var y=Object.defineProperty;var D=(r,e,n)=>e in r?y(r,e,{enumerable:!0,configurable:!0,writable:!0,value:n}):r[e]=n;var d=(r,e,n)=>D(r,typeof e!="symbol"?e+"":e,n);const h=require("gray-matter"),t=require("zod"),z=t.z.enum(["v1","v2","v3"]),p=t.z.object({indexFields:t.z.array(t.z.enum(["title","description","content","keywords"])),boosts:t.z.record(t.z.string(),t.z.number()).optional()}),v=t.z.object({repository:t.z.string().regex(/^[^/]+\/[^/]+$/,'Repository must be in format "owner/repo"'),branch:t.z.string().optional(),docsPath:t.z.string().optional()}),g=t.z.lazy(()=>t.z.object({title:t.z.string().min(1,"Navigation title is required"),slug:t.z.string().min(1,"Navigation slug is required"),file:t.z.string().optional(),children:t.z.array(g).optional(),badge:t.z.string().optional()})),u=t.z.object({id:t.z.string().min(1,"Package ID is required"),name:t.z.string().min(1,"Package name is required"),version:t.z.string().regex(/^\d+\.\d+\.\d+/,"Version must be valid semver"),vendureVersion:z,navigation:t.z.array(g),search:p.optional(),github:v.optional(),basePath:t.z.string().optional()}),m=t.z.object({title:t.z.string().min(1,"Page title is required"),description:t.z.string().optional(),keywords:t.z.array(t.z.string()).optional(),sidebarLabel:t.z.string().optional(),hidden:t.z.boolean().optional()}),x=t.z.object({meta:m,content:t.z.string(),filePath:t.z.string()}),M=t.z.object({manifest:u,basePath:t.z.string()}),w=t.z.object({title:t.z.string(),slug:t.z.string(),path:t.z.string()}),E=t.z.object({title:t.z.string(),slug:t.z.string(),file:t.z.string().optional(),children:t.z.array(t.z.lazy(()=>g)).optional(),badge:t.z.string().optional(),path:t.z.string(),depth:t.z.number().int().min(0),parentPath:t.z.string().optional()});class l extends Error{constructor(n,i,a){super(n);d(this,"filePath");d(this,"originalError");this.name="FrontmatterParseError",this.filePath=i,this.originalError=a}}function k(r,e){try{const{data:n,content:i}=h(r);return{meta:b(n,e),content:i.trim()}}catch(n){throw n instanceof l?n:new l(`Failed to parse frontmatter${e?` in ${e}`:""}`,e,n)}}function b(r,e){const n=m.safeParse(r);if(!n.success){const i=n.error.issues.map(a=>`  - ${a.path.join(".")}: ${a.message}`).join(`
 `);throw new l(`Invalid frontmatter${e?` in ${e}`:""}:
 ${i}`,e,n.error)}return n.data}function V(r){return r.trimStart().startsWith("---")}function B(r){const{data:e}=h(r);return e}class N extends Error{constructor(n,i){super(n);d(this,"issues");this.name="ManifestValidationError",this.issues=i}}function q(r){const e=u.safeParse(r);if(!e.success){const n=e.error.issues.map(i=>`${i.path.join(".")}: ${i.message}`);throw new N("Invalid manifest",n)}return e.data}function I(r,e){const n=e.split("/").filter(Boolean);return S(r.navigation,n)}function S(r,e){if(e.length===0)return;const[n,...i]=e,a=r.find(o=>o.slug===n);if(a){if(i.length===0)return a;if(a.children)return S(a.children,i)}}function f(r){const e=[];return P(r.navigation,"",0,void 0,e),e}function P(r,e,n,i,a){for(const o of r){const s=e?`${e}/${o.slug}`:o.slug;a.push({...o,path:s,depth:n,parentPath:i}),o.children&&o.children.length>0&&P(o.children,s,n+1,s,a)}}function L(r,e){const n=e.split("/").filter(Boolean),i=[];let a=r.navigation,o="";for(const s of n){const c=a.find(j=>j.slug===s);if(!c)break;o=o?`${o}/${s}`:s,i.push({title:c.title,slug:c.slug,path:o}),a=c.children??[]}return i}function F(r){return f(r).filter(e=>e.file!==void 0)}function A(r,e){const n=F(r),i=n.findIndex(a=>a.path===e);return i===-1?{}:{prev:i>0?n[i-1]:void 0,next:i<n.length-1?n[i+1]:void 0}}function $(r,e){const n=e.split("/").filter(Boolean);if(n.length===0)return!1;if(r.slug===n[0]){if(n.length===1)return!0;if(r.children){const i=n.slice(1).join("/");return r.children.some(a=>$(a,i))}}return!1}function C(r,e){return f(r).filter(n=>n.depth===e)}exports.BreadcrumbItemSchema=w;exports.DocPageMetaSchema=m;exports.DocPageSchema=x;exports.DocsPackageManifestSchema=u;exports.FlatNavigationNodeSchema=E;exports.FrontmatterParseError=l;exports.GitHubConfigSchema=v;exports.LoadedDocsPackageSchema=M;exports.ManifestValidationError=N;exports.NavigationNodeSchema=g;exports.SearchConfigSchema=p;exports.VendureVersionSchema=z;exports.buildBreadcrumbs=L;exports.extractFrontmatterData=B;exports.findNavigationNode=I;exports.flattenNavigation=f;exports.getLeafNodes=F;exports.getNodesAtDepth=C;exports.getPrevNextNodes=A;exports.hasFrontmatter=V;exports.isNodeActive=$;exports.parseFrontmatter=k;exports.validateFrontmatter=b;exports.validateManifest=q;

package/dist/mdx-components.d.ts

@@ -0,0 +1,160 @@
+/**
+ * MDX Component Contract Types
+ *
+ * This file defines TypeScript interfaces for MDX components used in Vendure documentation.
+ * These contracts are framework-agnostic (no React dependency) and define the expected
+ * props for each component.
+ *
+ * The actual React implementations live in `apps/docs/src/components/mdx/`.
+ */
+/**
+ * GenerationInfo Component
+ *
+ * Displays package metadata with NPM and GitHub source links.
+ * Typically shown at the top of reference documentation pages.
+ *
+ * @example
+ * ```mdx
+ * <GenerationInfo
+ *   packageName="@vendure/core"
+ *   sourceFile="src/entity/product.entity.ts"
+ *   sourceLine={42}
+ *   since="1.0.0"
+ * />
+ * ```
+ */
+export interface GenerationInfoProps {
+    /** NPM package name (e.g., "@vendure/core") */
+    packageName: string;
+    /** Path to source file relative to package root */
+    sourceFile: string;
+    /** Line number in source file */
+    sourceLine: number;
+    /** Version when this API was introduced */
+    since?: string;
+    /** Mark as experimental API */
+    experimental?: boolean;
+}
+/**
+ * MemberInfo Component
+ *
+ * Displays type information for class/interface members.
+ * Used in TypeScript API reference documentation.
+ *
+ * @example
+ * ```mdx
+ * <MemberInfo
+ *   kind="method"
+ *   type={<>(<a href="/reference/ctx">RequestContext</a>) =&gt; Promise&lt;Product&gt;</>}
+ *   since="2.0.0"
+ * />
+ * ```
+ */
+export interface MemberInfoProps {
+    /** Member kind: method, property, getter, setter, constructor */
+    kind: 'method' | 'property' | 'getter' | 'setter' | 'constructor';
+    /** TypeScript type signature (accepts JSX with links) */
+    type: unknown;
+    /** Version when this member was introduced */
+    since?: string;
+    /** Mark as experimental API */
+    experimental?: boolean;
+    /** Default value (accepts JSX) */
+    default?: unknown;
+}
+/**
+ * MemberDescription Component
+ *
+ * Simple wrapper for member descriptions in API reference documentation.
+ * Provides consistent styling for description content.
+ *
+ * @example
+ * ```mdx
+ * <MemberDescription>
+ *   The `Product` entity represents items in your catalog.
+ *   It includes pricing, variants, and inventory information.
+ * </MemberDescription>
+ * ```
+ */
+export interface MemberDescriptionProps {
+    /** Description content (MDX/JSX) */
+    children: unknown;
+}
+/**
+ * CustomFieldProperty Component
+ *
+ * Shows required/optional status and type information for custom fields.
+ * Used in custom field configuration documentation.
+ *
+ * @example
+ * ```mdx
+ * <CustomFieldProperty required={true} type="string" typeLink="/reference/types/string" />
+ * ```
+ */
+export interface CustomFieldPropertyProps {
+    /** Whether the field is required */
+    required: boolean;
+    /** Type name to display */
+    type: string;
+    /** Optional link for the type */
+    typeLink?: string;
+}
+/**
+ * Stackblitz Component
+ *
+ * Embeds a Stackblitz editor for interactive code examples.
+ *
+ * @example
+ * ```mdx
+ * <Stackblitz id="vendure-getting-started" />
+ * ```
+ */
+export interface StackblitzProps {
+    /** Stackblitz project ID */
+    id: string;
+}
+/**
+ * GraphQLDoc Component
+ *
+ * Displays GraphQL schema definitions with syntax highlighting and clickable type links.
+ * Used in GraphQL API reference documentation.
+ *
+ * @example
+ * ```mdx
+ * <GraphQLDoc
+ *   type="mutation"
+ *   typeName="addCustomersToGroup"
+ *   since="1.0.0"
+ *   typeLinks={{
+ *     "CustomerGroup": "/v3/vendure/reference/graphql-api/admin/customer-group",
+ *     "ID": "/v3/vendure/reference/graphql-api/common/scalars#id"
+ *   }}
+ * >
+ * {`"""
+ * Add Customers to a CustomerGroup
+ * """
+ * type Mutation {
+ *   addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
+ * }`}
+ * </GraphQLDoc>
+ * ```
+ */
+export interface GraphQLDocProps {
+    /** GraphQL definition kind */
+    type: 'mutation' | 'query' | 'subscription' | 'type' | 'input' | 'enum' | 'scalar' | 'interface' | 'union' | 'fragment';
+    /** The primary type/operation name */
+    typeName: string;
+    /** Version when this API was introduced */
+    since?: string;
+    /** Mark as deprecated */
+    deprecated?: boolean | string;
+    /** Map of type names to their documentation URLs. Only types in this map become clickable. */
+    typeLinks?: Record<string, string>;
+    /** GraphQL SDL content */
+    children: unknown;
+}
+/**
+ * Union type of all MDX component props for type checking
+ */
+export type MdxComponentProps = GenerationInfoProps | MemberInfoProps | MemberDescriptionProps | CustomFieldPropertyProps | StackblitzProps | GraphQLDocProps;
+//# sourceMappingURL=mdx-components.d.ts.map

package/dist/mdx-components.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"mdx-components.d.ts","sourceRoot":"","sources":["../src/mdx-components.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH;;;;;;;;;;;;;;;GAeG;AACH,MAAM,WAAW,mBAAmB;IAClC,+CAA+C;IAC/C,WAAW,EAAE,MAAM,CAAA;IACnB,mDAAmD;IACnD,UAAU,EAAE,MAAM,CAAA;IAClB,iCAAiC;IACjC,UAAU,EAAE,MAAM,CAAA;IAClB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;CACvB;AAED;;;;;;;;;;;;;;GAcG;AACH,MAAM,WAAW,eAAe;IAC9B,iEAAiE;IACjE,IAAI,EAAE,QAAQ,GAAG,UAAU,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,CAAA;IACjE,yDAAyD;IACzD,IAAI,EAAE,OAAO,CAAA;IACb,8CAA8C;IAC9C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,+BAA+B;IAC/B,YAAY,CAAC,EAAE,OAAO,CAAA;IACtB,kCAAkC;IAClC,OAAO,CAAC,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;;;;GAaG;AACH,MAAM,WAAW,sBAAsB;IACrC,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;;;;;;;;;GAUG;AACH,MAAM,WAAW,wBAAwB;IACvC,oCAAoC;IACpC,QAAQ,EAAE,OAAO,CAAA;IACjB,2BAA2B;IAC3B,IAAI,EAAE,MAAM,CAAA;IACZ,iCAAiC;IACjC,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,eAAe;IAC9B,4BAA4B;IAC5B,EAAE,EAAE,MAAM,CAAA;CACX;AAED;;;;;;;;;;;;;;;;;;;;;;;;;GAyBG;AACH,MAAM,WAAW,eAAe;IAC9B,8BAA8B;IAC9B,IAAI,EACA,UAAU,GACV,OAAO,GACP,cAAc,GACd,MAAM,GACN,OAAO,GACP,MAAM,GACN,QAAQ,GACR,WAAW,GACX,OAAO,GACP,UAAU,CAAA;IACd,sCAAsC;IACtC,QAAQ,EAAE,MAAM,CAAA;IAChB,2CAA2C;IAC3C,KAAK,CAAC,EAAE,MAAM,CAAA;IACd,yBAAyB;IACzB,UAAU,CAAC,EAAE,OAAO,GAAG,MAAM,CAAA;IAC7B,8FAA8F;IAC9F,SAAS,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;IAClC,0BAA0B;IAC1B,QAAQ,EAAE,OAAO,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,MAAM,iBAAiB,GACzB,mBAAmB,GACnB,eAAe,GACf,sBAAsB,GACtB,wBAAwB,GACxB,eAAe,GACf,eAAe,CAAA"}

package/dist/schema.d.ts

@@ -86,6 +86,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
         branch?: string | undefined;
         docsPath?: string | undefined;
     }>>;
+    basePath: z.ZodOptional<z.ZodString>;
 }, "strip", z.ZodTypeAny, {
     id: string;
     name: string;
@@ -107,6 +108,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
         branch?: string | undefined;
         docsPath?: string | undefined;
     } | undefined;
+    basePath?: string | undefined;
 }, {
     id: string;
     name: string;
@@ -128,6 +130,7 @@ export declare const DocsPackageManifestSchema: z.ZodObject<{
         branch?: string | undefined;
         docsPath?: string | undefined;
     } | undefined;
+    basePath?: string | undefined;
 }>;
 /**
  * Schema for documentation page frontmatter/metadata
@@ -242,6 +245,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
             branch?: string | undefined;
             docsPath?: string | undefined;
         }>>;
+        basePath: z.ZodOptional<z.ZodString>;
     }, "strip", z.ZodTypeAny, {
         id: string;
         name: string;
@@ -263,6 +267,7 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
             branch?: string | undefined;
             docsPath?: string | undefined;
         } | undefined;
+        basePath?: string | undefined;
     }, {
         id: string;
         name: string;
@@ -284,9 +289,11 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
             branch?: string | undefined;
             docsPath?: string | undefined;
         } | undefined;
+        basePath?: string | undefined;
     }>;
     basePath: z.ZodString;
 }, "strip", z.ZodTypeAny, {
+    basePath: string;
     manifest: {
         id: string;
         name: string;
@@ -308,9 +315,10 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
             branch?: string | undefined;
             docsPath?: string | undefined;
         } | undefined;
+        basePath?: string | undefined;
     };
-    basePath: string;
 }, {
+    basePath: string;
     manifest: {
         id: string;
         name: string;
@@ -332,8 +340,8 @@ export declare const LoadedDocsPackageSchema: z.ZodObject<{
             branch?: string | undefined;
             docsPath?: string | undefined;
         } | undefined;
+        basePath?: string | undefined;
     };
-    basePath: string;
 }>;
 /**
  * Schema for breadcrumb items

package/dist/schema.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAQA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;eAlB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;EAsBd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;EAM5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;mBAnD3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;EAkDd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eApE5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;EAyEd,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}
+{"version":3,"file":"schema.d.ts","sourceRoot":"","sources":["../src/schema.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,CAAC,EAAE,MAAM,KAAK,CAAA;AAEvB;;GAEG;AACH,eAAO,MAAM,oBAAoB,+BAA6B,CAAA;AAE9D;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;EAG7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,kBAAkB;;;;;;;;;;;;EAI7B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB,EAAE,CAAC,CAAC,OAAO,CAAC;IAC3C,KAAK,EAAE,MAAM,CAAA;IACb,IAAI,EAAE,MAAM,CAAA;IACZ,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,QAAQ,CAAC,EAAE,OAAO,EAAE,CAAA;IACpB,KAAK,CAAC,EAAE,MAAM,CAAA;CACf,CAQA,CAAA;AAED;;GAEG;AACH,eAAO,MAAM,yBAAyB;;;;;;eAlB7B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;EAuBd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,iBAAiB;;;;;;;;;;;;;;;;;;EAM5B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,aAAa;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;EAIxB,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,uBAAuB;;;;;;;mBApD3B,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;;;;;;;;;mBAJP,MAAM;kBACP,MAAM;mBACL,MAAM;uBACF,OAAO,EAAE;oBACZ,MAAM;;;;;;;;;;;;;EAmDd,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,oBAAoB;;;;;;;;;;;;EAI/B,CAAA;AAEF;;GAEG;AACH,eAAO,MAAM,wBAAwB;;;;;eArE5B,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;;;;;;;;eAJP,MAAM;cACP,MAAM;eACL,MAAM;mBACF,OAAO,EAAE;gBACZ,MAAM;;;;EA0Ed,CAAA;AAGF,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,oBAAoB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,kBAAkB,CAAC,CAAA;AACrE,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,2BAA2B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,yBAAyB,CAAC,CAAA;AACnF,MAAM,MAAM,mBAAmB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,iBAAiB,CAAC,CAAA;AACnE,MAAM,MAAM,eAAe,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,aAAa,CAAC,CAAA;AAC3D,MAAM,MAAM,yBAAyB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,uBAAuB,CAAC,CAAA;AAC/E,MAAM,MAAM,sBAAsB,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,oBAAoB,CAAC,CAAA;AACzE,MAAM,MAAM,0BAA0B,GAAG,CAAC,CAAC,KAAK,CAAC,OAAO,wBAAwB,CAAC,CAAA"}

package/dist/types.d.ts

@@ -55,6 +55,8 @@ export interface DocsPackageManifest {
     search?: SearchConfig;
     /** Optional GitHub repository configuration for edit links and issue reporting */
     github?: GitHubConfig;
+    /** Absolute path to package root for asset resolution (e.g., images) */
+    basePath?: string;
 }
 /**
  * Frontmatter metadata for a documentation page

package/dist/types.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,WAAW,EAAE,CAAC,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC,EAAE,CAAA;IACjE,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,EAAE,EAAE,MAAM,CAAA;IACV,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,cAAc,EAAE,cAAc,CAAA;IAC9B,2CAA2C;IAC3C,UAAU,EAAE,cAAc,EAAE,CAAA;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,kFAAkF;IAClF,MAAM,CAAC,EAAE,YAAY,CAAA;CACtB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,kCAAkC;IAClC,IAAI,EAAE,WAAW,CAAA;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,eAAe;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB"}
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../src/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,MAAM,cAAc,GAAG,IAAI,GAAG,IAAI,GAAG,IAAI,CAAA;AAE/C;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,wCAAwC;IACxC,WAAW,EAAE,CAAC,OAAO,GAAG,aAAa,GAAG,SAAS,GAAG,UAAU,CAAC,EAAE,CAAA;IACjE,8CAA8C;IAC9C,MAAM,CAAC,EAAE,MAAM,CAAC,MAAM,EAAE,MAAM,CAAC,CAAA;CAChC;AAED;;GAEG;AACH,MAAM,WAAW,YAAY;IAC3B,+CAA+C;IAC/C,UAAU,EAAE,MAAM,CAAA;IAClB,wDAAwD;IACxD,MAAM,CAAC,EAAE,MAAM,CAAA;IACf,gEAAgE;IAChE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,wCAAwC;IACxC,KAAK,EAAE,MAAM,CAAA;IACb,6BAA6B;IAC7B,IAAI,EAAE,MAAM,CAAA;IACZ,6DAA6D;IAC7D,IAAI,CAAC,EAAE,MAAM,CAAA;IACb,oCAAoC;IACpC,QAAQ,CAAC,EAAE,cAAc,EAAE,CAAA;IAC3B,+DAA+D;IAC/D,KAAK,CAAC,EAAE,MAAM,CAAA;CACf;AAED;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC,wEAAwE;IACxE,EAAE,EAAE,MAAM,CAAA;IACV,kCAAkC;IAClC,IAAI,EAAE,MAAM,CAAA;IACZ,+BAA+B;IAC/B,OAAO,EAAE,MAAM,CAAA;IACf,iDAAiD;IACjD,cAAc,EAAE,cAAc,CAAA;IAC9B,2CAA2C;IAC3C,UAAU,EAAE,cAAc,EAAE,CAAA;IAC5B,0CAA0C;IAC1C,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,kFAAkF;IAClF,MAAM,CAAC,EAAE,YAAY,CAAA;IACrB,wEAAwE;IACxE,QAAQ,CAAC,EAAE,MAAM,CAAA;CAClB;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IAC1B,iBAAiB;IACjB,KAAK,EAAE,MAAM,CAAA;IACb,4CAA4C;IAC5C,WAAW,CAAC,EAAE,MAAM,CAAA;IACpB,mCAAmC;IACnC,QAAQ,CAAC,EAAE,MAAM,EAAE,CAAA;IACnB,iDAAiD;IACjD,YAAY,CAAC,EAAE,MAAM,CAAA;IACrB,6CAA6C;IAC7C,MAAM,CAAC,EAAE,OAAO,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,OAAO;IACtB,kCAAkC;IAClC,IAAI,EAAE,WAAW,CAAA;IACjB,4CAA4C;IAC5C,OAAO,EAAE,MAAM,CAAA;IACf,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC,6BAA6B;IAC7B,QAAQ,EAAE,mBAAmB,CAAA;IAC7B,4CAA4C;IAC5C,QAAQ,EAAE,MAAM,CAAA;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,cAAc;IAC7B,oBAAoB;IACpB,KAAK,EAAE,MAAM,CAAA;IACb,eAAe;IACf,IAAI,EAAE,MAAM,CAAA;IACZ,0BAA0B;IAC1B,IAAI,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,cAAc;IACxD,iEAAiE;IACjE,IAAI,EAAE,MAAM,CAAA;IACZ,oDAAoD;IACpD,KAAK,EAAE,MAAM,CAAA;IACb,iCAAiC;IACjC,UAAU,CAAC,EAAE,MAAM,CAAA;CACpB"}

package/docs/creating-a-docs-package.md

@@ -130,6 +130,9 @@ export const manifest: DocsPackageManifest = {
   // Target Vendure version
   vendureVersion: 'v3',
 
+  // Package root path - required for image resolution
+  basePath: packageRoot,
+
   // Navigation tree structure
   navigation: [
     {
@@ -291,6 +294,64 @@ This action cannot be undone.
 See the [Configuration Guide](/v3/my-plugin/getting-started/configuration) for more details.
 ```
 
+### Using Images
+
+Images can be placed alongside your MDX files and referenced using relative paths. The docs application automatically resolves these paths and serves images through an API route.
+
+**Place images next to your MDX files:**
+
+```
+docs/
+├── guides/
+│   ├── custom-plugins.mdx
+│   └── diagram.webp          # Image in same directory
+└── getting-started/
+    ├── installation.mdx
+    └── assets/
+        └── screenshot.png    # Image in subdirectory
+```
+
+**Reference images with relative paths:**
+
+```mdx
+<!-- Same directory -->
+
+![Plugin Architecture](./diagram.webp)
+
+<!-- Subdirectory -->
+
+![Installation Screenshot](./assets/screenshot.png)
+
+<!-- Parent directory -->
+
+![Shared Diagram](../shared/overview.png)
+```
+
+**Important:** For images to work, you must set the `basePath` property in your manifest:
+
+```typescript
+export const manifest: DocsPackageManifest = {
+  id: 'my-plugin',
+  basePath: packageRoot, // Required for image resolution
+  // ...
+}
+```
+
+**Supported image formats:**
+
+- PNG (`.png`)
+- JPEG (`.jpg`, `.jpeg`)
+- WebP (`.webp`)
+- GIF (`.gif`)
+- SVG (`.svg`)
+- AVIF (`.avif`)
+
+**How it works:**
+
+1. Relative image paths like `./diagram.webp` are detected during MDX compilation
+2. They're transformed to API routes: `/api/docs-image/my-plugin/docs/guides/diagram.webp`
+3. The API route serves images from the npm package with proper caching headers (1 year, immutable)
+
 ## Step 7: Navigation Structure Patterns
 
 ### Nested Navigation

package/docs/manifest-reference.md

@@ -15,6 +15,7 @@ interface DocsPackageManifest {
   navigation: NavigationNode[]
   search?: SearchConfig
   github?: GitHubConfig
+  basePath?: string
 }
 ```
 
@@ -29,6 +30,7 @@ interface DocsPackageManifest {
 | `navigation`     | `NavigationNode[]` | Yes      | Array of top-level navigation nodes                |
 | `search`         | `SearchConfig`     | No       | Search indexing configuration                      |
 | `github`         | `GitHubConfig`     | No       | GitHub repository configuration for edit links     |
+| `basePath`       | `string`           | No       | Absolute path to package root for asset resolution |
 
 ### Example
 
@@ -38,6 +40,7 @@ const manifest: DocsPackageManifest = {
   name: 'My Plugin Documentation',
   version: '1.0.0',
   vendureVersion: 'v3',
+  basePath: packageRoot, // Enable image resolution
   navigation: [
     {
       title: 'Getting Started',

package/docs/mdx-components-reference.md

@@ -0,0 +1,347 @@
+# MDX Components Reference
+
+This document describes the MDX components available for use in Vendure documentation. These components are particularly useful for TypeScript and GraphQL API reference documentation.
+
+## General Components
+
+### Callout
+
+Displays an informational callout box with different variants.
+
+#### Props
+
+| Prop       | Type                                                              | Default  | Description                    |
+| ---------- | ----------------------------------------------------------------- | -------- | ------------------------------ |
+| `type`     | `'info' \| 'warning' \| 'danger' \| 'tip' \| 'caution' \| 'note'` | `'info'` | The callout variant            |
+| `title`    | `string`                                                          | -        | Optional title for the callout |
+| `children` | `ReactNode`                                                       | -        | Content of the callout         |
+
+#### Example
+
+```mdx
+<Callout
+  type="warning"
+  title="Deprecation Notice"
+>
+  This API will be removed in version 4.0. Please migrate to the new API.
+</Callout>
+
+<Callout type="tip">Use the `RequestContext` to access the current user and channel.</Callout>
+```
+
+### Stackblitz
+
+Embeds a Stackblitz editor for interactive code examples.
+
+#### Props
+
+| Prop | Type     | Required | Description               |
+| ---- | -------- | -------- | ------------------------- |
+| `id` | `string` | Yes      | The Stackblitz project ID |
+
+#### Example
+
+```mdx
+<Stackblitz id="vendure-getting-started" />
+```
+
+---
+
+## Reference Documentation Components
+
+These components are designed for TypeScript/GraphQL API reference documentation.
+
+### GenerationInfo
+
+Displays package metadata with NPM and GitHub source links. Typically shown at the top of reference documentation pages.
+
+#### Props
+
+| Prop           | Type      | Required | Description                                  |
+| -------------- | --------- | -------- | -------------------------------------------- |
+| `packageName`  | `string`  | Yes      | NPM package name (e.g., `@vendure/core`)     |
+| `sourceFile`   | `string`  | Yes      | Path to source file relative to package root |
+| `sourceLine`   | `number`  | Yes      | Line number in source file                   |
+| `since`        | `string`  | No       | Version when this API was introduced         |
+| `experimental` | `boolean` | No       | Mark as experimental API                     |
+
+#### Example
+
+```mdx
+<GenerationInfo
+  packageName="@vendure/core"
+  sourceFile="src/entity/product.entity.ts"
+  sourceLine={42}
+  since="1.0.0"
+/>
+
+<GenerationInfo
+  packageName="@vendure/core"
+  sourceFile="src/service/services/product.service.ts"
+  sourceLine={156}
+  experimental={true}
+/>
+```
+
+### MemberInfo
+
+Displays type information for class/interface members. Used in TypeScript API reference documentation.
+
+#### Props
+
+| Prop           | Type                                                              | Required | Description                                        |
+| -------------- | ----------------------------------------------------------------- | -------- | -------------------------------------------------- |
+| `kind`         | `'method' \| 'property' \| 'getter' \| 'setter' \| 'constructor'` | Yes      | The kind of member                                 |
+| `type`         | `ReactNode`                                                       | Yes      | TypeScript type signature (accepts JSX with links) |
+| `since`        | `string`                                                          | No       | Version when this member was introduced            |
+| `experimental` | `boolean`                                                         | No       | Mark as experimental API                           |
+| `default`      | `ReactNode`                                                       | No       | Default value (accepts JSX)                        |
+
+#### Example
+
+```mdx
+{/* Simple property */}
+
+<MemberInfo
+  kind="property"
+  type={<>string</>}
+  default={<>'default-value'</>}
+/>
+
+{/* Method with type links */}
+
+<MemberInfo
+  kind="method"
+  type={
+    <>
+      (<a href="/reference/ctx">RequestContext</a>, productId: <a href="/reference/id">ID</a>) =&gt;
+      Promise&lt;<a href="/reference/product">Product</a>&gt;
+    </>
+  }
+  since="2.0.0"
+/>
+
+{/* Experimental getter */}
+
+<MemberInfo
+  kind="getter"
+  type={<>boolean</>}
+  experimental={true}
+/>
+```
+
+### MemberDescription
+
+Simple wrapper for member descriptions in API reference documentation. Provides consistent styling for description content.
+
+#### Props
+
+| Prop       | Type        | Required | Description                   |
+| ---------- | ----------- | -------- | ----------------------------- |
+| `children` | `ReactNode` | Yes      | Description content (MDX/JSX) |
+
+#### Example
+
+```mdx
+<MemberDescription>
+  The `Product` entity represents items in your catalog.
+  It includes pricing, variants, and inventory information.
+
+See the [Product Guide](/guides/products) for more details.
+
+</MemberDescription>
+```
+
+### CustomFieldProperty
+
+Shows required/optional status and type information for custom fields. Used in custom field configuration documentation.
+
+#### Props
+
+| Prop       | Type      | Required | Description                   |
+| ---------- | --------- | -------- | ----------------------------- |
+| `required` | `boolean` | Yes      | Whether the field is required |
+| `type`     | `string`  | Yes      | Type name to display          |
+| `typeLink` | `string`  | No       | Optional link for the type    |
+
+#### Example
+
+```mdx
+<CustomFieldProperty
+  required={true}
+  type="string"
+/>
+
+<CustomFieldProperty
+  required={false}
+  type="LocalizedString"
+  typeLink="/reference/types/localized-string"
+/>
+```
+
+### GraphQLDoc
+
+Displays GraphQL schema definitions with syntax highlighting and clickable type links. Used in GraphQL API reference documentation.
+
+**Note:** The component automatically formats and indents the GraphQL SDL content. Since MDX strips leading whitespace from template literals, you don't need to worry about indentation in your source files - the component will add proper indentation based on GraphQL syntax (braces, etc.).
+
+#### Props
+
+| Prop         | Type                                                                                                                         | Required | Description                                                                             |
+| ------------ | ---------------------------------------------------------------------------------------------------------------------------- | -------- | --------------------------------------------------------------------------------------- |
+| `type`       | `'mutation' \| 'query' \| 'subscription' \| 'type' \| 'input' \| 'enum' \| 'scalar' \| 'interface' \| 'union' \| 'fragment'` | Yes      | The GraphQL definition kind                                                             |
+| `typeName`   | `string`                                                                                                                     | Yes      | The primary type/operation name                                                         |
+| `since`      | `string`                                                                                                                     | No       | Version when this API was introduced                                                    |
+| `deprecated` | `boolean \| string`                                                                                                          | No       | Mark as deprecated (string provides deprecation message)                                |
+| `typeLinks`  | `Record<string, string>`                                                                                                     | No       | Map of type names to their documentation URLs. Only types in this map become clickable. |
+| `children`   | `ReactNode`                                                                                                                  | Yes      | GraphQL SDL content                                                                     |
+
+#### Example
+
+```mdx
+{/* Simple mutation without type links */}
+
+<GraphQLDoc
+  type="mutation"
+  typeName="logout"
+  since="1.0.0"
+>
+  {`type Mutation {
+  logout: Success!
+}`}
+</GraphQLDoc>
+
+{/* Mutation with clickable type links */}
+
+<GraphQLDoc
+  type="mutation"
+  typeName="addCustomersToGroup"
+  since="1.0.0"
+  typeLinks={{
+    CustomerGroup: '/reference/graphql-api/admin/customer-group',
+    ID: '/reference/graphql-api/common/scalars#id',
+  }}
+>
+  {`"""
+Add Customers to a CustomerGroup
+"""
+type Mutation {
+  addCustomersToGroup(customerGroupId: ID!, customerIds: [ID!]!): CustomerGroup!
+}`}
+</GraphQLDoc>
+
+{/* Deprecated type */}
+
+<GraphQLDoc
+  type="type"
+  typeName="OldProduct"
+  deprecated="Use Product instead"
+>
+  {`type OldProduct {
+  id: ID!
+  name: String!
+}`}
+</GraphQLDoc>
+```
+
+---
+
+## Complete Reference Page Example
+
+Here's an example of how these components can be used together for a complete reference page:
+
+```mdx
+---
+title: Product
+description: The Product entity represents items in your catalog.
+---
+
+# Product
+
+<GenerationInfo
+  packageName="@vendure/core"
+  sourceFile="src/entity/product/product.entity.ts"
+  sourceLine={25}
+  since="1.0.0"
+/>
+
+The `Product` entity represents items in your catalog.
+
+## Properties
+
+### name
+
+<MemberInfo
+  kind="property"
+  type={<>string</>}
+/>
+
+<MemberDescription>The name of the product as displayed to customers.</MemberDescription>
+
+### slug
+
+<MemberInfo
+  kind="property"
+  type={<>string</>}
+/>
+
+<MemberDescription>The URL-friendly identifier for this product.</MemberDescription>
+
+## Methods
+
+### getVariants
+
+<MemberInfo
+  kind="method"
+  type={
+    <>
+      (<a href="/reference/ctx">RequestContext</a>) =&gt; Promise&lt;
+      <a href="/reference/product-variant">ProductVariant</a>[]&gt;
+    </>
+  }
+  since="1.1.0"
+/>
+
+<MemberDescription>Returns all variants associated with this product.</MemberDescription>
+
+## Custom Fields
+
+Products support the following custom field types:
+
+<CustomFieldProperty
+  required={false}
+  type="string"
+/>
+<CustomFieldProperty
+  required={false}
+  type="int"
+/>
+<CustomFieldProperty
+  required={false}
+  type="boolean"
+/>
+<CustomFieldProperty
+  required={false}
+  type="relation"
+  typeLink="/reference/custom-fields#relation"
+/>
+```
+
+---
+
+## TypeScript Contracts
+
+All component props have TypeScript interfaces defined in `@vendure-io/docs-provider`:
+
+```typescript
+import type {
+  GenerationInfoProps,
+  GraphQLDocProps,
+  MemberInfoProps,
+  MemberDescriptionProps,
+  CustomFieldPropertyProps,
+  StackblitzProps,
+} from '@vendure-io/docs-provider'
+```
+
+These interfaces are framework-agnostic and can be used for type checking without importing React.

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@vendure-io/docs-provider",
-  "version": "0.1.1",
+  "version": "0.3.0",
   "description": "Contract types and utilities for Vendure documentation packages",
   "private": false,
   "publishConfig": {