@unifast/vite

Обзор

@unifast/vite — плагин Vite, который преобразует файлы .md и .mdx в JavaScript-модули. Он интегрирует компилятор Markdown/MDX unifast в конвейер сборки Vite, позволяя импортировать файлы Markdown напрямую в приложении.

Установка

@unifast/node является peer-зависимостью (необязательной) — когда он доступен, плагин использует нативный компилятор на Rust для максимальной производительности. Без него файлы .md переключаются на базовую отрисовку HTML, а файлы .mdx требуют его наличия.

Быстрый старт

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

export default defineConfig({
  plugins: [
    unifast({
      md: {
        // параметры компиляции для файлов .md
      },
      mdx: {
        // параметры компиляции для файлов .mdx
      },
    }),
  ],
});

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

console.log(doc.html);         // скомпилированная строка HTML
console.log(doc.frontmatter);  // распарсенный объект frontmatter
console.log(doc.toc);          // элементы оглавления

Экспорты модулей

Файлы .md

Каждый файл .md преобразуется в модуль со следующими экспортами:

Файлы .mdx

Каждый файл .mdx компилируется в JSX-модуль с использованием React jsx-runtime. Он экспортирует React-компонент по умолчанию вместе с frontmatter и toc.

Сводка экспортов