package goldmark

Import Path
	github.com/yuin/goldmark (on go.dev)

Dependency Relation
	imports 6 packages, and imported by 3 packages

Involved Source Files

	   d➜ markdown.go
		Package goldmark implements functions to convert markdown text to a desired format.
Package-Level Type Names (total 4, in which 3 are exported)

	/* sort exporteds by: alphabet | popularity */
	 type Extender (interface)
		An Extender interface is used for extending Markdown.

		Methods (only one, which is exported)
			( T) Extend(Markdown)
				Extend extends the Markdown.

		Implemented By (at least 9, none are exported)
			/* 9+ unexporteds ... *//* 9+ unexporteds: */
			*github.com/yuin/goldmark/extension.definitionList
			*github.com/yuin/goldmark/extension.footnote
			*github.com/yuin/goldmark/extension.gfm
			*github.com/yuin/goldmark/extension.linkify
			*github.com/yuin/goldmark/extension.strikethrough
			*github.com/yuin/goldmark/extension.table
			*github.com/yuin/goldmark/extension.taskList
			*github.com/yuin/goldmark/extension.typographer
			*github.com/yuin/goldmark-emoji.emoji
		As Outputs Of (at least 5, all are exported)
			func github.com/yuin/goldmark/extension.NewFootnote(opts ...extension.FootnoteOption) Extender
			func github.com/yuin/goldmark/extension.NewLinkify(opts ...extension.LinkifyOption) Extender
			func github.com/yuin/goldmark/extension.NewTable(opts ...extension.TableOption) Extender
			func github.com/yuin/goldmark/extension.NewTypographer(opts ...extension.TypographerOption) Extender
			func github.com/yuin/goldmark-emoji.New(opts ...emoji.Option) Extender
		As Inputs Of (at least one exported)
			func WithExtensions(ext ...Extender) Option

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

		Methods (total 5, all are exported)
			( T) Convert(source []byte, writer io.Writer, opts ...parser.ParseOption) error
				Convert interprets a UTF-8 bytes source in Markdown and write rendered
				contents to a writer w.

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

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

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

			( T) SetRenderer(renderer.Renderer)
				SetRenderer sets a Renderer to this object.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*markdown
		As Outputs Of (at least one exported)
			func New(options ...Option) Markdown
		As Inputs Of (at least one exported)
			func Extender.Extend(Markdown)
		As Types Of (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			  var defaultMarkdown

	 type Option (func)
		Option is a functional option type for Markdown objects.

		As Outputs Of (at least 5, all are exported)
			func WithExtensions(ext ...Extender) Option
			func WithParser(p parser.Parser) Option
			func WithParserOptions(opts ...parser.Option) Option
			func WithRenderer(r renderer.Renderer) Option
			func WithRendererOptions(opts ...renderer.Option) Option
		As Inputs Of (at least one exported)
			func New(options ...Option) Markdown

	/* one unexported ... *//* one unexported: */
	 type markdown (struct)

		Fields (total 3, none are exported)
			/* 3 unexporteds ... *//* 3 unexporteds: */
			extensions []Extender
			parser parser.Parser
			renderer renderer.Renderer
		Methods (total 5, all are exported)
			(*T) Convert(source []byte, writer io.Writer, opts ...parser.ParseOption) error
			(*T) Parser() parser.Parser
			(*T) Renderer() renderer.Renderer
			(*T) SetParser(v parser.Parser)
			(*T) SetRenderer(v renderer.Renderer)
		Implements (at least one exported)
			*T : Markdown


Package-Level Functions (total 9, all are exported)

	 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.

	 func New(options ...Option) Markdown
		New returns a new Markdown with given options.

	 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.


Package-Level Variables (only one, which is unexported)

	/* one unexported ... *//* one unexported: */
	  var defaultMarkdown Markdown

The pages are generated with Golds v0.3.2-preview. (GOOS=darwin GOARCH=amd64)
Golds is a Go 101 project developed by Tapir Liu.
PR and bug reports are welcome and can be submitted to the issue list.
Please follow @Go100and1 (reachable from the left QR code) to get the latest news of Golds.