Package: github.com/yuin/goldmark/renderer/html

package html Import Path github.com/yuin/goldmark/renderer/html (on go.dev) Dependency Relation imports 6 packages, and imported by 5 packages

Involved Source Files html.go

Package-Level Type Names (total 9, in which 4 are exported)

/* sort exporteds by: alphabet | popularity */

type Config (struct) A Config struct has configurations for the HTML based renderers. Fields (total 4, all are exported) HardWraps bool Unsafe bool Writer Writer XHTML bool Methods (only one, which is exported) (*T) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.NodeRenderer.SetOption. Implements (at least one exported) *T : github.com/yuin/goldmark/renderer.SetOptioner As Outputs Of (at least one exported) func NewConfig() Config As Inputs Of (at least one exported) func Option.SetHTMLOption(*Config)

type Option (interface) An Option interface sets options for HTML based renderers. Methods (only one, which is exported) ( T) SetHTMLOption(*Config) Implemented By (at least 4, none are exported) /* 4+ unexporteds ... *//* 4+ unexporteds: */ *withHardWraps *withUnsafe *withWriter *withXHTML As Inputs Of (at least 8, in which 7 are exported) func NewRenderer(opts ...Option) renderer.NodeRenderer func github.com/yuin/goldmark/extension.NewDefinitionListHTMLRenderer(opts ...Option) renderer.NodeRenderer func github.com/yuin/goldmark/extension.NewStrikethroughHTMLRenderer(opts ...Option) renderer.NodeRenderer func github.com/yuin/goldmark/extension.NewTaskCheckBoxHTMLRenderer(opts ...Option) renderer.NodeRenderer func github.com/yuin/goldmark/extension.WithFootnoteHTMLOptions(opts ...Option) extension.FootnoteOption func github.com/yuin/goldmark/extension.WithTableHTMLOptions(opts ...Option) extension.TableOption func golang.org/x/pkgsite/internal/postgres.NewHTMLRenderer(opts ...Option) renderer.NodeRenderer /* at least one unexported ... *//* at least one unexported: */ func golang.org/x/pkgsite/internal/frontend.newHTMLRenderer(info *source.Info, readme *internal.Readme, opts ...Option) renderer.NodeRenderer

