goldmark-wikilink

goldmark-wikilink is an extension for the goldmark Markdown parser that supports parsing [[...]]-style wiki links and ![[...]]-style embedded wiki links.

Demo: A web-based demonstration of the extension is available at https://abhinav.github.io/goldmark-wikilink/demo/.

Installation

go get go.abhg.dev/goldmark/wikilink@latest

Usage

To use goldmark-wikilink, import the wikilink package.

import "go.abhg.dev/goldmark/wikilink"

Then include the wikilink.Extender in the list of extensions that you build your goldmark.Markdown with.

goldmark.New(
  goldmark.WithExtensions(
    &wikilink.Extender{},
  ),
  // ...
)

Link resolution

By default, wikilinks will be converted to URLs based on the page name, unless they already have an extension.

[[Foo]]     => "Foo.html"
[[Foo bar]] => "Foo bar.html"
[[Foo.pdf]] => "Foo.pdf"
[[Foo.png]] => "Foo.png"

You can change this by supplying a custom wikilink.Resolver to your wikilink.Extender when you install it.

goldmark.New(
  goldmark.WithExtensions(
    // ...
    &wikilink.Extender{
      Resolver: myresolver,
    },
  ),
  // ...
)

Embedding images

Use the embedded link form (![[...]]) to add images to a document.

![[foo.png]]

Add alt text to images with the ![[...|...]] form:

![[foo.png|alt text]]