autolinkHeadings()

Автоматически добавляет якорные ссылки к заголовкам.

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

Сигнатура

function autolinkHeadings(options?: AutolinkHeadingsOptions): UnifastPlugin

Параметры

options?

Конфигурация поведения ссылок в заголовках

СвойствоТипПо умолчаниюОписание
behavior"prepend" | "append" | "wrap""prepend"Где расположить якорную ссылку относительно содержимого заголовка

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

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

const md = `# Introduction

## Getting Started

### Installation`;

const result = compile(md, {
  plugins: [
    autolinkHeadings({
      behavior: "prepend", // "prepend" | "append" | "wrap"
    }),
  ],
});

Примеры

Заголовки с якорными ссылками