autolinkHeadings()

Fügt Überschriften automatisch Anker-Links hinzu.

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

Signatur

function autolinkHeadings(options?: AutolinkHeadingsOptions): UnifastPlugin

Parameter

options?

Konfiguration für das Verhalten der Überschriften-Links

EigenschaftTypStandardBeschreibung
behavior"prepend" | "append" | "wrap""prepend"Position des Anker-Links relativ zum Überschrifteninhalt

Verwendung

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

const md = `# Introduction

## Getting Started

### Installation`;

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

Beispiele