Skip to content
/ xmdx Public

streaming Markdown/MDX engine built with Rust, designed for high-performance processing in Astro frameworks.

License

Notifications You must be signed in to change notification settings

jp-knj/xmdx

Repository files navigation

xmdx

A high-performance streaming Markdown/MDX engine built with Rust, designed for modern web frameworks.

Features

  • Rust-powered performance - Native speed with NAPI bindings for Node.js
  • Streaming architecture - Process large files efficiently
  • WASM support - Run in browsers and edge runtimes
  • Astro integration - First-class support for Starlight projects
  • MDX compatible - Full JSX component support

Packages

Package Description
xmdx Core JavaScript API with Node.js and browser support
astro-xmdx Astro integration with presets and plugins
@xmdx/napi Native Node.js bindings (NAPI-RS)
xmdx-wasm WebAssembly build for browsers

Quick Start

xmdx (Standalone)

npm install xmdx
import { compile } from 'xmdx';

const html = await compile('# Hello, world!');

astro-xmdx (Astro Integration)

npm install astro-xmdx
import { defineConfig } from 'astro/config';
import xmdx from 'astro-xmdx';

export default defineConfig({
  integrations: [xmdx()],
});

Examples

Supported Platforms

Platform Architecture
macOS x64, ARM64
Windows x64
Linux (glibc) x64, ARM64
Linux (musl) x64, ARM64
Browser/Edge WebAssembly

Development

# Install dependencies
pnpm install

# Build all packages
pnpm build

# Run tests
pnpm test

License

MIT

About

streaming Markdown/MDX engine built with Rust, designed for high-performance processing in Astro frameworks.

Resources

License

Code of conduct

Security policy

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Contributors 2

  •  
  •