gfm()

Erstellt ein GFM-Plugin, das die Erweiterungen von GitHub Flavored Markdown aktiviert.

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

Signatur

function gfm(options?: GfmPluginOptions): UnifastPlugin

Parameter

options?

Konfiguration der einzelnen GFM-Funktionen

EigenschaftTypStandardBeschreibung
tablesbooleantruePipe-Tabellen mit |-Syntax aktivieren
taskListbooleantrue- [x] / - [ ]-Aufgabenlisten-Checkboxen aktivieren
strikethroughbooleantrueDurchstreichungs-Syntax aktivieren
footnotesbooleantrue1-Fußnotenreferenzen und -definitionen aktivieren
autolinkbooleantrueBare URLs automatisch verlinken

Verwendung

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

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

Beispiele

Tabellen

Aufgabenlisten

Fußnoten