/remote-mdx

Use MDX in your React App

Primary LanguageTypeScriptMIT LicenseMIT

remote-mdx

NOTE: This project is rapidly developed for stable v1, and may include a breaking change.

Why Another Remote MDX?

The initial purpose of this fork was to work around the issue with Next.js turbo, but I found some inefficiencies in the original package.

After getting inspired by this discussion, I decided to maintain this fork as a separate package, and am planning to continuously sync with the original package.

So... Why Should I Use This?

  • Package Size: Reduced 50% of the original package size.
  • Fully Typed: Does not depend on allowJS or any type.
  • Module: Native ESM, no internal commonjs resolution that breaks --turbo.

Migrating from next-mdx-remote

remote-mdx is a drop-in replacement for next-mdx-remote. You can simply replace the import statement and it should work as expected.

- import { serialize } from 'next-mdx-remote/serialize'
+ import { serialize } from 'remote-mdx/serialize'

- import { MDXRemote } from 'next-mdx-remote'
+ import { MDXRemote } from 'remote-mdx'

- import { MDXRemote } from 'next-mdx-remote/rsc'
+ import { MDXRemote } from 'remote-mdx/rsc'

- import { compileMDX } from 'next-mdx-remote/rsc'
+ import { compileMDX } from 'remote-mdx/rsc'