wikilink

README

goldmark-wikilink

A goldmark plugin for wikilinks adapted from github.com/dangoor/goldmark-wikilinks.

Usage

package main

import (
	"bytes"

	"git.sr.ht/~idmyn/goldmark-wikilink"
	"github.com/yuin/goldmark"
	"github.com/yuin/goldmark/parser"
)

func main() {
	markdown := goldmark.New(
		goldmark.WithExtensions(
			wikilink.Wikilink,
		),
	)

	source := `foo [[bar baz]]`

	var buf bytes.Buffer
	context := parser.NewContext()
	if err := markdown.Convert([]byte(source), &buf, parser.WithContext(context)); err != nil {
		panic(err)
	}

	htmlOutput := buf.String() // "<p>foo <a href="bar-baz.html" class="wikilink">bar baz</a></p>"
	destinationSlugs := wikilink.Get(context) // []string{"bar-baz"}
}

Documentation

Index

• Variables
• func Get(pc parser.Context) []string

Variables

var Wikilink = &wikilink{}

Wikilink is a goldmark extension to transform internal links [[looking like this]] into html <a href="looking-like-this.html" class="wikilink">looking like this</a>.

Functions

func Get

func Get(pc parser.Context) []string

Get returns a slice of wikilink destination slugs