markdown

package
v1.7.11 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 7, 2026 License: MIT, MIT Imports: 6 Imported by: 0

Documentation

Overview

Package goldmark implements functions to convert markdown text to a desired format.

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func Convert

func Convert(source []byte, w io.Writer, opts ...parser.ParseOption) error

Convert interprets a UTF-8 bytes source in Markdown and write rendered contents to a writer w.

func DefaultParser

func DefaultParser() parser.Parser

DefaultParser returns a new Parser that is configured by default values.

func DefaultRenderer

func DefaultRenderer() renderer.Renderer

DefaultRenderer returns a new Renderer that is configured by default values.

Types

type Extender

type Extender interface {
	// Extend extends the Markdown.
	Extend(Markdown)
}

An Extender interface is used for extending Markdown.

type Markdown

type Markdown interface {
	// Convert interprets a UTF-8 bytes source in Markdown and write rendered
	// contents to a writer w.
	Convert(source []byte, writer io.Writer, opts ...parser.ParseOption) error

	// Parser returns a Parser that will be used for conversion.
	Parser() parser.Parser

	// SetParser sets a Parser to this object.
	SetParser(parser.Parser)

	// Parser returns a Renderer that will be used for conversion.
	Renderer() renderer.Renderer

	// SetRenderer sets a Renderer to this object.
	SetRenderer(renderer.Renderer)
}

A Markdown interface offers functions to convert Markdown text to a desired format.

func New

func New(options ...Option) Markdown

New returns a new Markdown with given options.

type Option

type Option func(*markdown)

Option is a functional option type for Markdown objects.

func WithExtensions

func WithExtensions(ext ...Extender) Option

WithExtensions adds extensions.

func WithParser

func WithParser(p parser.Parser) Option

WithParser allows you to override the default parser.

func WithParserOptions

func WithParserOptions(opts ...parser.Option) Option

WithParserOptions applies options for the parser.

func WithRenderer

func WithRenderer(r renderer.Renderer) Option

WithRenderer allows you to override the default renderer.

func WithRendererOptions

func WithRendererOptions(opts ...renderer.Option) Option

WithRendererOptions applies options for the renderer.

Directories

Path Synopsis
_benchmark
cmark command
Package ast defines AST nodes that represent markdown elements.
Package ast defines AST nodes that represent markdown elements.
package emoji is a extension for the goldmark
package emoji is a extension for the goldmark
_tools command
ast
Package ast defines AST nodes that represetns emoji extension's elements.
Package ast defines AST nodes that represetns emoji extension's elements.
definition
Code generated by _tools; DO NOT EDIT.
Code generated by _tools; DO NOT EDIT.
Package extension is a collection of builtin extensions.
Package extension is a collection of builtin extensions.
ast
Package ast defines AST nodes that represents extension's elements
Package ast defines AST nodes that represents extension's elements
package highlighting is a extension for the goldmark
package highlighting is a extension for the goldmark
Package parser contains stuff that are related to parsing a Markdown text.
Package parser contains stuff that are related to parsing a Markdown text.
Package renderer renders the given AST to certain formats.
Package renderer renders the given AST to certain formats.
html
Package html implements renderer that outputs HTMLs.
Package html implements renderer that outputs HTMLs.
Package testutil provides utilities for unit tests.
Package testutil provides utilities for unit tests.
Package text provides functionalities to manipulate texts.
Package text provides functionalities to manipulate texts.
Code generated by _tools; DO NOT EDIT.
Code generated by _tools; DO NOT EDIT.

Jump to

Keyboard shortcuts

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