npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

vite-plugin-mdx-to-html

v0.0.16

Published

Vite Plugin to turn MDX files into HTML

Downloads

96

Readme

vite-plugin-mdx-to-html

Vite Plugin to turn MDX into HTML string.

Stackblitz Example: https://stackblitz.com/edit/vite-plugin-mdx-to-html?file=docs.mdx

Warning

This plugin is built for very small set of usecases like-

  • Using it in template engines that compile to HTML
  • Some Static-Site-Generators that expect HTML
  • SSR in some cases.

The plugin uses React to render to HTML and if used with CSR, it will try to add React to bundle. You probably don't want that.

Looking for using mdx in your React App or some framework? you might want to just use @mdx-js/rollup as suggested by MDX in their documentation.

Installation

npm install --save-dev @mdx-js/rollup vite-plugin-mdx-to-html

# OR

yarn add --dev @mdx-js/rollup vite-plugin-mdx-to-html

Then in vite.config.ts or vite.config.js add the following code

Usage

import { defineConfig } from 'vite';
import mdx from '@mdx-js/rollup';
import { vitePluginMdxToHTML } from 'vite-plugin-mdx-to-html';

export default defineConfig({
  // Make sure the vitePluginMdxToHTML comes after rollup's mdx here.
  plugins: [mdx(), vitePluginMdxToHTML()],
});

You can now import .mdx files anywhere in your vite app and it will be loaded as HTML.

import intro from './intro.mdx';

document.querySelector('#root').innerHTML = intro;

Migration from 0.0.14 -> 0.0.16

Starting 0.0.16, vite-plugin-mdx-to-html is supposed to be used alongside @mdx-js/rollup

import { defineConfig } from 'vite';
+ import mdx from '@mdx-js/rollup';
import { vitePluginMdxToHTML } from 'vite-plugin-mdx-to-html';

export default defineConfig({
  // Make sure the vitePluginMdxToHTML comes after rollup's mdx here.
-  plugins: [vitePluginMdxToHTML()],
+  plugins: [mdx(), vitePluginMdxToHTML()],
});

The options to plugin are removed. Imports are now stable and enabled by default. renderFunction is renderToStaticMarkup by default.

- vitePluginMdxToHTML({
-   enableImports: true,
-   renderFunc: 'renderToStaticMarkup'
- })
+ vitePluginMdxToHTML()