https://github.com/cyco130/vite-plugin-mdx

MDX plugin for Vite
https://github.com/cyco130/vite-plugin-mdx

Last synced: 2 months ago
JSON representation

MDX plugin for Vite

• Host: GitHub
• URL: https://github.com/cyco130/vite-plugin-mdx
• Owner: cyco130
• License: mit
• Created: 2022-06-05T09:38:56.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-05-06T18:40:49.000Z (8 months ago)
• Last Synced: 2024-05-08T00:15:22.648Z (8 months ago)
• Language: TypeScript
• Size: 452 KB
• Stars: 9
• Watchers: 1
• Forks: 0
• Open Issues: 3
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• fucking-awesome-vite - @cyco130/vite-plugin-mdx - Import MDX. (Plugins / Framework-agnostic Plugins)
• awesome-vite - @cyco130/vite-plugin-mdx - Import MDX. (Plugins / Framework-agnostic Plugins)

README

        
# @cyco130/vite-plugin-mdx

This is a plugin for using [MDX](https://mdxjs.com/) in [Vite](https://vitejs.dev/) applications. It is tested with React, Preact and Solid but should work with any JSX implementation.

## Why not [`vite-plugin-mdx`](https://github.com/brillout/vite-plugin-mdx)?

`vite-plugin-mdx` is currently unmaintained and only supports MDX version 1 whereas `@cyco130/vite-plugin-mdx` supports MDX version 3. In fact, this plugin may one day replace `vite-plugin-mdx`.

## Why not [`@mdx-js/rollup`](https://mdxjs.com/packages/rollup/)?

In some cases it can interfere with Vite's dependency scanning.

## Examples

- [React](./examples/react) ([StackBlitz](https://stackblitz.com/github/cyco130/vite-plugin-mdx/tree/main/examples/react))

- [Preact](./examples/preact) ([StackBlitz](https://stackblitz.com/github/cyco130/vite-plugin-mdx/tree/main/examples/preact))

- [Solid](./examples/solid) ([StackBlitz](https://stackblitz.com/github/cyco130/vite-plugin-mdx/tree/main/examples/solid))

## Credits

This plugin is heavily based on [`@mdx-js/rollup`](https://mdxjs.com/packages/rollup/).