wikiLink()

Prend en charge les liens de style wiki `[[links]]` avec des alias optionnels.

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

Signature

function wikiLink(options?: WikiLinkPluginOptions): UnifastPlugin

Paramètres

options?

Configuration du comportement des liens wiki

PropriétéTypeDéfautDescription
hrefTemplatestring"/wiki/${slug}"Modèle pour générer les URL des liens. Utilisez ${slug} comme marqueur pour le nom de page transformé en slug.

Utilisation

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>

Exemples

Liens de style wiki