type Renderer (struct) A Renderer struct is an implementation of renderer.NodeRenderer that renders nodes as (X)HTML. Fields (total 5, all are exported) Config Config Config.HardWraps bool Config.Unsafe bool Config.Writer Writer Config.XHTML bool Methods (total 22, in which 2 are exported) (*T) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) RegisterFuncs implements NodeRenderer.RegisterFuncs . (*T) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.NodeRenderer.SetOption. /* 20 unexporteds ... *//* 20 unexporteds: */ (*T) renderAutoLink(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderBlockquote(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderCodeBlock(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderCodeSpan(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderDocument(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderEmphasis(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderFencedCodeBlock(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderHTMLBlock(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderHeading(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderImage(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderLink(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderList(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderListItem(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderParagraph(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderRawHTML(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderString(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderText(w util.BufWriter, source []byte, node ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderTextBlock(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) renderThematicBreak(w util.BufWriter, source []byte, n ast.Node, entering bool) (ast.WalkStatus, error) (*T) writeLines(w util.BufWriter, source []byte, n ast.Node) Implements (at least 2, both are exported) *T : github.com/yuin/goldmark/renderer.NodeRenderer *T : github.com/yuin/goldmark/renderer.SetOptioner

type Writer (interface) A Writer interface writes textual contents to a writer. Methods (total 2, both are exported) ( T) RawWrite(writer util.BufWriter, source []byte) RawWrite writes the given source to writer without resolving references and unescaping backslash escaped characters. ( T) Write(writer util.BufWriter, source []byte) Write writes the given source to writer with resolving references and unescaping backslash escaped characters. Implemented By (at least one unexported) /* at least one unexported ... *//* at least one unexported: */ *defaultWriter As Inputs Of (at least one exported) func WithWriter(writer Writer) interface{renderer.Option; Option}

/* 5 unexporteds ... *//* 5 unexporteds: */

type defaultWriter (struct) Methods (total 2, both are exported) (*T) RawWrite(writer util.BufWriter, source []byte) (*T) Write(writer util.BufWriter, source []byte) Implements (at least one exported) *T : Writer As Types Of (only one, which is exported) var DefaultWriter *defaultWriter

type withHardWraps (struct) Methods (total 2, both are exported) (*T) SetConfig(c *renderer.Config) (*T) SetHTMLOption(c *Config) Implements (at least 2, both are exported) *T : Option *T : github.com/yuin/goldmark/renderer.Option

type withUnsafe (struct) Methods (total 2, both are exported) (*T) SetConfig(c *renderer.Config) (*T) SetHTMLOption(c *Config) Implements (at least 2, both are exported) *T : Option *T : github.com/yuin/goldmark/renderer.Option

type withWriter (struct) Fields (only one, which is unexported) /* one unexported ... *//* one unexported: */ value Writer Methods (total 2, both are exported) (*T) SetConfig(c *renderer.Config) (*T) SetHTMLOption(c *Config) Implements (at least 2, both are exported) *T : Option *T : github.com/yuin/goldmark/renderer.Option

type withXHTML (struct) Methods (total 2, both are exported) (*T) SetConfig(c *renderer.Config) (*T) SetHTMLOption(c *Config) Implements (at least 2, both are exported) *T : Option *T : github.com/yuin/goldmark/renderer.Option

Package-Level Functions (total 9, in which 8 are exported)

func IsDangerousURL(url []byte) bool IsDangerousURL returns true if the given url seems a potentially dangerous url, otherwise false.

func NewConfig() Config NewConfig returns a new Config with defaults.

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

func RenderAttributes(w util.BufWriter, node ast.Node, filter util.BytesFilter) RenderAttributes renders given node's attributes. You can specify attribute names to render by the filter. If filter is nil, RenderAttributes renders all attributes.

func WithHardWraps() interface{renderer.Option; Option} WithHardWraps is a functional option that indicates whether softline breaks should be rendered as '<br>'.

func WithUnsafe() interface{renderer.Option; Option} WithUnsafe is a functional option that renders dangerous contents (raw htmls and potentially dangerous links) as it is.

func WithWriter(writer Writer) interface{renderer.Option; Option} WithWriter is a functional option that allow you to set the given writer to the renderer.

func WithXHTML() interface{Option; renderer.Option} WithXHTML is a functional option indicates that nodes should be rendered in xhtml instead of HTML5.

/* one unexported ... *//* one unexported: */

func escapeRune(writer util.BufWriter, r rune)

Package-Level Variables (total 22, in which 12 are exported)

var BlockquoteAttributeFilter util.BytesFilter BlockquoteAttributeFilter defines attribute names which blockquote elements can have

var CodeAttributeFilter util.BytesFilter CodeAttributeFilter defines attribute names which code elements can have.

var DefaultWriter *defaultWriter DefaultWriter is a default implementation of the Writer.

var EmphasisAttributeFilter util.BytesFilter EmphasisAttributeFilter defines attribute names which emphasis elements can have.

var GlobalAttributeFilter util.BytesFilter GlobalAttributeFilter defines attribute names which any elements can have.

var HeadingAttributeFilter util.BytesFilter HeadingAttributeFilter defines attribute names which heading elements can have

var ImageAttributeFilter util.BytesFilter ImageAttributeFilter defines attribute names which image elements can have.

var LinkAttributeFilter util.BytesFilter LinkAttributeFilter defines attribute names which link elements can have.

var ListAttributeFilter util.BytesFilter ListAttributeFilter defines attribute names which list elements can have.

var ListItemAttributeFilter util.BytesFilter ListItemAttributeFilter defines attribute names which list item elements can have.

var ParagraphAttributeFilter util.BytesFilter ParagraphAttributeFilter defines attribute names which paragraph elements can have.

var ThematicAttributeFilter util.BytesFilter ThematicAttributeFilter defines attribute names which hr elements can have.

/* 10 unexporteds ... *//* 10 unexporteds: */

var bData []byte

var bDataImage []byte

var bFile []byte

var bGif []byte

var bJpeg []byte

var bJs []byte

var bPng []byte

var bVb []byte

var bWebp []byte

var dataPrefix []byte

Package-Level Constants (total 4, none are exported) /* 4 unexporteds ... *//* 4 unexporteds: */

const optHardWraps renderer.OptionName = "HardWraps" HardWraps is an option name used in WithHardWraps.

const optTextWriter renderer.OptionName = "Writer" TextWriter is an option name used in WithWriter.

const optUnsafe renderer.OptionName = "Unsafe" Unsafe is an option name used in WithUnsafe.

const optXHTML renderer.OptionName = "XHTML" XHTML is an option name used in WithXHTML.