wikiLink()

Suporta links no estilo wiki `[[links]]` com aliases opcionais.

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

Assinatura

function wikiLink(options?: WikiLinkPluginOptions): UnifastPlugin

Parâmetros

options?

Configuração para o comportamento dos wiki links

PropriedadeTipoPadrãoDescrição
hrefTemplatestring"/wiki/${slug}"Template para gerar URLs de link. Use ${slug} como placeholder para o nome da página em formato slug.

Uso

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>

Exemplos