gfm()

Membuat plugin GFM yang mengaktifkan ekstensi GitHub Flavored Markdown.

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

Signature

function gfm(options?: GfmPluginOptions): UnifastPlugin

Parameter

options?

Konfigurasi untuk masing-masing fitur GFM

PropertiTipeDefaultDeskripsi
tablesbooleantrueMengaktifkan pipe table dengan sintaks |
taskListbooleantrueMengaktifkan checkbox task list - [x] / - [ ]
strikethroughbooleantrueMengaktifkan sintaks strikethrough dihapus
footnotesbooleantrueMengaktifkan referensi footnote 1 dan definisinya
autolinkbooleantrueSecara otomatis melakukan link pada URL telanjang

Penggunaan

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

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

Contoh

Tabel

Task List

Footnote