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() parser.Parser
DefaultParser returns a new Parser that is configured by default values.
func DefaultRenderer() renderer.Renderer
DefaultRenderer returns a new Renderer that is configured by default values.
An Extender interface is used for extending Markdown.
type Extender interface {
// Extend extends the Markdown.
Extend(Markdown)
}
A Markdown interface offers functions to convert Markdown text to a desired format.
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)
}
func New(options ...Option) Markdown
New returns a new Markdown with given options.
Option is a functional option type for Markdown objects.
type Option func(*markdown)
func WithExtensions(ext ...Extender) Option
WithExtensions adds extensions.
func WithParser(p parser.Parser) Option
WithParser allows you to override the default parser.
func WithParserOptions(opts ...parser.Option) Option
WithParserOptions applies options for the parser.
func WithRenderer(r renderer.Renderer) Option
WithRenderer allows you to override the default renderer.
func WithRendererOptions(opts ...renderer.Option) Option
WithRendererOptions applies options for the renderer.
| Name | Synopsis |
|---|---|
| .. | |
| ast | Package ast defines AST nodes that represent markdown elements. |
| extension | Package extension is a collection of builtin extensions. |
| ast | Package ast defines AST nodes that represents extension's elements |
| parser | Package parser contains stuff that are related to parsing a Markdown text. |
| renderer | Package renderer renders the given AST to certain formats. |
| html | Package html implements renderer that outputs HTMLs. |
| testutil | Package testutil provides utilities for unit tests. |
| text | Package text provides functionalities to manipulate texts. |
| util | Package util provides utility functions for the goldmark. |