autolinkHeadings()

Adiciona automaticamente links de âncora aos headings.

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

Assinatura

function autolinkHeadings(options?: AutolinkHeadingsOptions): UnifastPlugin

Parâmetros

options?

Configuração para o comportamento dos links de heading

PropriedadeTipoPadrãoDescrição
behavior"prepend" | "append" | "wrap""prepend"Onde colocar o link de âncora em relação ao conteúdo do heading

Uso

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

const md = `# Introduction

## Getting Started

### Installation`;

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

Exemplos