package renderer

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

Dependency Relation
	imports 5 packages, and imported by 6 packages

Involved Source Files

	   d➜ renderer.go
		Package renderer renders the given AST to certain formats.
Package-Level Type Names (total 11, in which 8 are exported)

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

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

	 type NodeRenderer (interface)
		A NodeRenderer interface offers NodeRendererFuncs.

		Methods (only one, which is exported)
			( T) RegisterFuncs(NodeRendererFuncRegisterer)
				RendererFuncs registers NodeRendererFuncs to given NodeRendererFuncRegisterer.

		Implemented By (at least 10, in which 7 are exported)
			*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
			*golang.org/x/pkgsite/internal/postgres.HTMLRenderer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*github.com/yuin/goldmark-emoji.emojiHTMLRenderer
			*golang.org/x/pkgsite/internal/frontend.guideRenderer
			*golang.org/x/pkgsite/internal/frontend.htmlRenderer
		As Outputs Of (at least 9, in which 8 are exported)
			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
			func github.com/yuin/goldmark-emoji.NewHTMLRenderer(opts ...emoji.RendererOption) NodeRenderer
			func golang.org/x/pkgsite/internal/postgres.NewHTMLRenderer(opts ...html.Option) NodeRenderer
			/* at least one unexported ... *//* at least one unexported: */
			func golang.org/x/pkgsite/internal/frontend.newHTMLRenderer(info *source.Info, readme *internal.Readme, 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

		Methods (only one, which is exported)
			( T) Register(ast.NodeKind, NodeRendererFunc)
				Register registers given NodeRendererFunc to this object.

		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*renderer
		As Inputs Of (at least 8, all are exported)
			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)
			func golang.org/x/pkgsite/internal/postgres.(*HTMLRenderer).RegisterFuncs(reg NodeRendererFuncRegisterer)

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

		Methods (only one, which is exported)
			( T) SetConfig(*Config)
		Implemented By (at least 22, in which 3 are exported)
			 github.com/yuin/goldmark/extension.FootnoteOption (interface)
			 github.com/yuin/goldmark/extension.TableOption (interface)
			 github.com/yuin/goldmark-emoji.RendererOption (interface)
			/* 19+ unexporteds ... *//* 19+ unexporteds: */
			*withNodeRenderers
			*withOption
			*github.com/yuin/goldmark/renderer/html.withHardWraps
			*github.com/yuin/goldmark/renderer/html.withUnsafe
			*github.com/yuin/goldmark/renderer/html.withWriter
			*github.com/yuin/goldmark/renderer/html.withXHTML
			*github.com/yuin/goldmark/extension.withFootnoteBacklinkClass
			*github.com/yuin/goldmark/extension.withFootnoteBacklinkHTML
			*github.com/yuin/goldmark/extension.withFootnoteBacklinkTitle
			*github.com/yuin/goldmark/extension.withFootnoteHTMLOptions
			*github.com/yuin/goldmark/extension.withFootnoteIDPrefix
			*github.com/yuin/goldmark/extension.withFootnoteIDPrefixFunction
			*github.com/yuin/goldmark/extension.withFootnoteLinkClass
			*github.com/yuin/goldmark/extension.withFootnoteLinkTitle
			*github.com/yuin/goldmark/extension.withTableCellAlignMethod
			*github.com/yuin/goldmark/extension.withTableHTMLOptions
			*github.com/yuin/goldmark-emoji.withRendererFunc
			*github.com/yuin/goldmark-emoji.withRenderingMethod
			*github.com/yuin/goldmark-emoji.withTwemojiTemplate
		As Outputs Of (at least 2, both are exported)
			func WithNodeRenderers(ps ...util.PrioritizedValue) Option
			func WithOption(name OptionName, value interface{}) Option
		As Inputs Of (at least 3, all are exported)
			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 6, all are exported)
			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{})
			func github.com/yuin/goldmark-emoji.(*RendererConfig).SetOption(name OptionName, value interface{})
		As Types Of (total 15, none are exported)
			/* 15 unexporteds ... *//* 15 unexporteds: */
			const github.com/yuin/goldmark/renderer/html.optHardWraps
			const github.com/yuin/goldmark/renderer/html.optTextWriter
			const github.com/yuin/goldmark/renderer/html.optUnsafe
			const github.com/yuin/goldmark/renderer/html.optXHTML
			const github.com/yuin/goldmark/extension.optFootnoteBacklinkClass
			const github.com/yuin/goldmark/extension.optFootnoteBacklinkHTML
			const github.com/yuin/goldmark/extension.optFootnoteBacklinkTitle
			const github.com/yuin/goldmark/extension.optFootnoteIDPrefix
			const github.com/yuin/goldmark/extension.optFootnoteIDPrefixFunction
			const github.com/yuin/goldmark/extension.optFootnoteLinkClass
			const github.com/yuin/goldmark/extension.optFootnoteLinkTitle
			const github.com/yuin/goldmark/extension.optTableCellAlignMethod
			const github.com/yuin/goldmark-emoji.optRendererFunc
			const github.com/yuin/goldmark-emoji.optRenderingMethod
			const github.com/yuin/goldmark-emoji.optTwemojiTemplate

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

		Methods (total 2, both are exported)
			( T) AddOptions(...Option)
				AddOptions adds given option to this renderer.

			( T) Render(w io.Writer, source []byte, n ast.Node) error
		Implemented By (at least one unexported)
			/* at least one unexported ... *//* at least one unexported: */
			*renderer
		As Outputs Of (at least 3, all are exported)
			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, both are exported)
			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, which is exported)
			( T) 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 14, in which 11 are exported)
			*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
			*github.com/yuin/goldmark-emoji.RendererConfig
			*golang.org/x/pkgsite/internal/postgres.HTMLRenderer
			/* 3+ unexporteds ... *//* 3+ unexporteds: */
			*github.com/yuin/goldmark-emoji.emojiHTMLRenderer
			*golang.org/x/pkgsite/internal/frontend.guideRenderer
			*golang.org/x/pkgsite/internal/frontend.htmlRenderer

	/* 3 unexporteds ... *//* 3 unexporteds: */
	 type renderer (struct)

		Fields (total 6, none are exported)
			/* 6 unexporteds ... *//* 6 unexporteds: */
			config *Config
			initSync sync.Once
			maxKind int
			nodeRendererFuncs []NodeRendererFunc
			nodeRendererFuncsTmp map[ast.NodeKind]NodeRendererFunc
			options map[OptionName]interface{}
		Methods (total 3, all are exported)
			(*T) AddOptions(opts ...Option)
			(*T) Register(kind ast.NodeKind, v NodeRendererFunc)
			(*T) Render(w io.Writer, source []byte, n ast.Node) error
				Render renders the given AST node to the given writer with the given Renderer.

		Implements (at least 2, both are exported)
			*T : NodeRendererFuncRegisterer
			*T : Renderer

	 type withNodeRenderers (struct)

		Fields (only one, which is unexported)
			/* one unexported ... *//* one unexported: */
			value []util.PrioritizedValue
		Methods (only one, which is exported)
			(*T) SetConfig(c *Config)
		Implements (at least one exported)
			*T : Option

	 type withOption (struct)

		Fields (total 2, neither is exported)
			/* 2 unexporteds ... *//* 2 unexporteds: */
			name OptionName
			value interface{}
		Methods (only one, which is exported)
			(*T) SetConfig(c *Config)
		Implements (at least one exported)
			*T : Option


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

	 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.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.