markdown

package

v0.44.0 Latest Latest Go to latest Published: Mar 13, 2024 License: Apache-2.0 Imports: 18 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

This section is empty.

This section is empty.

func NewLinkModifierRenderer(opts ...renderer.Option) renderer.Renderer

NewLinkModifierRenderer returns a new linkModifierRenderer with given renderer options.

func Parse(source []byte) (ast.Node, error)

Parse markdown content and returns AST node or error

func WithLinkResolver(linkResolver ResolveLink) renderer.Option

WithLinkResolver is a functional option that allow you to set the ResolveLink to the renderer.

type Renderer struct {
	// contains filtered or unexported fields
}

Renderer holds document source, buffer writer, info for indents and some nodes for rendering a markdown

type ResolveLink func(dest string, isEmbeddable bool) (string, error)

ResolveLink type defines function for modifying link destination dest - original destination isEmbeddable - if true, raw destination required