wikiLink()

エイリアス対応のウィキスタイル `[[links]]` をサポートします。

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

シグネチャ

function wikiLink(options?: WikiLinkPluginOptions): UnifastPlugin

パラメータ

options?

ウィキリンクの動作設定

プロパティ型デフォルト説明
hrefTemplatestring"/wiki/${slug}"リンク URL を生成するためのテンプレート。スラグ化されたページ名のプレースホルダとして ${slug} を使用します。

使い方

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

const md = `Check out [[Getting Started]] for an introduction.`;

const result = compile(md, {
  plugins: [
    wikiLink({
      hrefTemplate: "/docs/${slug}",
    }),
  ],
});

console.log(result.output);
// <p>Check out <a href="/docs/getting-started">Getting Started</a> for an introduction.</p>

使用例

ウィキスタイルのリンク