package renderer

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

Dependency Relation
	imports 5 packages, and imported by 3 packages

Involved Source Files

	  d renderer.go
		Package renderer renders the given AST to certain formats.
Package-Level Type Names (total 8)

	/* sort by: alphabet | popularity */
	 type Config (struct)
		A Config struct is a data structure that holds configuration of the Renderer.

		Fields (total 2)
			NodeRenderers util.PrioritizedSlice
			Options map[OptionName]interface{}
		As Outputs Of (at least one exported)
			func NewConfig() *Config
		As Inputs Of (at least 3)
			func Option.SetConfig(*Config)
			func github.com/yuin/goldmark/extension.FootnoteOption.SetConfig(*Config)
			func github.com/yuin/goldmark/extension.TableOption.SetConfig(*Config)

	 type NodeRenderer (interface)
		A NodeRenderer interface offers NodeRendererFuncs.

		Methods (only one)
			( NodeRenderer) RegisterFuncs(NodeRendererFuncRegisterer)
				RendererFuncs registers NodeRendererFuncs to given NodeRendererFuncRegisterer.

		Implemented By (at least 6)
			*github.com/yuin/goldmark/renderer/html.Renderer
			*github.com/yuin/goldmark/extension.DefinitionListHTMLRenderer
			*github.com/yuin/goldmark/extension.FootnoteHTMLRenderer
			*github.com/yuin/goldmark/extension.StrikethroughHTMLRenderer
			*github.com/yuin/goldmark/extension.TableHTMLRenderer
			*github.com/yuin/goldmark/extension.TaskCheckBoxHTMLRenderer
		As Outputs Of (at least 6)
			func github.com/yuin/goldmark/renderer/html.NewRenderer(opts ...html.Option) NodeRenderer
			func github.com/yuin/goldmark/extension.NewDefinitionListHTMLRenderer(opts ...html.Option) NodeRenderer
			func github.com/yuin/goldmark/extension.NewFootnoteHTMLRenderer(opts ...extension.FootnoteOption) NodeRenderer
			func github.com/yuin/goldmark/extension.NewStrikethroughHTMLRenderer(opts ...html.Option) NodeRenderer
			func github.com/yuin/goldmark/extension.NewTableHTMLRenderer(opts ...extension.TableOption) NodeRenderer
			func github.com/yuin/goldmark/extension.NewTaskCheckBoxHTMLRenderer(opts ...html.Option) NodeRenderer

	 type NodeRendererFunc (func)
		NodeRendererFunc is a function that renders a given node.

		As Inputs Of (at least one exported)
			func NodeRendererFuncRegisterer.Register(ast.NodeKind, NodeRendererFunc)

	 type NodeRendererFuncRegisterer (interface)
		A NodeRendererFuncRegisterer registers given NodeRendererFunc to this object.

		Methods (only one)
			( NodeRendererFuncRegisterer) Register(ast.NodeKind, NodeRendererFunc)
				Register registers given NodeRendererFunc to this object.

		As Inputs Of (at least 7)
			func NodeRenderer.RegisterFuncs(NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/renderer/html.(*Renderer).RegisterFuncs(reg NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/extension.(*DefinitionListHTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/extension.(*FootnoteHTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/extension.(*StrikethroughHTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/extension.(*TableHTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)
			func github.com/yuin/goldmark/extension.(*TaskCheckBoxHTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)

	 type Option (interface)
		An Option interface is a functional option type for the Renderer.

		Methods (only one)
			( Option) SetConfig(*Config)
		Implemented By (at least 2)
			 github.com/yuin/goldmark/extension.FootnoteOption (interface)
			 github.com/yuin/goldmark/extension.TableOption (interface)
		As Outputs Of (at least 2)
			func WithNodeRenderers(ps ...util.PrioritizedValue) Option
			func WithOption(name OptionName, value interface{}) Option
		As Inputs Of (at least 3)
			func NewRenderer(options ...Option) Renderer
			func Renderer.AddOptions(...Option)
			func github.com/yuin/goldmark.WithRendererOptions(opts ...Option) goldmark.Option

	 type OptionName string (basic type)
		An OptionName is a name of the option.

		As Inputs Of (at least 5)
			func WithOption(name OptionName, value interface{}) Option
			func SetOptioner.SetOption(name OptionName, value interface{})
			func github.com/yuin/goldmark/renderer/html.(*Config).SetOption(name OptionName, value interface{})
			func github.com/yuin/goldmark/extension.(*FootnoteConfig).SetOption(name OptionName, value interface{})
			func github.com/yuin/goldmark/extension.(*TableConfig).SetOption(name OptionName, value interface{})

	 type Renderer (interface)
		A Renderer interface renders given AST node to given
		writer with given Renderer.

		Methods (total 2)
			( Renderer) AddOptions(...Option)
				AddOptions adds given option to this renderer.

			( Renderer) Render(w io.Writer, source []byte, n ast.Node) error
		As Outputs Of (at least 3)
			func NewRenderer(options ...Option) Renderer
			func github.com/yuin/goldmark.DefaultRenderer() Renderer
			func github.com/yuin/goldmark.Markdown.Renderer() Renderer
		As Inputs Of (at least 2)
			func github.com/yuin/goldmark.WithRenderer(r Renderer) goldmark.Option
			func github.com/yuin/goldmark.Markdown.SetRenderer(Renderer)

	 type SetOptioner (interface)
		A SetOptioner interface sets given option to the object.

		Methods (only one)
			( SetOptioner) SetOption(name OptionName, value interface{})
				SetOption sets given option to the object.
				Unacceptable options may be passed.
				Thus implementations must ignore unacceptable options.

		Implemented By (at least 9)
			*github.com/yuin/goldmark/renderer/html.Config
			*github.com/yuin/goldmark/renderer/html.Renderer
			*github.com/yuin/goldmark/extension.DefinitionListHTMLRenderer
			*github.com/yuin/goldmark/extension.FootnoteConfig
			*github.com/yuin/goldmark/extension.FootnoteHTMLRenderer
			*github.com/yuin/goldmark/extension.StrikethroughHTMLRenderer
			*github.com/yuin/goldmark/extension.TableConfig
			*github.com/yuin/goldmark/extension.TableHTMLRenderer
			*github.com/yuin/goldmark/extension.TaskCheckBoxHTMLRenderer


Package-Level Functions (total 4)

	 func NewConfig() *Config
		NewConfig returns a new Config.

	 func NewRenderer(options ...Option) Renderer
		NewRenderer returns a new Renderer with given options.

	 func WithNodeRenderers(ps ...util.PrioritizedValue) Option
		WithNodeRenderers is a functional option that allow you to add
		NodeRenderers to the renderer.

	 func WithOption(name OptionName, value interface{}) Option
		WithOption is a functional option that allow you to set
		an arbitrary option to the parser.

The pages are generated with Golds v0.8.2. (GOOS=linux 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 @zigo_101 (reachable from the left QR code) to get the latest news of Golds.