@unifast/vite

Overview

@unifast/vite is a Vite plugin that transforms .md and .mdx files into JavaScript modules. It integrates unifast’s Markdown/MDX compiler into the Vite build pipeline, enabling you to import Markdown files directly in your application.

Installation

@unifast/node is a peer dependency (optional) — when available, the plugin uses the native Rust compiler for maximum performance. Without it, .md files fall back to basic HTML rendering, and .mdx files require it.

Quick Start

// vite.config.ts
import { defineConfig } from "vite";
import unifast from "@unifast/vite";

export default defineConfig({
  plugins: [
    unifast({
      md: {
        // compile options for .md files
      },
      mdx: {
        // compile options for .mdx files
      },
    }),
  ],
});

// App.tsx
import doc from "./content/hello.md";

console.log(doc.html);         // compiled HTML string
console.log(doc.frontmatter);  // parsed frontmatter object
console.log(doc.toc);          // table of contents entries

Module Exports

.md files

Each .md file is transformed into a module with the following exports:

.mdx files

Each .mdx file is compiled to a JSX module using React’s jsx-runtime. It exports a default React component along with frontmatter and toc.

Exports Summary