markdown

package

v1.0.2 Latest Latest Go to latest Published: Feb 14, 2024 License: MIT Imports: 8 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

Package markdown provides a Markdown renderer.

This section is empty.

This section is empty.

func NewRenderer(opt *Options) blackfriday.Renderer

NewRenderer returns a Markdown renderer. If opt is nil the defaults are used.

func Process(filename string, src []byte, opt *Options) ([]byte, error)

Process formats Markdown. If opt is nil the defaults are used. Error can only occur when reading input from filename rather than src.

type Options struct {
	// Terminal specifies if ANSI escape codes are emitted for styling.
	Terminal bool
}

Options specifies options for formatting.

Path	Synopsis
indentwriter Package indentwriter implements an io.Writer wrapper that indents every non-empty line with specified number of tabs.	Package indentwriter implements an io.Writer wrapper that indents every non-empty line with specified number of tabs.