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

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

Involved Source Files d html.go Package html implements renderer that outputs HTMLs.

Package-Level Type Names (total 7)

/* sort by: alphabet | popularity */

type Config (struct) A Config struct has configurations for the HTML based renderers. Fields (total 5) EastAsianLineBreaks EastAsianLineBreaks HardWraps bool Unsafe bool Writer Writer XHTML bool Methods (only one) (*Config) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.NodeRenderer.SetOption. Implements (at least one exported) *Config : 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 EastAsianLineBreaks int (basic type) A EastAsianLineBreaks is a style of east asian line breaks. As Inputs Of (at least one exported) func WithEastAsianLineBreaks(e EastAsianLineBreaks) interface{renderer.Option; Option} As Types Of (total 3) const EastAsianLineBreaksCSS3Draft const EastAsianLineBreaksNone const EastAsianLineBreaksSimple

type Option (interface) An Option interface sets options for HTML based renderers. Methods (only one) ( Option) SetHTMLOption(*Config) As Inputs Of (at least 6) 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

type Renderer (struct) A Renderer struct is an implementation of renderer.NodeRenderer that renders nodes as (X)HTML. Fields (total 6) Config Config Config.EastAsianLineBreaks EastAsianLineBreaks Config.HardWraps bool Config.Unsafe bool Config.Writer Writer Config.XHTML bool Methods (total 2) (*Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer) RegisterFuncs implements NodeRenderer.RegisterFuncs . (*Renderer) SetOption(name renderer.OptionName, value interface{}) SetOption implements renderer.NodeRenderer.SetOption. Implements (at least 2) *Renderer : github.com/yuin/goldmark/renderer.NodeRenderer *Renderer : github.com/yuin/goldmark/renderer.SetOptioner

type Writer (interface) A Writer interface writes textual contents to a writer. Methods (total 3) ( Writer) RawWrite(writer util.BufWriter, source []byte) RawWrite writes the given source to writer without resolving references and unescaping backslash escaped characters. ( Writer) SecureWrite(writer util.BufWriter, source []byte) SecureWrite writes the given source to writer with replacing insecure characters. ( Writer) Write(writer util.BufWriter, source []byte) Write writes the given source to writer with resolving references and unescaping backslash escaped characters. As Outputs Of (at least one exported) func NewWriter(opts ...WriterOption) Writer As Inputs Of (at least one exported) func WithWriter(writer Writer) interface{renderer.Option; Option} As Types Of (only one) var DefaultWriter

type WriterConfig (struct) A WriterConfig struct has configurations for the HTML based writers. Fields (only one) EscapedSpace bool EscapedSpace is an option that indicates that a '\' escaped half-space(0x20) should not be rendered.

type WriterOption (func) A WriterOption interface sets options for HTML based writers. As Outputs Of (at least one exported) func WithEscapedSpace() WriterOption As Inputs Of (at least one exported) func NewWriter(opts ...WriterOption) Writer

Package-Level Functions (total 11)

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 NewWriter(opts ...WriterOption) Writer NewWriter returns a new Writer.

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 WithEastAsianLineBreaks(e EastAsianLineBreaks) interface{renderer.Option; Option} WithEastAsianLineBreaks is a functional option that indicates whether softline breaks between east asian wide characters should be ignored.

func WithEscapedSpace() WriterOption WithEscapedSpace is a WriterOption indicates that a '\' escaped half-space(0x20) should not be rendered.

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.

Package-Level Variables (total 12)

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 Writer DefaultWriter is a default instance 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.

Package-Level Constants (total 3)

const EastAsianLineBreaksCSS3Draft EastAsianLineBreaks = 2 EastAsianLineBreaksCSS3Draft follows CSS text level3 "Segment Break Transformation Rules" with some enhancements.

const EastAsianLineBreaksNone EastAsianLineBreaks = 0 EastAsianLineBreaksNone renders line breaks as it is.

const EastAsianLineBreaksSimple EastAsianLineBreaks = 1 EastAsianLineBreaksSimple follows east_asian_line_breaks in Pandoc.