https://github.com/devjiwonchoi/remote-mdx

Use MDX in your React App
https://github.com/devjiwonchoi/remote-mdx

frontmatter jsx markdown md mdx nextjs react remote rsc vite

Last synced: 3 days ago
JSON representation

Use MDX in your React App

• Host: GitHub
• URL: https://github.com/devjiwonchoi/remote-mdx
• Owner: devjiwonchoi
• License: mit
• Created: 2024-03-18T16:44:13.000Z (6 months ago)
• Default Branch: main
• Last Pushed: 2024-04-26T07:48:12.000Z (5 months ago)
• Last Synced: 2024-05-02T06:05:50.648Z (5 months ago)
• Topics: frontmatter, jsx, markdown, md, mdx, nextjs, react, remote, rsc, vite
• Language: TypeScript
• Homepage: https://npmjs.com/remote-mdx
• Size: 53.7 KB
• Stars: 8
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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](https://github.com/vercel/next.js/issues/63318), but I found some inefficiencies in the original package.

After getting inspired by [this discussion](https://github.com/hashicorp/next-mdx-remote/discussions/437), 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.

```diff

- 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'

```