unifastPlugin()
Cria um plugin Vite que transforma arquivos Markdown e MDX em módulos JavaScript importáveis.
import unifast from "@unifast/vite";Assinatura
function unifastPlugin(options?: UnifastPluginOptions): PluginParâmetros
options?
| Propriedade | Tipo | Padrão | Descrição |
|---|---|---|---|
md | CompileOptions | {} | Opções de compilação aplicadas a arquivos .md |
mdx | CompileOptions | Usa as opções de md | Opções de compilação aplicadas a arquivos .mdx. Faz fallback para md se não especificado |
Retorna
Um objeto Plugin do Vite com:
name:"vite-plugin-unifast"enforce:"pre"— roda antes de outros pluginstransform: Compila arquivos.md/.mdxem módulos JShandleHotUpdate: Dispara HMR quando arquivos Markdown são alterados
Uso
// vite.config.ts
import { defineConfig } from "vite";
import unifast from "@unifast/vite";
import { gfm, frontmatter, syntect } from "@unifast/node";
export default defineConfig({
plugins: [
unifast({
md: {
plugins: [gfm(), frontmatter(), syntect()],
},
}),
],
});Exemplos
Opções separadas para MD e MDX
import unifast from "@unifast/vite";
import { gfm, frontmatter } from "@unifast/node";
export default defineConfig({
plugins: [
unifast({
md: {
plugins: [gfm(), frontmatter()],
},
mdx: {
plugins: [gfm(), frontmatter()],
// MDX-specific options can differ
},
}),
],
});Importar Markdown em componentes
import doc from "./README.md";
// doc.html — compiled HTML string
// doc.frontmatter — parsed frontmatter object
// doc.toc — table of contents entries