math()

import { math } from "@unifast/node";

Signature

function math(): UnifastPlugin

Paramètres

Aucun.

Utilisation

import { compile, math } from "@unifast/node";

const md = `
Einstein's famous equation: $E = mc^2$

The sum of integers from 1 to n:

$$
\sum_{i=1}^{n} i = \frac{n(n+1)}{2}
$$
`;

const result = compile(md, { plugins: [math()] });

Exemples

Expressions mathématiques

Maths en ligne

Utilisez un simple délimiteur $ pour les expressions mathématiques en ligne.

import { compile, math } from "@unifast/node";

const md = `
The quadratic formula is $x = \\frac{-b \\pm \\sqrt{b^2 - 4ac}}{2a}$ and is used to solve quadratic equations.
`;

const result = compile(md, { plugins: [math()] });

Maths en mode affichage

Utilisez les délimiteurs $$ ou un bloc de code identifié avec le langage math pour les expressions en mode affichage.

import { compile, math } from "@unifast/node";

const md = `
$$
\\int_{0}^{\\infty} e^{-x^2} dx = \\frac{\\sqrt{\\pi}}{2}
$$
`;

const result = compile(md, { plugins: [math()] });

Inclusion du CSS KaTeX

Le plugin convertit la syntaxe mathématique en la structure HTML appropriée, mais vous devez inclure le CSS de KaTeX séparément pour obtenir un rendu correct dans le navigateur.

<link
  rel="stylesheet"
  href="https://cdn.jsdelivr.net/npm/[email protected]/dist/katex.min.css"
  crossorigin="anonymous"
/>