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"
    }),
  ],
});

예시

앵커 링크가 달린 제목