@ox-content/unplugin 0.3.0-alpha.11

package/dist/esbuild.d.ts

@@ -0,0 +1,8 @@
+import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.js";
+import * as unplugin3 from "unplugin";
+
+//#region src/esbuild.d.ts
+
+declare const _default: (options?: OxContentOptions | undefined) => unplugin3.EsbuildPlugin;
+//#endregion
+export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };

package/dist/esbuild.js

@@ -0,0 +1,10 @@
+import { t as src_default } from "./src.js";
+
+//#region src/esbuild.ts
+/**
+* esbuild plugin export for @ox-content/unplugin
+*/
+var esbuild_default = src_default.esbuild;
+
+//#endregion
+export { esbuild_default as default, src_default as unplugin };

package/dist/index.d.ts

@@ -0,0 +1,260 @@
+import * as unplugin5 from "unplugin";
+import MarkdownIt from "markdown-it";
+
+//#region src/types.d.ts
+
+/**
+ * Markdown-it plugin function type.
+ */
+type MarkdownItPluginFn = (md: MarkdownIt, ...options: unknown[]) => void;
+/**
+ * Markdown-it plugin type.
+ * Can be a single plugin or a tuple of [plugin, ...options].
+ */
+type MarkdownItPlugin = MarkdownItPluginFn | [MarkdownItPluginFn, ...unknown[]];
+/**
+ * Remark plugin type.
+ * Can be a single plugin or a tuple of [plugin, options].
+ */
+type RemarkPlugin = [unknown, unknown] | unknown;
+/**
+ * Rehype plugin type.
+ * Can be a single plugin or a tuple of [plugin, options].
+ */
+type RehypePlugin = [unknown, unknown] | unknown;
+/**
+ * Ox-content native plugin type.
+ * Transforms HTML after rendering.
+ */
+type OxContentPlugin = (html: string) => string | Promise<string>;
+/**
+ * API documentation generation configuration.
+ * Similar to cargo docs for Rust.
+ */
+interface DocsConfig {
+  /**
+   * Enable API documentation generation.
+   * @default false
+   */
+  enabled?: boolean;
+  /**
+   * Source directories to scan for documentation.
+   * @default ['./src']
+   */
+  src?: string[];
+  /**
+   * Output directory for generated documentation.
+   * @default 'docs/api'
+   */
+  out?: string;
+  /**
+   * File patterns to include.
+   * @default ['**\/*.ts', '**\/*.tsx', '**\/*.js', '**\/*.jsx']
+   */
+  include?: string[];
+  /**
+   * File patterns to exclude.
+   * @default ['**\/*.test.*', '**\/*.spec.*', '**\/node_modules/**']
+   */
+  exclude?: string[];
+  /**
+   * Include private items (starting with _).
+   * @default false
+   */
+  includePrivate?: boolean;
+  /**
+   * Generate table of contents.
+   * @default true
+   */
+  toc?: boolean;
+  /**
+   * Group documentation by file or by kind.
+   * @default 'file'
+   */
+  groupBy?: "file" | "kind";
+}
+/**
+ * Plugin configuration for various markdown ecosystems.
+ */
+interface PluginConfig {
+  /**
+   * Ox-content native plugins.
+   * Transform HTML after rendering.
+   */
+  oxContent?: OxContentPlugin[];
+  /**
+   * Markdown-it plugins.
+   * @see https://www.npmjs.com/search?q=markdown-it-plugin
+   */
+  markdownIt?: MarkdownItPlugin[];
+  /**
+   * Remark plugins (unified ecosystem).
+   * @see https://github.com/remarkjs/remark/blob/main/doc/plugins.md
+   */
+  remark?: RemarkPlugin[];
+  /**
+   * Rehype plugins (unified ecosystem).
+   * @see https://github.com/rehypejs/rehype/blob/main/doc/plugins.md
+   */
+  rehype?: RehypePlugin[];
+}
+/**
+ * Plugin options.
+ */
+interface OxContentOptions {
+  /**
+   * Source directory for Markdown files.
+   * @default 'docs'
+   */
+  srcDir?: string;
+  /**
+   * Enable GitHub Flavored Markdown extensions.
+   * @default true
+   */
+  gfm?: boolean;
+  /**
+   * Enable footnotes.
+   * @default true
+   */
+  footnotes?: boolean;
+  /**
+   * Enable tables.
+   * @default true
+   */
+  tables?: boolean;
+  /**
+   * Enable task lists.
+   * @default true
+   */
+  taskLists?: boolean;
+  /**
+   * Enable strikethrough.
+   * @default true
+   */
+  strikethrough?: boolean;
+  /**
+   * Enable syntax highlighting for code blocks.
+   * @default false
+   */
+  highlight?: boolean;
+  /**
+   * Syntax highlighting theme.
+   * @default 'github-dark'
+   */
+  highlightTheme?: string;
+  /**
+   * Enable mermaid diagram rendering.
+   * @default false
+   */
+  mermaid?: boolean;
+  /**
+   * Parse YAML frontmatter.
+   * @default true
+   */
+  frontmatter?: boolean;
+  /**
+   * Generate table of contents.
+   * @default true
+   */
+  toc?: boolean;
+  /**
+   * Maximum heading depth for TOC.
+   * @default 3
+   */
+  tocMaxDepth?: number;
+  /**
+   * File extensions to process.
+   * @default ['.md', '.markdown']
+   */
+  extensions?: string[];
+  /**
+   * Files/patterns to include.
+   */
+  include?: string | RegExp | RegExp[];
+  /**
+   * Files/patterns to exclude.
+   */
+  exclude?: string | RegExp | RegExp[];
+  /**
+   * Plugin configuration for markdown processing.
+   */
+  plugin?: PluginConfig;
+  /**
+   * API documentation generation configuration.
+   * Set to false to disable, true to enable with defaults,
+   * or provide a DocsConfig object for customization.
+   * @default false
+   */
+  docs?: boolean | DocsConfig;
+}
+/**
+ * Resolved docs configuration.
+ */
+interface ResolvedDocsConfig {
+  enabled: boolean;
+  src: string[];
+  out: string;
+  include: string[];
+  exclude: string[];
+  includePrivate: boolean;
+  toc: boolean;
+  groupBy: "file" | "kind";
+}
+/**
+ * Resolved options with all defaults applied.
+ */
+interface ResolvedOptions {
+  srcDir: string;
+  gfm: boolean;
+  footnotes: boolean;
+  tables: boolean;
+  taskLists: boolean;
+  strikethrough: boolean;
+  highlight: boolean;
+  highlightTheme: string;
+  mermaid: boolean;
+  frontmatter: boolean;
+  toc: boolean;
+  tocMaxDepth: number;
+  extensions: string[];
+  include: (string | RegExp)[];
+  exclude: (string | RegExp)[];
+  plugin: Required<PluginConfig>;
+  docs: ResolvedDocsConfig;
+}
+/**
+ * Transform result.
+ */
+interface TransformResult {
+  code: string;
+  html: string;
+  frontmatter: Record<string, unknown>;
+  toc: TocEntry[];
+}
+/**
+ * Table of contents entry.
+ */
+interface TocEntry {
+  depth: number;
+  text: string;
+  slug: string;
+  children: TocEntry[];
+}
+//#endregion
+//#region src/transform.d.ts
+/**
+ * Transforms Markdown content into a JavaScript module.
+ * Uses Rust-based renderer via NAPI bindings for optimal performance.
+ *
+ * Note: This requires the @ox-content/napi package to be built.
+ * NAPI bindings are loaded dynamically to support both Node.js and build-time execution.
+ */
+declare function transformMarkdown(source: string, filePath: string, options: ResolvedOptions): Promise<TransformResult>;
+//#endregion
+//#region src/index.d.ts
+/**
+ * The unplugin instance.
+ */
+declare const unplugin: unplugin5.UnpluginInstance<OxContentOptions | undefined, boolean>;
+//#endregion
+export { OxContentOptions as a, RehypePlugin as c, ResolvedOptions as d, TocEntry as f, MarkdownItPlugin as i, RemarkPlugin as l, transformMarkdown as n, OxContentPlugin as o, TransformResult as p, DocsConfig as r, PluginConfig as s, unplugin as t, ResolvedDocsConfig as u };

