@unifast/vite

Visão Geral

O @unifast/vite é um plugin Vite que transforma arquivos .md e .mdx em módulos JavaScript. Ele integra o compilador Markdown/MDX do unifast à pipeline de build do Vite, permitindo que você importe arquivos Markdown diretamente em sua aplicação.

Instalação

O @unifast/node é uma peer dependency (opcional) — quando disponível, o plugin usa o compilador Rust nativo para máxima performance. Sem ele, arquivos .md fazem fallback para uma renderização HTML básica, e arquivos .mdx o exigem.

Início Rápido

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

Exports do Módulo

Arquivos .md

Cada arquivo .md é transformado em um módulo com os seguintes exports:

Arquivos .mdx

Cada arquivo .mdx é compilado para um módulo JSX usando o jsx-runtime do React. Ele exporta um componente React padrão junto com frontmatter e toc.

Resumo de Exports