wikilink

package module

v0.0.0-...-5513b41 Latest Latest Go to latest Published: Jan 5, 2021 License: MIT Imports: 10 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

goldmark-wikilink is an goldmark extension that parses and renders [[Wiki Links]].

go get github.com/oliger/goldmark-wikilink

See wikilink_test.go.

This section is empty.

View Source

var WikiLink = newWithDefaultOptions()

WikiLink is a goldmark extension configured with default options.

func New(opts ...Option) goldmark.Extender

New returns a goldmark extension that can be configured with options.

type Option func(*wikiLinkExtension)

Option is used to configure the extension.

func WithAliasDelimiter(aliasDelimiter byte) Option

WithAliasDelimiter sets alias delimiter.

func WithRenderFunc(renderFunc RenderFunc) Option

WithRenderFunc sets the function used to render wikilinks.

func WithResolveDestinationFunc(resolveDestinationFunc ResolveDestinationFunc) Option

WithResolveDestinationFunc sets the function used to resolve destination.

type RenderFunc func(wl *ast.WikiLink) string

RenderFunc renders a wiki link.

type ResolveDestinationFunc func(rawDest []byte) (string, bool)

ResolveDestinationFunc maps a raw destination to a file path and determines if the file exists.

Path	Synopsis
ast