package/dist/index.js

@@ -0,0 +1,3 @@
+import { n as unplugin, r as transformMarkdown, t as src_default } from "./src.js";
+
+export { src_default as default, transformMarkdown, unplugin };

package/dist/index2.d.ts

@@ -0,0 +1,2 @@
+import { a as OxContentOptions, c as RehypePlugin, d as ResolvedOptions, f as TocEntry, i as MarkdownItPlugin, l as RemarkPlugin, n as transformMarkdown, o as OxContentPlugin, p as TransformResult, r as DocsConfig, s as PluginConfig, t as unplugin, u as ResolvedDocsConfig } from "./index.js";
+export { DocsConfig, MarkdownItPlugin, OxContentOptions, OxContentPlugin, PluginConfig, RehypePlugin, RemarkPlugin, ResolvedDocsConfig, ResolvedOptions, TocEntry, TransformResult, unplugin as default, unplugin, transformMarkdown };

package/dist/rollup.d.ts

@@ -0,0 +1,8 @@
+import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.js";
+import * as unplugin1 from "unplugin";
+
+//#region src/rollup.d.ts
+
+declare const _default: (options?: OxContentOptions | undefined) => unplugin1.RollupPlugin<any> | unplugin1.RollupPlugin<any>[];
+//#endregion
+export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };

