@ossido-labs/ossido-mdx 0.1.0

package/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Chris Schofield
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

package/README.md

@@ -0,0 +1,64 @@
+# ossido-mdx
+
+MDX support for [ossido](https://ossido.dev), with a Next.js-style
+`src/mdx-components.tsx` convention for styling Markdown globally — no
+`<MDXProvider>` boilerplate.
+
+## Usage
+
+Install:
+
+```sh
+npm install @ossido-labs/ossido-mdx
+```
+
+Add the plugin to your ossido config:
+
+```ts
+// ossido.config.ts
+import type { OssidoConfig } from '@ossido-labs/ossido/config';
+import { ossidoMdx } from '@ossido-labs/ossido-mdx/vite';
+
+const config: OssidoConfig = {
+  vite: { plugins: [ossidoMdx()] },
+};
+
+export default config;
+```
+
+That's it — `.mdx` files under `src/routes` now compile and render.
+
+## Global components
+
+Create `src/mdx-components.tsx` and export a `useMDXComponents` function. Every
+`.mdx` file uses it automatically (it's wired through MDX's `providerImportSource`,
+so there's no provider to render):
+
+```tsx
+// src/mdx-components.tsx
+import type { MDXComponents } from '@ossido-labs/ossido-mdx';
+import { Link } from '@ossido-labs/ossido';
+
+export function useMDXComponents(components: MDXComponents): MDXComponents {
+  return {
+    h1: (props) => <h1 className="text-3xl font-bold" {...props} />,
+    a: ({ href = '', ...props }) => <Link href={href} {...props} />,
+    // per-file components (passed to a rendered <MDXContent components={...} />)
+    // still win:
+    ...components,
+  };
+}
+```
+
+The file is optional: until it exists, MDX renders with plain HTML elements.
+
+## Options
+
+```ts
+ossidoMdx({
+  // forwarded to @mdx-js/rollup (remark/rehype plugins, etc.)
+  mdxOptions: { remarkPlugins: [], rehypePlugins: [] },
+});
+```
+
+`providerImportSource` is managed by the plugin and can't be overridden.

package/dist/esm/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * The map of components MDX renders HTML/JSX elements with. Return this from the
+ * `useMDXComponents` export of your `src/mdx-components.tsx` to style Markdown
+ * globally (see {@link ./vite | `ossido-mdx/vite`}).
+ *
+ * @example src/mdx-components.tsx
+ * ```tsx
+ * import type { MDXComponents } from '@ossido-labs/ossido-mdx'
+ *
+ * export function useMDXComponents(components: MDXComponents): MDXComponents {
+ *   return {
+ *     h1: (props) => <h1 className="text-3xl font-bold" {...props} />,
+ *     ...components,
+ *   }
+ * }
+ * ```
+ */
+export type { MDXComponents } from 'mdx/types';

package/dist/esm/vite.d.ts

@@ -0,0 +1,25 @@
+import type { Plugin } from 'vite';
+export interface OssidoMdxOptions {
+    /**
+     * Extra options forwarded to `@mdx-js/rollup` (remark/rehype plugins, etc.).
+     * `providerImportSource` is managed by this plugin and can't be overridden.
+     */
+    mdxOptions?: Record<string, any>;
+}
+/**
+ * MDX support for ossido with a Next.js-style global components convention.
+ *
+ * Add it to your ossido config's `vite.plugins`:
+ *
+ * ```ts
+ * // ossido.config.ts
+ * import { ossidoMdx } from '@ossido-labs/ossido-mdx/vite'
+ *
+ * export default { vite: { plugins: [ossidoMdx()] } }
+ * ```
+ *
+ * Then style Markdown globally by exporting `useMDXComponents` from
+ * `src/mdx-components.tsx` — every `.mdx` file picks it up, no `<MDXProvider>`
+ * needed. Until that file exists, MDX renders with plain HTML elements.
+ */
+export declare function ossidoMdx(options?: OssidoMdxOptions): Array<Plugin>;

package/dist/esm/vite.js

@@ -0,0 +1,79 @@
+import fs from "node:fs";
+import path from "node:path";
+import mdx from "@mdx-js/rollup";
+
+//#region src/vite.ts
+/**
+* The module the MDX compiler imports `useMDXComponents` from (via
+* `providerImportSource`). It is virtual: the `ossido-mdx:components` plugin
+* resolves it to the project's `src/mdx-components` file, or a passthrough
+* default when that file doesn't exist yet.
+*/
+const VIRTUAL_ID = "virtual:ossido-mdx/components";
+const RESOLVED_VIRTUAL_ID = "\0virtual:ossido-mdx/components";
+const COMPONENTS_BASENAME = "mdx-components";
+const EXTENSIONS = [
+	"tsx",
+	"jsx",
+	"ts",
+	"js"
+];
+/**
+* Locate the project's `src/mdx-components.{tsx,jsx,ts,js}`.
+*
+* ossido runs vite with `root: '.ossido'`, so the project lives one directory
+* up; we look there first (the real location) and fall back to the vite root so
+* this also works for a non-ossido vite project.
+*/
+function findComponentsFile(viteRoot) {
+	const projectRoots = [path.dirname(viteRoot), viteRoot];
+	for (const base of projectRoots) for (const ext of EXTENSIONS) {
+		const candidate = path.join(base, "src", `${COMPONENTS_BASENAME}.${ext}`);
+		if (fs.existsSync(candidate)) return candidate;
+	}
+}
+/**
+* MDX support for ossido with a Next.js-style global components convention.
+*
+* Add it to your ossido config's `vite.plugins`:
+*
+* ```ts
+* // ossido.config.ts
+* import { ossidoMdx } from '@ossido-labs/ossido-mdx/vite'
+*
+* export default { vite: { plugins: [ossidoMdx()] } }
+* ```
+*
+* Then style Markdown globally by exporting `useMDXComponents` from
+* `src/mdx-components.tsx` — every `.mdx` file picks it up, no `<MDXProvider>`
+* needed. Until that file exists, MDX renders with plain HTML elements.
+*/
+function ossidoMdx(options = {}) {
+	let viteRoot = process.cwd();
+	return [{
+		name: "ossido-mdx:components",
+		enforce: "pre",
+		configResolved(config) {
+			viteRoot = config.root;
+		},
+		resolveId(id) {
+			if (id === VIRTUAL_ID) return RESOLVED_VIRTUAL_ID;
+		},
+		load(id) {
+			if (id !== RESOLVED_VIRTUAL_ID) return void 0;
+			const file = findComponentsFile(viteRoot);
+			if (file) return `export { useMDXComponents } from ${JSON.stringify(file)}`;
+			return `export function useMDXComponents(components) {\n  return components ?? {}\n}`;
+		}
+	}, {
+		enforce: "pre",
+		...mdx({
+			...options.mdxOptions,
+			providerImportSource: VIRTUAL_ID
+		})
+	}];
+}
+
+//#endregion
+export { ossidoMdx };
+//# sourceMappingURL=vite.js.map

package/dist/esm/vite.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"vite.js","names":[],"sources":["../../src/vite.ts"],"sourcesContent":["import fs from 'node:fs';\nimport path from 'node:path';\n\nimport mdx from '@mdx-js/rollup';\nimport type { Plugin } from 'vite';\n\n/**\n * The module the MDX compiler imports `useMDXComponents` from (via\n * `providerImportSource`). It is virtual: the `ossido-mdx:components` plugin\n * resolves it to the project's `src/mdx-components` file, or a passthrough\n * default when that file doesn't exist yet.\n */\nconst VIRTUAL_ID = 'virtual:ossido-mdx/components';\nconst RESOLVED_VIRTUAL_ID = '\\0' + VIRTUAL_ID;\n\nconst COMPONENTS_BASENAME = 'mdx-components';\nconst EXTENSIONS = ['tsx', 'jsx', 'ts', 'js'] as const;\n\n/**\n * Locate the project's `src/mdx-components.{tsx,jsx,ts,js}`.\n *\n * ossido runs vite with `root: '.ossido'`, so the project lives one directory\n * up; we look there first (the real location) and fall back to the vite root so\n * this also works for a non-ossido vite project.\n */\nfunction findComponentsFile(viteRoot: string): string | undefined {\n  const projectRoots = [path.dirname(viteRoot), viteRoot];\n  for (const base of projectRoots) {\n    for (const ext of EXTENSIONS) {\n      const candidate = path.join(base, 'src', `${COMPONENTS_BASENAME}.${ext}`);\n      if (fs.existsSync(candidate)) return candidate;\n    }\n  }\n  return undefined;\n}\n\nexport interface OssidoMdxOptions {\n  /**\n   * Extra options forwarded to `@mdx-js/rollup` (remark/rehype plugins, etc.).\n   * `providerImportSource` is managed by this plugin and can't be overridden.\n   */\n  // eslint-disable-next-line @typescript-eslint/no-explicit-any\n  mdxOptions?: Record<string, any>;\n}\n\n/**\n * MDX support for ossido with a Next.js-style global components convention.\n *\n * Add it to your ossido config's `vite.plugins`:\n *\n * ```ts\n * // ossido.config.ts\n * import { ossidoMdx } from '@ossido-labs/ossido-mdx/vite'\n *\n * export default { vite: { plugins: [ossidoMdx()] } }\n * ```\n *\n * Then style Markdown globally by exporting `useMDXComponents` from\n * `src/mdx-components.tsx` — every `.mdx` file picks it up, no `<MDXProvider>`\n * needed. Until that file exists, MDX renders with plain HTML elements.\n */\nexport function ossidoMdx(options: OssidoMdxOptions = {}): Array<Plugin> {\n  let viteRoot = process.cwd();\n\n  const componentsPlugin: Plugin = {\n    name: 'ossido-mdx:components',\n    enforce: 'pre',\n    configResolved(config): void {\n      viteRoot = config.root;\n    },\n    resolveId(id): string | undefined {\n      if (id === VIRTUAL_ID) return RESOLVED_VIRTUAL_ID;\n      return undefined;\n    },\n    load(id): string | undefined {\n      if (id !== RESOLVED_VIRTUAL_ID) return undefined;\n\n      const file = findComponentsFile(viteRoot);\n      if (file) {\n        // Re-export the user's hook; the dependency on `file` also gives HMR.\n        return `export { useMDXComponents } from ${JSON.stringify(file)}`;\n      }\n      // Passthrough default: MDX works before a mdx-components file is created.\n      return `export function useMDXComponents(components) {\\n  return components ?? {}\\n}`;\n    },\n  };\n\n  const mdxPlugin: Plugin = {\n    enforce: 'pre',\n    ...(mdx({\n      ...options.mdxOptions,\n      providerImportSource: VIRTUAL_ID,\n    }) as Plugin),\n  };\n\n  return [componentsPlugin, mdxPlugin];\n}\n"],"mappings":";;;;;;;;;;;AAYA,MAAM,aAAa;AACnB,MAAM,sBAAsB;AAE5B,MAAM,sBAAsB;AAC5B,MAAM,aAAa;CAAC;CAAO;CAAO;CAAM;AAAI;;;;;;;;AAS5C,SAAS,mBAAmB,UAAsC;CAChE,MAAM,eAAe,CAAC,KAAK,QAAQ,QAAQ,GAAG,QAAQ;CACtD,KAAK,MAAM,QAAQ,cACjB,KAAK,MAAM,OAAO,YAAY;EAC5B,MAAM,YAAY,KAAK,KAAK,MAAM,OAAO,GAAG,oBAAoB,GAAG,KAAK;EACxE,IAAI,GAAG,WAAW,SAAS,GAAG,OAAO;CACvC;AAGJ;;;;;;;;;;;;;;;;;AA2BA,SAAgB,UAAU,UAA4B,CAAC,GAAkB;CACvE,IAAI,WAAW,QAAQ,IAAI;CAiC3B,OAAO,CAAC;EA9BN,MAAM;EACN,SAAS;EACT,eAAe,QAAc;GAC3B,WAAW,OAAO;EACpB;EACA,UAAU,IAAwB;GAChC,IAAI,OAAO,YAAY,OAAO;EAEhC;EACA,KAAK,IAAwB;GAC3B,IAAI,OAAO,qBAAqB,OAAO;GAEvC,MAAM,OAAO,mBAAmB,QAAQ;GACxC,IAAI,MAEF,OAAO,oCAAoC,KAAK,UAAU,IAAI;GAGhE,OAAO;EACT;CAWqB,GAAG;EAPxB,SAAS;EACT,GAAI,IAAI;GACN,GAAG,QAAQ;GACX,sBAAsB;EACxB,CAAC;CAG+B,CAAC;AACrC"}

package/package.json

@@ -0,0 +1,65 @@
+{
+  "name": "@ossido-labs/ossido-mdx",
+  "version": "0.1.0",
+  "publishConfig": {
+    "access": "public"
+  },
+  "description": "MDX support for ossido with a Next.js-style src/mdx-components.tsx convention for global MDX components. Ossido is the react/rust fullstack framework",
+  "homepage": "https://ossido.dev",
+  "scripts": {
+    "dev": "tsdown --watch",
+    "build": "tsdown && tsc -p tsconfig.build.json",
+    "prepack": "bun run build",
+    "lint": "oxlint",
+    "format": "oxfmt --check .",
+    "format:fix": "oxfmt .",
+    "typecheck": "tsc --noEmit",
+    "test:watch": "vitest",
+    "test": "vitest run"
+  },
+  "repository": {
+    "type": "git",
+    "url": "git+https://github.com/ossido-labs/ossido.git",
+    "directory": "packages/ossido-mdx"
+  },
+  "keywords": [],
+  "author": "Chris Schofield <chris@childishforces.com>",
+  "license": "MIT",
+  "type": "module",
+  "types": "dist/esm/index.d.ts",
+  "main": "dist/esm/index.js",
+  "module": "dist/esm/index.js",
+  "files": [
+    "dist",
+    "README.md"
+  ],
+  "exports": {
+    ".": {
+      "types": "./dist/esm/index.d.ts",
+      "default": "./dist/esm/index.js"
+    },
+    "./vite": {
+      "types": "./dist/esm/vite.d.ts",
+      "default": "./dist/esm/vite.js"
+    },
+    "./package.json": "./package.json"
+  },
+  "dependencies": {
+    "@mdx-js/rollup": "^3.1.0",
+    "@types/mdx": "^2.0.13"
+  },
+  "peerDependencies": {
+    "vite": "^8.1.5"
+  },
+  "peerDependenciesMeta": {
+    "vite": {
+      "optional": true
+    }
+  },
+  "devDependencies": {
+    "tsdown": "0.22.14",
+    "vite": "^8.2.0",
+    "vite-config": "1.0.0",
+    "vitest": "4.1.10"
+  }
+}