markdown

package

v2.1.1 Latest Latest Go to latest Published: Jul 7, 2022 License: MIT Imports: 13 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 renderer renders the given AST to certain formats.

This section is empty.

This section is empty.

This section is empty.

type Option func(r *Renderer)

func WithSoftWraps() Option

WithSoftWraps allows you to wrap lines even on soft line breaks.

func WithUnderlineHeadings() Option

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

Renderer allows to render markdown AST into markdown bytes in consistent format. Render is reusable across Renders, it holds configuration only.

func NewRenderer() *Renderer

func (mr *Renderer) AddMarkdownOptions(opts ...Option)

func (mr *Renderer) AddOptions(...renderer.Option)

func (mr *Renderer) Render(w io.Writer, source []byte, node ast.Node) error

Render renders the given AST node to the given buffer with the given Renderer. NOTE: This is the entry point used by Goldmark.