package/dist/rollup.js

@@ -0,0 +1,10 @@
+import { t as src_default } from "./src.js";
+
+//#region src/rollup.ts
+/**
+* Rollup plugin export for @ox-content/unplugin
+*/
+var rollup_default = src_default.rollup;
+
+//#endregion
+export { rollup_default as default, src_default as unplugin };

package/dist/rspack.d.ts

@@ -0,0 +1,7 @@
+import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.js";
+
+//#region src/rspack.d.ts
+
+declare const _default: (options?: OxContentOptions | undefined) => RspackPluginInstance;
+//#endregion
+export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };

package/dist/rspack.js

@@ -0,0 +1,10 @@
+import { t as src_default } from "./src.js";
+
+//#region src/rspack.ts
+/**
+* Rspack plugin export for @ox-content/unplugin
+*/
+var rspack_default = src_default.rspack;
+
+//#endregion
+export { rspack_default as default, src_default as unplugin };

package/dist/src.js

@@ -0,0 +1,244 @@
+import { createUnplugin } from "unplugin";
+import { createFilter } from "@rollup/pluginutils";
+
+//#region src/transform.ts
+/**
+* Transforms Markdown content into a JavaScript module.
+* Uses Rust-based renderer via NAPI bindings for optimal performance.
+*
+* Note: This requires the @ox-content/napi package to be built.
+* NAPI bindings are loaded dynamically to support both Node.js and build-time execution.
+*/
+async function transformMarkdown(source, filePath, options) {
+	let napi;
+	try {
+		napi = await import("@ox-content/napi");
+	} catch {
+		throw new Error("[ox-content] Failed to load @ox-content/napi. Please ensure the NAPI module is built. Run: pnpm build:napi");
+	}
+	const result = napi.transform(source, {
+		gfm: options.gfm,
+		footnotes: options.footnotes,
+		task_lists: options.taskLists,
+		tables: options.tables,
+		strikethrough: options.strikethrough,
+		toc_max_depth: options.tocMaxDepth
+	});
+	if (result.errors.length > 0) console.warn("[ox-content] Transform warnings:", result.errors);
+	let frontmatter;
+	try {
+		frontmatter = JSON.parse(result.frontmatter);
+	} catch {
+		frontmatter = {};
+	}
+	const flatToc = result.toc.map((item) => ({
+		...item,
+		children: []
+	}));
+	const toc = options.toc ? buildTocTree(flatToc) : [];
+	let html = result.html;
+	for (const plugin of options.plugin.oxContent) html = await plugin(html);
+	return {
+		code: generateModuleCode(html, frontmatter, toc, filePath),
+		html,
+		frontmatter,
+		toc
+	};
+}
+/**
+* Builds nested TOC tree from flat list.
+*/
+function buildTocTree(entries) {
+	const result = [];
+	const stack = [];
+	for (const entry of entries) {
+		const tocEntry = {
+			depth: entry.depth,
+			text: entry.text,
+			slug: entry.slug,
+			children: []
+		};
+		while (stack.length > 0 && stack[stack.length - 1].depth >= entry.depth) stack.pop();
+		if (stack.length === 0) result.push(tocEntry);
+		else stack[stack.length - 1].children.push(tocEntry);
+		stack.push(tocEntry);
+	}
+	return result;
+}
+/**
+* Generates the JavaScript module code.
+*/
+function generateModuleCode(html, frontmatter, toc, filePath) {
+	return `
+// Generated by @ox-content/unplugin
+// Source: ${filePath}
+
+export const html = ${JSON.stringify(html)};
+export const frontmatter = ${JSON.stringify(frontmatter)};
+export const toc = ${JSON.stringify(toc)};
+
+export default {
+  html,
+  frontmatter,
+  toc,
+};
+`;
+}
+
+//#endregion
+//#region src/index.ts
+/**
+* @ox-content/unplugin
+*
+* Universal plugin for Ox Content - Markdown processing for
+* webpack, rollup, esbuild, vite, and more.
+*/
+/**
+* Resolves docs configuration.
+*/
+function resolveDocsConfig(docs) {
+	if (docs === false || docs === void 0) return {
+		enabled: false,
+		src: ["./src"],
+		out: "docs/api",
+		include: [
+			"**/*.ts",
+			"**/*.tsx",
+			"**/*.js",
+			"**/*.jsx"
+		],
+		exclude: [
+			"**/*.test.*",
+			"**/*.spec.*",
+			"**/node_modules/**"
+		],
+		includePrivate: false,
+		toc: true,
+		groupBy: "file"
+	};
+	if (docs === true) return {
+		enabled: true,
+		src: ["./src"],
+		out: "docs/api",
+		include: [
+			"**/*.ts",
+			"**/*.tsx",
+			"**/*.js",
+			"**/*.jsx"
+		],
+		exclude: [
+			"**/*.test.*",
+			"**/*.spec.*",
+			"**/node_modules/**"
+		],
+		includePrivate: false,
+		toc: true,
+		groupBy: "file"
+	};
+	return {
+		enabled: docs.enabled ?? true,
+		src: docs.src ?? ["./src"],
+		out: docs.out ?? "docs/api",
+		include: docs.include ?? [
+			"**/*.ts",
+			"**/*.tsx",
+			"**/*.js",
+			"**/*.jsx"
+		],
+		exclude: docs.exclude ?? [
+			"**/*.test.*",
+			"**/*.spec.*",
+			"**/node_modules/**"
+		],
+		includePrivate: docs.includePrivate ?? false,
+		toc: docs.toc ?? true,
+		groupBy: docs.groupBy ?? "file"
+	};
+}
+/**
+* Resolves plugin options with defaults.
+*/
+function resolveOptions(options) {
+	const extensions = options.extensions ?? [".md", ".markdown"];
+	return {
+		srcDir: options.srcDir ?? "docs",
+		gfm: options.gfm ?? true,
+		footnotes: options.footnotes ?? true,
+		tables: options.tables ?? true,
+		taskLists: options.taskLists ?? true,
+		strikethrough: options.strikethrough ?? true,
+		highlight: options.highlight ?? false,
+		highlightTheme: options.highlightTheme ?? "github-dark",
+		mermaid: options.mermaid ?? false,
+		frontmatter: options.frontmatter ?? true,
+		toc: options.toc ?? true,
+		tocMaxDepth: options.tocMaxDepth ?? 3,
+		extensions,
+		include: Array.isArray(options.include) ? options.include : options.include ? [options.include] : [],
+		exclude: Array.isArray(options.exclude) ? options.exclude : options.exclude ? [options.exclude] : [],
+		plugin: {
+			oxContent: options.plugin?.oxContent ?? [],
+			markdownIt: options.plugin?.markdownIt ?? [],
+			remark: options.plugin?.remark ?? [],
+			rehype: options.plugin?.rehype ?? []
+		},
+		docs: resolveDocsConfig(options.docs)
+	};
+}
+/**
+* Check if the file should be processed.
+*/
+function isMarkdownFile(id, options) {
+	return options.extensions.some((ext) => id.endsWith(ext));
+}
+/**
+* The unplugin factory function.
+*/
+const unpluginFactory = (rawOptions = {}) => {
+	const options = resolveOptions(rawOptions);
+	const filter = createFilter(options.include.length > 0 ? options.include : void 0, options.exclude.length > 0 ? options.exclude : void 0);
+	return {
+		name: "@ox-content/unplugin",
+		resolveId(id) {
+			if (id.startsWith("virtual:ox-content/")) return "\0" + id;
+			return null;
+		},
+		loadInclude(id) {
+			return id.startsWith("\0virtual:ox-content/");
+		},
+		load(id) {
+			if (id.startsWith("\0virtual:ox-content/")) {
+				const path = id.slice(20);
+				if (path === "config") return `export default ${JSON.stringify(options)};`;
+				if (path === "runtime") return `
+            export function useMarkdown() {
+              return {
+                render: (content) => content,
+              };
+            }
+          `;
+				return "export default {};";
+			}
+			return null;
+		},
+		transformInclude(id) {
+			return isMarkdownFile(id, options) && filter(id);
+		},
+		async transform(code, id) {
+			if (!isMarkdownFile(id, options)) return null;
+			if (!filter(id)) return null;
+			return {
+				code: (await transformMarkdown(code, id, options)).code,
+				map: null
+			};
+		}
+	};
+};
+/**
+* The unplugin instance.
+*/
+const unplugin = /* @__PURE__ */ createUnplugin(unpluginFactory);
+var src_default = unplugin;
+
+//#endregion
+export { unplugin as n, transformMarkdown as r, src_default as t };

package/dist/vite.d.ts

@@ -0,0 +1,8 @@
+import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.js";
+import * as unplugin0 from "unplugin";
+
+//#region src/vite.d.ts
+
+declare const _default: (options?: OxContentOptions | undefined) => unplugin0.VitePlugin<any> | unplugin0.VitePlugin<any>[];
+//#endregion
+export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };

package/dist/vite.js

@@ -0,0 +1,10 @@
+import { t as src_default } from "./src.js";
+
+//#region src/vite.ts
+/**
+* Vite plugin export for @ox-content/unplugin
+*/
+var vite_default = src_default.vite;
+
+//#endregion
+export { vite_default as default, src_default as unplugin };

package/dist/webpack.d.ts

@@ -0,0 +1,8 @@
+import { a as OxContentOptions, d as ResolvedOptions, f as TocEntry, p as TransformResult, t as unplugin } from "./index.js";
+import * as unplugin4 from "unplugin";
+
+//#region src/webpack.d.ts
+
+declare const _default: (options?: OxContentOptions | undefined) => unplugin4.WebpackPluginInstance;
+//#endregion
+export { type OxContentOptions, type ResolvedOptions, type TocEntry, type TransformResult, _default as default, unplugin };

package/dist/webpack.js

@@ -0,0 +1,10 @@
+import { t as src_default } from "./src.js";
+
+//#region src/webpack.ts
+/**
+* Webpack plugin export for @ox-content/unplugin
+*/
+var webpack_default = src_default.webpack;
+
+//#endregion
+export { webpack_default as default, src_default as unplugin };

