markdown

package

v0.0.1 Latest Latest Go to latest Published: Sep 25, 2020 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/gardener/docforge

Links

Open Source Insights

Documentation ¶

Index ¶

func InsertFrontMatter(fm []byte, content []byte) ([]byte, error)
func StripFrontMatter(b []byte) ([]byte, []byte, error)
func TransformLinks(documentBlob []byte, callback OnLink) ([]byte, error)
type OnLink

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func InsertFrontMatter ¶

func InsertFrontMatter(fm []byte, content []byte) ([]byte, error)

InsertFrontMatter prepends the content bytes with front matter enclosed in the standard marks ---

func StripFrontMatter ¶

func StripFrontMatter(b []byte) ([]byte, []byte, error)

StripFrontMatter splits a provided document into front-matter and content.

func TransformLinks ¶

func TransformLinks(documentBlob []byte, callback OnLink) ([]byte, error)

TransformLinks transforms document links destinations, delegating the transformation to a callback invoked on each link TODO: failfast vs fault tolerance support

Types ¶

type OnLink ¶

type OnLink func(destination []byte) ([]byte, error)

OnLink is a callback function invoked on each link by mardown#TransformLinks

Source Files ¶

View all Source files

util.go

Directories ¶

Path	Synopsis
renderer

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL