gfm()

Cria um plugin GFM que habilita as extensões do GitHub Flavored Markdown.

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

Assinatura

function gfm(options?: GfmPluginOptions): UnifastPlugin

Parâmetros

options?

Configuração para funcionalidades individuais do GFM

PropriedadeTipoPadrãoDescrição
tablesbooleantrueHabilita pipe tables com a sintaxe |
taskListbooleantrueHabilita checkboxes de task list - [x] / - [ ]
strikethroughbooleantrueHabilita a sintaxe de strikethrough deleted
footnotesbooleantrueHabilita referências e definições de footnote 1
autolinkbooleantrueLinka automaticamente URLs nuas

Uso

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

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

Exemplos

Tabelas

Task Lists

Footnotes