package/package.json

@@ -0,0 +1,84 @@
+{
+  "name": "@ox-content/unplugin",
+  "version": "0.3.0-alpha.11",
+  "description": "Universal plugin for Ox Content - Markdown processing for webpack, rollup, esbuild, vite, and more",
+  "type": "module",
+  "main": "./dist/index.js",
+  "types": "./dist/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./dist/index.js",
+      "types": "./dist/index.d.ts"
+    },
+    "./vite": {
+      "import": "./dist/vite.js",
+      "types": "./dist/vite.d.ts"
+    },
+    "./webpack": {
+      "import": "./dist/webpack.js",
+      "types": "./dist/webpack.d.ts"
+    },
+    "./rollup": {
+      "import": "./dist/rollup.js",
+      "types": "./dist/rollup.d.ts"
+    },
+    "./esbuild": {
+      "import": "./dist/esbuild.js",
+      "types": "./dist/esbuild.d.ts"
+    },
+    "./rspack": {
+      "import": "./dist/rspack.js",
+      "types": "./dist/rspack.d.ts"
+    }
+  },
+  "files": [
+    "dist"
+  ],
+  "dependencies": {
+    "@rollup/pluginutils": "^5.1.4",
+    "gray-matter": "^4.0.3",
+    "markdown-it": "^14.1.0",
+    "markdown-it-anchor": "^9.2.0",
+    "rehype-stringify": "^10.0.1",
+    "remark-parse": "^11.0.0",
+    "remark-rehype": "^11.1.1",
+    "unified": "^11.0.5",
+    "unplugin": "^2.1.2",
+    "@ox-content/napi": "0.3.0-alpha.11"
+  },
+  "devDependencies": {
+    "@types/markdown-it": "^14.1.2",
+    "@types/node": "^22.0.0",
+    "tsdown": "^0.12.0",
+    "@typescript/native-preview": "^7.0.0-dev.20250601",
+    "typescript": "^5.7.0",
+    "vite": "^8.0.0-beta.0",
+    "webpack": "^5.97.1",
+    "rollup": "^4.29.1",
+    "esbuild": "^0.24.2"
+  },
+  "keywords": [
+    "unplugin",
+    "vite",
+    "webpack",
+    "rollup",
+    "esbuild",
+    "markdown",
+    "ox-content"
+  ],
+  "license": "MIT",
+  "author": "ubugeeei",
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ubugeeei/ox-content.git",
+    "directory": "npm/unplugin-ox-content"
+  },
+  "publishConfig": {
+    "access": "public"
+  },
+  "scripts": {
+    "build": "tsdown",
+    "dev": "tsdown --watch",
+    "typecheck": "tsgo --noEmit"
+  }
+}