gfm()

Создаёт плагин GFM, включающий расширения GitHub Flavored Markdown.

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

Сигнатура

function gfm(options?: GfmPluginOptions): UnifastPlugin

Параметры

options?

Конфигурация отдельных возможностей GFM

СвойствоТипПо умолчаниюОписание
tablesbooleantrueВключить таблицы с синтаксисом на |
taskListbooleantrueВключить чекбоксы списков задач - [x] / - [ ]
strikethroughbooleantrueВключить синтаксис зачёркивания удалено
footnotesbooleantrueВключить сноски 1 и их определения
autolinkbooleantrueАвтоматически превращать чистые URL в ссылки

Использование

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

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

Примеры

Таблицы

Списки задач

Зачёркивание и автоссылки

Сноски