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

範例

帶有錨點連結的標題