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

示例

带锚点链接的标题