@ox-content/vite-plugin-vue 2.67.0 → 2.69.0

package/dist/index.d.cts

@@ -2,7 +2,18 @@ import { PluginOption } from "vite";
 import { OxContentOptions, oxContent } from "@ox-content/vite-plugin";
 
 //#region src/types.d.ts
+/**
+ * Code annotation options for the Vue integration.
+ *
+ * The Vue integration supports opt-in fence metadata and exposes the attribute
+ * key used by the Vue markdown transform.
+ */
 interface CodeAnnotationsOptions {
+  /**
+   * Attribute name read from the code fence meta string.
+   *
+   * @default 'annotate'
+   */
   metaKey?: string;
 }
 interface ResolvedCodeAnnotationsOptions {
@@ -16,7 +27,10 @@ interface ResolvedCodeAnnotationsOptions {
 type ComponentsMap = Record<string, string>;
 /**
  * Component registration options.
+ *
  * Can be a map, a glob pattern, or an array of glob patterns.
+ * Globbed components are resolved relative to the Vite project root during
+ * `configResolved`.
  *
  * @example
  * ```ts
@@ -35,18 +49,28 @@ type ComponentsMap = Record<string, string>;
 type ComponentsOption = ComponentsMap | string | string[];
 /**
  * Vue integration plugin options.
+ *
+ * This extends the core ox-content options with Vue component registration and
+ * Vue-specific markdown behavior. Markdown files are transformed into Vue-aware
+ * modules while the core plugin provides shared parsing and embeds.
  */
 interface VueIntegrationOptions extends OxContentOptions {
   /**
    * Markdown-like file extensions to process.
+   *
+   * Values are normalized with a leading dot before matching file paths.
+   *
    * @default ['.md', '.markdown', '.mdx']
    */
   extensions?: string[];
   /**
    * Components to register for use in Markdown.
+   *
    * Can be a map of names to paths, a glob pattern, or an array of globs.
    * When using glob patterns, component names are derived from file names.
    *
+   * @default {}
+   *
    * @example
    * ```ts
    * // Glob pattern (recommended)
@@ -58,35 +82,111 @@ interface VueIntegrationOptions extends OxContentOptions {
    * }
    * ```
    */
+  components?: ComponentsOption;
+  /**
+   * Enable opt-in line annotations for fenced code blocks.
+   *
+   * Pass `true` to use the default `annotate` meta key, or an object to change it.
+   *
+   * @default false
+   */
+  codeAnnotations?: boolean | CodeAnnotationsOptions;
   /**
    * Enable Vue Reactivity Transform.
+   *
+   * Keep this disabled unless the project still relies on Vue's experimental
+   * reactivity transform syntax.
+   *
    * @default false
    */
+  reactivityTransform?: boolean;
   /**
    * Enable custom blocks in Markdown (e.g., `:::tip`).
+   *
+   * Disable this only when another Markdown plugin owns the same container
+   * syntax.
+   *
    * @default true
    */
-  components?: ComponentsOption;
-  codeAnnotations?: boolean | CodeAnnotationsOptions;
-  reactivityTransform?: boolean;
   customBlocks?: boolean;
+  /**
+   * Built-in static embeds rendered during Markdown transformation.
+   *
+   * Set to `false` to disable all built-in embeds.
+   * Configure individual fetch-related options under `github` and `openGraph`.
+   *
+   * @default { github: true, openGraph: true }
+   */
   embeds?: BuiltinEmbedOptions | false;
 }
+/**
+ * Fetch options for Vue GitHub embeds.
+ */
 interface GitHubEmbedOptions {
+  /**
+   * GitHub API token used for higher rate limits and private repository access.
+   * @default ''
+   */
   token?: string;
+  /**
+   * Cache fetched repository and source data in memory for the current process.
+   * @default true
+   */
   cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
   cacheTTL?: number;
+  /**
+   * Maximum source file size to inline in bytes.
+   * @default 200000
+   */
   maxSourceBytes?: number;
+  /**
+   * Maximum source lines to inline when no line range is specified.
+   * @default 120
+   */
   maxSourceLines?: number;
 }
+/**
+ * Fetch options for Vue Open Graph embeds.
+ */
 interface OpenGraphEmbedOptions {
+  /**
+   * Request timeout in milliseconds.
+   * @default 10000
+   */
   timeout?: number;
+  /**
+   * Cache fetched Open Graph metadata in memory for the current process.
+   * @default true
+   */
   cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
   cacheTTL?: number;
+  /**
+   * User agent sent with metadata fetch requests.
+   * @default 'ox-content-ogp-bot/1.0 (compatible; +https://github.com/ubugeeei-prod/ox-content)'
+   */
   userAgent?: string;
 }
+/**
+ * Built-in embed options for the Vue integration.
+ */
 interface BuiltinEmbedOptions {
+  /**
+   * Render `<GitHub repo="owner/name" />` repository cards.
+   * @default true
+   */
   github?: boolean | GitHubEmbedOptions;
+  /**
+   * Render `<OgCard url="https://example.com" />` Open Graph link cards.
+   * @default true
+   */
   openGraph?: boolean | OpenGraphEmbedOptions;
 }
 interface ResolvedBuiltinEmbedOptions {

package/dist/index.d.cts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;UAMiB,sBAAA;EACf,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;;AAOF;KAAY,aAAA,GAAgB,MAAA;;;;AAoB5B;;;;;AAKA;;;;;;;;;;KALY,gBAAA,GAAmB,aAAA;;;;UAKd,qBAAA,SAA8B,gBAAA;EAmC7C;;;;EA9BA,UAAA;EAgC4B;AAG9B;;;;;;;;;;;AAQA;;;;EACE;;;;EAGS;;AAGX;;EAtBE,UAAA,GAAa,gBAAA;EACb,eAAA,aAA4B,sBAAA;EAC5B,mBAAA;EACA,YAAA;EACA,MAAA,GAAS,mBAAA;AAAA;AAAA,UAGM,kBAAA;EACf,KAAA;EACA,KAAA;EACA,QAAA;EACA,cAAA;EACA,cAAA;AAAA;AAAA,UAGe,qBAAA;EACf,OAAA;EACA,KAAA;EACA,QAAA;EACA,SAAA;AAAA;AAAA,UAGe,mBAAA;EACf,MAAA,aAAmB,kBAAA;EACnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;;;;UAMI,kBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,gBAAA;EACZ,mBAAA;EACA,YAAA;EACA,MAAA,EAAQ,2BAAA;AAAA;;;;UAMO,kBAAA;EACf,IAAA;EACA,GAAA;EAQA;;;EAJA,cAAA;EAUe;;;EANf,WAAA,EAAa,MAAA;AAAA;;;;UAME,eAAA;EAoBf;;;EAhBA,IAAA;EAsBoC;;;EAlBpC,KAAA,EAAO,MAAA;EAkCF;;;EA9BL,QAAA;EAsBA;;;EAlBA,EAAA;EA0BA;;;EAtBA,OAAA;AAAA;;;;UAMe,qBAAA;EAwBf;;;EApBA,IAAA;EAsBmB;;;EAlBnB,OAAA,EAAS,eAAA;;ACvFX;;ED2FE,WAAA,EAAa,MAAA;EC3FgE;;;ED+F7E,GAAA,EAAK,QAAA;AAAA;;;;UAMU,QAAA;EACf,KAAA;EACA,IAAA;EACA,IAAA;EACA,QAAA,GAAW,QAAA;AAAA;;;AA7Lb;;;;;AASA;;;;;AAoBA;;;;;AAKA;;;;;;;;AAlCA,iBCoFgB,YAAA,CAAa,OAAA,GAAS,qBAAA,GAA6B,YAAA"}
+{"version":3,"file":"index.d.cts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;AAYA;;;;;AASA;AATA,UAAiB,sBAAA;;;;AAkBjB;;EAZE,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;AAuCF;;KAhCY,aAAA,GAAgB,MAAA;;;;;;;;;;;;;;;;;;;AA0G5B;;;KAnFY,gBAAA,GAAmB,aAAA;;;;;;;;UASd,qBAAA,SAA8B,gBAAA;EA6GT;;;;;;;EArGpC,UAAA;EA4HS;AAMX;;;;;;;;;;AAcA;;;;;;;;EA3HE,UAAA,GAAa,gBAAA;EA6HmB;AAMlC;;;;;;EA1HE,eAAA,aAA4B,sBAAA;EAuIO;;;;;;;;EA7HnC,mBAAA;EAyHA;;;;;;;;EA/GA,YAAA;EAmHmC;AAMrC;;;;;;;EA/GE,MAAA,GAAS,mBAAA;AAAA;;;AAiIX;UA3HiB,kBAAA;;;;;EAKf,KAAA;EAoIA;;;;EA9HA,KAAA;EA8Ie;;;;EAxIf,QAAA;EA2JK;;;;EArJL,cAAA;EA2IS;;;;EArIT,cAAA;AAAA;;AAqJF;;UA/IiB,qBAAA;EAmJI;;;;EA9InB,OAAA;EA8IW;;;;EAxIX,KAAA;;ACxFF;;;ED8FE,QAAA;EC9FoC;;;;EDoGpC,SAAA;AAAA;;;;UAMe,mBAAA;;;;;EAKf,MAAA,aAAmB,kBAAA;;;;;EAMnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;;;;UAMI,kBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,gBAAA;EACZ,mBAAA;EACA,YAAA;EACA,MAAA,EAAQ,2BAAA;AAAA;;;;UAMO,kBAAA;EACf,IAAA;EACA,GAAA;;;;EAKA,cAAA;;;;EAKA,WAAA,EAAa,MAAA;AAAA;;;;UAME,eAAA;;;;EAIf,IAAA;;;;EAKA,KAAA,EAAO,MAAA;;;;EAKP,QAAA;;;;EAKA,EAAA;;;;EAKA,OAAA;AAAA;;;;UAMe,qBAAA;;;;EAIf,IAAA;;;;EAKA,OAAA,EAAS,eAAA;;;;EAKT,WAAA,EAAa,MAAA;;;;EAKb,GAAA,EAAK,QAAA;AAAA;;;;UAMU,QAAA;EACf,KAAA;EACA,IAAA;EACA,IAAA;EACA,QAAA,GAAW,QAAA;AAAA;;;AAzSb;;;;;AASA;;;;;AAuBA;;;;;AASA;;;;;;;;AAzCA,iBCyEgB,YAAA,CAAa,OAAA,GAAS,qBAAA,GAA6B,YAAA"}

package/dist/index.d.mts

@@ -2,7 +2,18 @@ import { OxContentOptions, oxContent } from "@ox-content/vite-plugin";
 import { PluginOption } from "vite";
 
 //#region src/types.d.ts
+/**
+ * Code annotation options for the Vue integration.
+ *
+ * The Vue integration supports opt-in fence metadata and exposes the attribute
+ * key used by the Vue markdown transform.
+ */
 interface CodeAnnotationsOptions {
+  /**
+   * Attribute name read from the code fence meta string.
+   *
+   * @default 'annotate'
+   */
   metaKey?: string;
 }
 interface ResolvedCodeAnnotationsOptions {
@@ -16,7 +27,10 @@ interface ResolvedCodeAnnotationsOptions {
 type ComponentsMap = Record<string, string>;
 /**
  * Component registration options.
+ *
  * Can be a map, a glob pattern, or an array of glob patterns.
+ * Globbed components are resolved relative to the Vite project root during
+ * `configResolved`.
  *
  * @example
  * ```ts
@@ -35,18 +49,28 @@ type ComponentsMap = Record<string, string>;
 type ComponentsOption = ComponentsMap | string | string[];
 /**
  * Vue integration plugin options.
+ *
+ * This extends the core ox-content options with Vue component registration and
+ * Vue-specific markdown behavior. Markdown files are transformed into Vue-aware
+ * modules while the core plugin provides shared parsing and embeds.
  */
 interface VueIntegrationOptions extends OxContentOptions {
   /**
    * Markdown-like file extensions to process.
+   *
+   * Values are normalized with a leading dot before matching file paths.
+   *
    * @default ['.md', '.markdown', '.mdx']
    */
   extensions?: string[];
   /**
    * Components to register for use in Markdown.
+   *
    * Can be a map of names to paths, a glob pattern, or an array of globs.
    * When using glob patterns, component names are derived from file names.
    *
+   * @default {}
+   *
    * @example
    * ```ts
    * // Glob pattern (recommended)
@@ -58,35 +82,111 @@ interface VueIntegrationOptions extends OxContentOptions {
    * }
    * ```
    */
+  components?: ComponentsOption;
+  /**
+   * Enable opt-in line annotations for fenced code blocks.
+   *
+   * Pass `true` to use the default `annotate` meta key, or an object to change it.
+   *
+   * @default false
+   */
+  codeAnnotations?: boolean | CodeAnnotationsOptions;
   /**
    * Enable Vue Reactivity Transform.
+   *
+   * Keep this disabled unless the project still relies on Vue's experimental
+   * reactivity transform syntax.
+   *
    * @default false
    */
+  reactivityTransform?: boolean;
   /**
    * Enable custom blocks in Markdown (e.g., `:::tip`).
+   *
+   * Disable this only when another Markdown plugin owns the same container
+   * syntax.
+   *
    * @default true
    */
-  components?: ComponentsOption;
-  codeAnnotations?: boolean | CodeAnnotationsOptions;
-  reactivityTransform?: boolean;
   customBlocks?: boolean;
+  /**
+   * Built-in static embeds rendered during Markdown transformation.
+   *
+   * Set to `false` to disable all built-in embeds.
+   * Configure individual fetch-related options under `github` and `openGraph`.
+   *
+   * @default { github: true, openGraph: true }
+   */
   embeds?: BuiltinEmbedOptions | false;
 }
+/**
+ * Fetch options for Vue GitHub embeds.
+ */
 interface GitHubEmbedOptions {
+  /**
+   * GitHub API token used for higher rate limits and private repository access.
+   * @default ''
+   */
   token?: string;
+  /**
+   * Cache fetched repository and source data in memory for the current process.
+   * @default true
+   */
   cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
   cacheTTL?: number;
+  /**
+   * Maximum source file size to inline in bytes.
+   * @default 200000
+   */
   maxSourceBytes?: number;
+  /**
+   * Maximum source lines to inline when no line range is specified.
+   * @default 120
+   */
   maxSourceLines?: number;
 }
+/**
+ * Fetch options for Vue Open Graph embeds.
+ */
 interface OpenGraphEmbedOptions {
+  /**
+   * Request timeout in milliseconds.
+   * @default 10000
+   */
   timeout?: number;
+  /**
+   * Cache fetched Open Graph metadata in memory for the current process.
+   * @default true
+   */
   cache?: boolean;
+  /**
+   * Cache TTL in milliseconds.
+   * @default 3600000
+   */
   cacheTTL?: number;
+  /**
+   * User agent sent with metadata fetch requests.
+   * @default 'ox-content-ogp-bot/1.0 (compatible; +https://github.com/ubugeeei-prod/ox-content)'
+   */
   userAgent?: string;
 }
+/**
+ * Built-in embed options for the Vue integration.
+ */
 interface BuiltinEmbedOptions {
+  /**
+   * Render `<GitHub repo="owner/name" />` repository cards.
+   * @default true
+   */
   github?: boolean | GitHubEmbedOptions;
+  /**
+   * Render `<OgCard url="https://example.com" />` Open Graph link cards.
+   * @default true
+   */
   openGraph?: boolean | OpenGraphEmbedOptions;
 }
 interface ResolvedBuiltinEmbedOptions {

package/dist/index.d.mts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;UAMiB,sBAAA;EACf,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;;AAOF;KAAY,aAAA,GAAgB,MAAA;;;;AAoB5B;;;;;AAKA;;;;;;;;;;KALY,gBAAA,GAAmB,aAAA;;;;UAKd,qBAAA,SAA8B,gBAAA;EAmC7C;;;;EA9BA,UAAA;EAgC4B;AAG9B;;;;;;;;;;;AAQA;;;;EACE;;;;EAGS;;AAGX;;EAtBE,UAAA,GAAa,gBAAA;EACb,eAAA,aAA4B,sBAAA;EAC5B,mBAAA;EACA,YAAA;EACA,MAAA,GAAS,mBAAA;AAAA;AAAA,UAGM,kBAAA;EACf,KAAA;EACA,KAAA;EACA,QAAA;EACA,cAAA;EACA,cAAA;AAAA;AAAA,UAGe,qBAAA;EACf,OAAA;EACA,KAAA;EACA,QAAA;EACA,SAAA;AAAA;AAAA,UAGe,mBAAA;EACf,MAAA,aAAmB,kBAAA;EACnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;;;;UAMI,kBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,gBAAA;EACZ,mBAAA;EACA,YAAA;EACA,MAAA,EAAQ,2BAAA;AAAA;;;;UAMO,kBAAA;EACf,IAAA;EACA,GAAA;EAQA;;;EAJA,cAAA;EAUe;;;EANf,WAAA,EAAa,MAAA;AAAA;;;;UAME,eAAA;EAoBf;;;EAhBA,IAAA;EAsBoC;;;EAlBpC,KAAA,EAAO,MAAA;EAkCF;;;EA9BL,QAAA;EAsBA;;;EAlBA,EAAA;EA0BA;;;EAtBA,OAAA;AAAA;;;;UAMe,qBAAA;EAwBf;;;EApBA,IAAA;EAsBmB;;;EAlBnB,OAAA,EAAS,eAAA;;ACvFX;;ED2FE,WAAA,EAAa,MAAA;EC3FgE;;;ED+F7E,GAAA,EAAK,QAAA;AAAA;;;;UAMU,QAAA;EACf,KAAA;EACA,IAAA;EACA,IAAA;EACA,QAAA,GAAW,QAAA;AAAA;;;AA7Lb;;;;;AASA;;;;;AAoBA;;;;;AAKA;;;;;;;;AAlCA,iBCoFgB,YAAA,CAAa,OAAA,GAAS,qBAAA,GAA6B,YAAA"}
+{"version":3,"file":"index.d.mts","names":[],"sources":["../src/types.ts","../src/index.ts"],"mappings":";;;;AAYA;;;;;AASA;AATA,UAAiB,sBAAA;;;;AAkBjB;;EAZE,OAAA;AAAA;AAAA,UAGe,8BAAA;EACf,OAAA;EACA,OAAA;AAAA;;;AAuCF;;KAhCY,aAAA,GAAgB,MAAA;;;;;;;;;;;;;;;;;;;AA0G5B;;;KAnFY,gBAAA,GAAmB,aAAA;;;;;;;;UASd,qBAAA,SAA8B,gBAAA;EA6GT;;;;;;;EArGpC,UAAA;EA4HS;AAMX;;;;;;;;;;AAcA;;;;;;;;EA3HE,UAAA,GAAa,gBAAA;EA6HmB;AAMlC;;;;;;EA1HE,eAAA,aAA4B,sBAAA;EAuIO;;;;;;;;EA7HnC,mBAAA;EAyHA;;;;;;;;EA/GA,YAAA;EAmHmC;AAMrC;;;;;;;EA/GE,MAAA,GAAS,mBAAA;AAAA;;;AAiIX;UA3HiB,kBAAA;;;;;EAKf,KAAA;EAoIA;;;;EA9HA,KAAA;EA8Ie;;;;EAxIf,QAAA;EA2JK;;;;EArJL,cAAA;EA2IS;;;;EArIT,cAAA;AAAA;;AAqJF;;UA/IiB,qBAAA;EAmJI;;;;EA9InB,OAAA;EA8IW;;;;EAxIX,KAAA;;ACxFF;;;ED8FE,QAAA;EC9FoC;;;;EDoGpC,SAAA;AAAA;;;;UAMe,mBAAA;;;;;EAKf,MAAA,aAAmB,kBAAA;;;;;EAMnB,SAAA,aAAsB,qBAAA;AAAA;AAAA,UAGP,2BAAA;EACf,MAAA,EAAQ,kBAAA;EACR,SAAA,EAAW,qBAAA;AAAA;;;;UAMI,kBAAA;EACf,MAAA;EACA,MAAA;EACA,IAAA;EACA,UAAA;EACA,GAAA;EACA,WAAA;EACA,GAAA;EACA,WAAA;EACA,eAAA,EAAiB,8BAAA;EACjB,UAAA,EAAY,gBAAA;EACZ,mBAAA;EACA,YAAA;EACA,MAAA,EAAQ,2BAAA;AAAA;;;;UAMO,kBAAA;EACf,IAAA;EACA,GAAA;;;;EAKA,cAAA;;;;EAKA,WAAA,EAAa,MAAA;AAAA;;;;UAME,eAAA;;;;EAIf,IAAA;;;;EAKA,KAAA,EAAO,MAAA;;;;EAKP,QAAA;;;;EAKA,EAAA;;;;EAKA,OAAA;AAAA;;;;UAMe,qBAAA;;;;EAIf,IAAA;;;;EAKA,OAAA,EAAS,eAAA;;;;EAKT,WAAA,EAAa,MAAA;;;;EAKb,GAAA,EAAK,QAAA;AAAA;;;;UAMU,QAAA;EACf,KAAA;EACA,IAAA;EACA,IAAA;EACA,QAAA,GAAW,QAAA;AAAA;;;AAzSb;;;;;AASA;;;;;AAuBA;;;;;AASA;;;;;;;;AAzCA,iBCyEgB,YAAA,CAAa,OAAA,GAAS,qBAAA,GAA6B,YAAA"}

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/vite-plugin-vue",
-  "version": "2.67.0",
+  "version": "2.69.0",
   "description": "Vue integration for Ox Content - Embed Vue components in Markdown",
   "keywords": [
     "markdown",
@@ -35,8 +35,8 @@
     "provenance": true
   },
   "dependencies": {
-    "@ox-content/vite-plugin": "2.67.0",
-    "@ox-content/islands": "2.67.0"
+    "@ox-content/islands": "2.69.0",
+    "@ox-content/vite-plugin": "2.69.0"
   },
   "devDependencies": {
     "@types/node": "^25.8.0",