Browser Usage

Using mdx-formatter in browser environments via WASM

Browser Usage

WASM (Recommended)

For true browser usage, use the WASM build. The mdx-formatter-wasm crate compiles to WebAssembly and can run in any browser environment. See the doc site playground for a live example.

Build targets:

pnpm build:wasm           # Web target (standalone)
pnpm build:wasm:bundler   # Bundler-compatible target

Node.js Browser Export

The ./browser subpath export re-exports the same format() function as the main entry point. Since the formatting engine is a Rust napi module, this export requires a Node.js runtime — it is suitable for Electron or similar Node-backed environments, but not for pure browser use (use WASM instead).

import { format } from "@takazudo/mdx-formatter/browser";

const formatted = await format(content);

Detecting MDX

Both exports provide detectMdx for checking if content is likely MDX:

import { format, detectMdx } from "@takazudo/mdx-formatter/browser";

if (detectMdx(content)) {
  console.log("Content has MDX syntax");
}

Limitations

Config file loading (.mdx-formatter.json) is not supported in browser mode because it requires Node.js file system access. Pass settings directly to the format function instead.

Package Exports