@ox-content/unplugin 2.66.0 → 2.68.0

package/dist/index.d.mts

@@ -145,7 +145,15 @@ type RehypePlugin = UnifiedAttacher | UnifiedPluginTuple | UnifiedPreset;
  * Transforms HTML after rendering.
  */
 type OxContentPlugin = (html: string) => string | Promise<string>;
+/**
+ * Code annotation options for the framework-agnostic unplugin package.
+ */
 interface CodeAnnotationsOptions {
+  /**
+   * Attribute name read from the code fence meta string.
+   *
+   * @default 'annotate'
+   */
   metaKey?: string;
 }
 interface ResolvedCodeAnnotationsOptions {
@@ -154,7 +162,10 @@ interface ResolvedCodeAnnotationsOptions {
 }
 /**
  * API documentation generation configuration.
- * Similar to cargo docs for Rust.
+ *
+ * The unplugin package keeps this surface smaller than the Vite plugin's docs
+ * generator, but follows the same convention: provide `true` for defaults or an
+ * object to customize scanning and output.
  */
 interface DocsConfig {
   /**
@@ -164,6 +175,10 @@ interface DocsConfig {
   enabled?: boolean;
   /**
    * Source directories to scan for documentation.
+   *
+   * Paths are resolved from the bundler project root before include/exclude
+   * matching.
+   *
    * @default ['./src']
    */
   src?: string[];
@@ -174,6 +189,9 @@ interface DocsConfig {
   out?: string;
   /**
    * File patterns to include.
+   *
+   * Patterns are evaluated inside each configured `src` directory.
+   *
    * @default ['**\/*.ts', '**\/*.tsx', '**\/*.js', '**\/*.jsx']
    */
   include?: string[];
@@ -199,42 +217,58 @@ interface DocsConfig {
   groupBy?: "file" | "kind";
 }
 /**
- * Plugin configuration for various markdown ecosystems.
+ * Plugin configuration for various Markdown ecosystems.
+ *
+ * Plugins run in the order listed for their respective pipeline stage. Use this
+ * when migrating from markdown-it, remark, or rehype based stacks while keeping
+ * ox-content as the parser/renderer bridge.
  */
 interface PluginConfig {
   /**
    * Ox-content native plugins.
    * Transform HTML after rendering.
+   * @default []
    */
   oxContent?: OxContentPlugin[];
   /**
    * Markdown-it plugins.
+   * @default []
    * @see https://www.npmjs.com/search?q=markdown-it-plugin
    */
   markdownIt?: MarkdownItPlugin[];
   /**
    * mdast plugins.
    * Accepts both Ox Content-native mdast plugins and existing remark plugins.
+   * @default []
    */
   mdast?: MdastPlugin[];
   /**
    * Remark plugins (unified ecosystem).
    * Kept for compatibility; runs in the same mdast stage as `plugin.mdast`.
+   * @default []
    * @see https://github.com/remarkjs/remark/blob/main/doc/plugins.md
    */
   remark?: RemarkPlugin[];
   /**
    * Rehype plugins (unified ecosystem).
+   * @default []
    * @see https://github.com/rehypejs/rehype/blob/main/doc/plugins.md
    */
   rehype?: RehypePlugin[];
 }
 /**
- * Plugin options.
+ * Options for the framework-agnostic ox-content unplugin.
+ *
+ * This package is intended for bundlers such as webpack, Rollup, esbuild,
+ * Rspack, and Vite. It exposes a compact subset of the core Vite plugin options
+ * plus ecosystem plugin hooks.
  */
 interface OxContentOptions {
   /**
    * Source directory for Markdown files.
+   *
+   * Used as the logical content root for generated modules and docs output.
+   *
    * @default 'docs'
    */
   srcDir?: string;
@@ -275,7 +309,16 @@ interface OxContentOptions {
   highlightTheme?: string;
   /**
    * Opt-in line annotations for fenced code blocks.
-   * Example: `annotate="highlight:1,3-4;warning:6"`
+   *
+   * Pass `true` to enable the default `annotate` meta key, or pass an object to
+   * configure the key.
+   *
+   * @example
+   * ~~~md
+   * ```ts annotate="highlight:1,3-4;warning:6"
+   * ```
+   * ~~~
+   *
    * @default false
    */
   codeAnnotations?: boolean | CodeAnnotationsOptions;
@@ -306,14 +349,20 @@ interface OxContentOptions {
   extensions?: string[];
   /**
    * Files/patterns to include.
+   * Empty by default, which lets the Markdown extension filter decide.
+   * @default []
    */
   include?: string | RegExp | RegExp[];
   /**
    * Files/patterns to exclude.
+   * Empty by default.
+   * @default []
    */
   exclude?: string | RegExp | RegExp[];
   /**
    * Plugin configuration for markdown processing.
+   * Each plugin list defaults to an empty array.
+   * @default {}
    */
   plugin?: PluginConfig;
   /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ox-content/unplugin",
-  "version": "2.66.0",
+  "version": "2.68.0",
   "description": "Universal plugin for Ox Content - Markdown processing for webpack, rollup, esbuild, vite, and more",
   "keywords": [
     "esbuild",
@@ -65,7 +65,7 @@
     "remark-rehype": "^11.1.1",
     "unified": "^11.0.5",
     "unplugin": "^3.0.0",
-    "@ox-content/napi": "2.66.0"
+    "@ox-content/napi": "2.68.0"
   },
   "devDependencies": {
     "@types/markdown-it": "^14.1.2",