wikiLink()

Поддерживает wiki-ссылки `[[links]]` с необязательными алиасами.

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

Сигнатура

function wikiLink(options?: WikiLinkPluginOptions): UnifastPlugin

Параметры

options?

Конфигурация поведения wiki-ссылок

СвойствоТипПо умолчаниюОписание
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>

Примеры

Wiki-ссылки