autolinkHeadings()

Añade automáticamente enlaces de ancla a los encabezados.

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

Firma

function autolinkHeadings(options?: AutolinkHeadingsOptions): UnifastPlugin

Parámetros

options?

Configuración del comportamiento de los enlaces de encabezado

PropiedadTipoPor defectoDescripción
behavior"prepend" | "append" | "wrap""prepend"Dónde colocar el enlace de ancla en relación con el contenido del encabezado

Uso

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

const md = `# Introduction

## Getting Started

### Installation`;

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

Ejemplos

Encabezados con enlaces de ancla