gfm()

Create a GFM plugin that enables GitHub Flavored Markdown extensions.

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

Signature

function gfm(options?: GfmPluginOptions): UnifastPlugin

Parameters

options?

Configuration for individual GFM features

PropertyTypeDefaultDescription
tablesbooleantrueEnable pipe tables with | syntax
taskListbooleantrueEnable - [x] / - [ ] task list checkboxes
strikethroughbooleantrueEnable deleted strikethrough syntax
footnotesbooleantrueEnable 1 footnote references and definitions
autolinkbooleantrueAutomatically link bare URLs

Usage

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

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

Examples

Tables

Task Lists

Footnotes