gfm()

Crea un plugin GFM que habilita las extensiones de GitHub Flavored Markdown.

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

Firma

function gfm(options?: GfmPluginOptions): UnifastPlugin

Parámetros

options?

Configuración de las funcionalidades individuales de GFM

PropiedadTipoPor defectoDescripción
tablesbooleantrueHabilita tablas con la sintaxis de tubería |
taskListbooleantrueHabilita las casillas de listas de tareas - [x] / - [ ]
strikethroughbooleantrueHabilita la sintaxis de tachado deleted
footnotesbooleantrueHabilita referencias y definiciones de notas al pie 1
autolinkbooleantrueConvierte automáticamente en enlaces las URLs simples

Uso

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

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

Ejemplos

Tablas

Listas de tareas

Tachado y autoenlace

Notas al pie