Skip to content

Commit

Permalink
docs: update readme on samples
Browse files Browse the repository at this point in the history
  • Loading branch information
petyosi committed Jan 4, 2024
1 parent bfa763c commit 7739e7d
Showing 1 changed file with 2 additions and 3 deletions.
5 changes: 2 additions & 3 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -110,7 +110,7 @@ Check the [MDX editor in Next.js (pages) GitHub sample repository for a working

### Vite

MDXEditor "just works" in Vite, assuming that you use a recent version of it. The only thing you need to watch out for is for the imports to come from the specific path rather than the catch-all one, since TypeScript autocompletes both.
MDXEditor "just works" in Vite, assuming that you use a recent version of it.

Here's a minimal example for App.tsx:

Expand All @@ -132,8 +132,7 @@ If you get stuck, check the [MDX editor in Vite GitHub sample repository for a w

### Remix

Remix seems [to struggle with ESM-only packages](https://github.com/remix-run/remix/issues/109), like MDXEditor itself and several of its dependencies. To work around that, ensure that you list all problematic modules in the `serverDependenciesToBundle` field.
Check the working example that uses dynamic imports in the [MDX editor in the Remix GitHub sample repository](https://github.com/mdx-editor/mdx-editor-in-remix).
The component works well with the [ClientOnly remix utility](https://github.com/sergiodxa/remix-utils/tree/main?tab=readme-ov-file#clientonly). Check the working example in the [MDX editor in the Remix GitHub sample repository](https://github.com/mdx-editor/mdx-editor-in-remix).

### Create React App

Expand Down

0 comments on commit 7739e7d

Please sign in to comment.