wikiLink()

Unterstützt Wiki-artige `[[Links]]` mit optionalen Aliassen.

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

Signatur

function wikiLink(options?: WikiLinkPluginOptions): UnifastPlugin

Parameter

options?

Konfiguration für das Verhalten der Wiki-Links

EigenschaftTypStandardBeschreibung
hrefTemplatestring"/wiki/${slug}"Vorlage zur Erzeugung der Link-URLs. Verwenden Sie ${slug} als Platzhalter für den slugifizierten Seitennamen.

Verwendung

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>

Beispiele