compileToReact()

Compile une entrée Markdown ou MDX et retourne directement des éléments React, accompagnés du frontmatter, des diagnostics, des statistiques et de la TOC.

import { compileToReact } from "@unifast/react";

Signature

function compileToReact(
  input: string,
  options: CompileToReactOptions,
): CompileToReactResult

Paramètres

input

PropriétéTypeDéfautDescription
inputstring—Source Markdown ou MDX

options

Options de compilation, complétées de la configuration spécifique à React

PropriétéTypeDéfautDescription
createElementCreateElement—La fonction createElement de React
Fragmentunknown—Le composant Fragment de React
components?ComponentMap—Table associant les noms de balises HTML à des composants React

Étend CompileOptions — toutes les autres options de compilation sont également acceptées.

Valeur de retour

PropriétéTypeDescription
elementunknownL’élément React racine
frontmatterRecord<string, unknown>Métadonnées frontmatter analysées
diagnosticsDiagnostic[]Avertissements et erreurs
stats{ parseMs, transformMs, emitMs }Détail du temps passé (ms)
tocTocEntry[]Table des matières extraite

Utilisation

import { createElement, Fragment } from "react";
import { compileToReact } from "@unifast/react";
import { gfm, frontmatter, toc } from "@unifast/node";

const { element, frontmatter: fm, toc: tocEntries, diagnostics, stats } = compileToReact(
  md,
  {
    createElement,
    Fragment,
    components: {
      h1: ({ children, ...props }) => <h1 className="title" {...props}>{children}</h1>,
      a: ({ children, ...props }) => <a target="_blank" {...props}>{children}</a>,
    },
    plugins: [gfm(), frontmatter(), toc()],
  },
);

Exemples

Utilisation de base

import { createElement, Fragment } from "react";
import { compileToReact } from "@unifast/react";

const { element } = compileToReact(
  "# Hello, **world**!",
  { createElement, Fragment },
);

function Page() {
  return <div>{element}</div>;
}

Avec des composants personnalisés

import { createElement, Fragment } from "react";
import { compileToReact } from "@unifast/react";

const { element } = compileToReact(md, {
  createElement,
  Fragment,
  components: {
    h1: ({ children, ...props }) => (
      <h1 className="text-4xl font-bold" {...props}>{children}</h1>
    ),
    a: ({ children, ...props }) => (
      <a className="text-blue-500 underline" target="_blank" {...props}>{children}</a>
    ),
    code: ({ children, ...props }) => (
      <code className="bg-gray-100 rounded px-1" {...props}>{children}</code>
    ),
  },
});

Rendu côté serveur

import { createElement, Fragment } from "react";
import { renderToString } from "react-dom/server";
import { compileToReact } from "@unifast/react";

const { element } = compileToReact(md, { createElement, Fragment });
const html = renderToString(element);

console.log(html);
// Rendered HTML string for SSR

Utilisation du frontmatter et de la TOC

import { createElement, Fragment } from "react";
import { compileToReact } from "@unifast/react";
import { frontmatter, toc } from "@unifast/node";

const md = `---
title: My Page
---

# Introduction

## Setup

## Usage
`;

const result = compileToReact(md, {
  createElement,
  Fragment,
  plugins: [frontmatter(), toc()],
});

console.log(result.frontmatter);
// { title: "My Page" }

console.log(result.toc);
// [
//   { depth: 1, text: "Introduction", slug: "introduction" },
//   { depth: 2, text: "Setup", slug: "setup" },
//   { depth: 2, text: "Usage", slug: "usage" },
// ]