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

使用例

アンカーリンク付きの見出し