gfm()

Crée un plugin GFM qui active les extensions GitHub Flavored Markdown.

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

Signature

function gfm(options?: GfmPluginOptions): UnifastPlugin

Paramètres

options?

Configuration individuelle des fonctionnalités GFM

PropriétéTypeDéfautDescription
tablesbooleantrueActive les tableaux pipe via la syntaxe |
taskListbooleantrueActive les cases à cocher - [x] / - [ ] pour les listes de tâches
strikethroughbooleantrueActive la syntaxe barrée
footnotesbooleantrueActive les références 1 et les définitions de notes de bas de page
autolinkbooleantrueTransforme automatiquement les URL nues en liens

Utilisation

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

const result = compile(md, {
  plugins: [
    gfm({
      tables: true,
      taskList: true,
      strikethrough: true,
      footnotes: true,
      autolink: true,
    }),
  ],
});

Exemples

Tableaux

Listes de tâches

Texte barré et liens automatiques

Notes de bas de page