Documentation
¶
Index ¶
- type Renderer
- func (r *Renderer) CloseBlock(w io.Writer) error
- func (r *Renderer) OpenBlock(w util.BufWriter, source []byte, node ast.Node) error
- func (r *Renderer) PopPrefix()
- func (r *Renderer) Prefix() string
- func (r *Renderer) PushIndent(amount int)
- func (r *Renderer) PushPrefix(prefix string)
- func (r *Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
- func (r *Renderer) RenderAutoLink(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderBlockquote(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderCodeBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderCodeSpan(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderDocument(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderEmphasis(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderFencedCodeBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderHTMLBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderHeading(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderImage(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderLink(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderLinkReferenceDefinition(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderList(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderListItem(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderParagraph(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderRawHTML(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderString(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderText(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderTextBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderThematicBreak(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) RenderWhitespace(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
- func (r *Renderer) Write(w io.Writer, buf []byte) (int, error)
- func (r *Renderer) WriteByte(w io.Writer, c byte) error
- func (r *Renderer) WriteRune(w io.Writer, c rune) (int, error)
- func (r *Renderer) WriteString(w io.Writer, s string) (int, error)
- func (r *Renderer) Writer(w io.Writer) io.Writer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Renderer ¶
type Renderer struct {
// contains filtered or unexported fields
}
Renderer is a goldmark renderer that produces Markdown output. Due to information loss in goldmark, its output may not be textually identical to the source that produced the AST to be rendered, but the structure should match.
NodeRenderers that want to override rendering of particular node types should write through the Write* functions provided by Renderer in order to retain proper indentation and prefices inside of lists and block quotes.
func (*Renderer) CloseBlock ¶
CloseBlock marks the current block as closed.
func (*Renderer) OpenBlock ¶
OpenBlock ensures that each block begins on a new line, and that blank lines are inserted before blocks as indicated by node.HasPreviousBlankLines.
func (*Renderer) PopPrefix ¶
func (r *Renderer) PopPrefix()
PopPrefix removes the last piece added by a call to PushIndent or PushPrefix from the current line prefix.
func (*Renderer) PushIndent ¶
PushIndent adds the specified amount of indentation to the current line prefix.
func (*Renderer) PushPrefix ¶
PushPrefix adds the specified string to the current line prefix.
func (*Renderer) RegisterFuncs ¶
func (r *Renderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements renderer.NodeRenderer.RegisterFuncs.
func (*Renderer) RenderAutoLink ¶
func (r *Renderer) RenderAutoLink(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderAutoLink renders an *ast.AutoLink node to the given BufWriter.
func (*Renderer) RenderBlockquote ¶
func (r *Renderer) RenderBlockquote(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderBlockquote renders an *ast.Blockquote node to the given BufWriter.
func (*Renderer) RenderCodeBlock ¶
func (r *Renderer) RenderCodeBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderCodeBlock renders an *ast.CodeBlock node to the given BufWriter.
func (*Renderer) RenderCodeSpan ¶
func (r *Renderer) RenderCodeSpan(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderCodeSpan renders an *ast.CodeSpan node to the given BufWriter.
func (*Renderer) RenderDocument ¶
func (r *Renderer) RenderDocument(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderDocument renders an *ast.Document node to the given BufWriter.
func (*Renderer) RenderEmphasis ¶
func (r *Renderer) RenderEmphasis(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderEmphasis renders an *ast.Emphasis node to the given BufWriter.
func (*Renderer) RenderFencedCodeBlock ¶
func (r *Renderer) RenderFencedCodeBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderFencedCodeBlock renders an *ast.FencedCodeBlock node to the given BufWriter.
func (*Renderer) RenderHTMLBlock ¶
func (r *Renderer) RenderHTMLBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderHTMLBlock renders an *ast.HTMLBlock node to the given BufWriter.
func (*Renderer) RenderHeading ¶
func (r *Renderer) RenderHeading(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderHeading renders an *ast.Heading node to the given BufWriter.
func (*Renderer) RenderImage ¶
func (r *Renderer) RenderImage(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderImage renders an *ast.Image node to the given BufWriter.
func (*Renderer) RenderLink ¶
func (r *Renderer) RenderLink(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderLink renders an *ast.Link node to the given BufWriter.
func (*Renderer) RenderLinkReferenceDefinition ¶
func (r *Renderer) RenderLinkReferenceDefinition(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderLinkReferenceDefinition renders an *ast.LinkReferenceDefinition node to the given BufWriter.
func (*Renderer) RenderList ¶
func (r *Renderer) RenderList(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderList renders an *ast.List node to the given BufWriter.
func (*Renderer) RenderListItem ¶
func (r *Renderer) RenderListItem(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderListItem renders an *ast.ListItem node to the given BufWriter.
func (*Renderer) RenderParagraph ¶
func (r *Renderer) RenderParagraph(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderParagraph renders an *ast.Paragraph node to the given BufWriter.
func (*Renderer) RenderRawHTML ¶
func (r *Renderer) RenderRawHTML(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderRawHTML renders an *ast.RawHTML node to the given BufWriter.
func (*Renderer) RenderString ¶
func (r *Renderer) RenderString(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderString renders an *ast.String node to the given BufWriter.
func (*Renderer) RenderText ¶
func (r *Renderer) RenderText(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderText renders an *ast.Text node to the given BufWriter.
func (*Renderer) RenderTextBlock ¶
func (r *Renderer) RenderTextBlock(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderTextBlock renders an *ast.TextBlock node to the given BufWriter.
func (*Renderer) RenderThematicBreak ¶
func (r *Renderer) RenderThematicBreak(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderThematicBreak renders an *ast.ThematicBreak node to the given BufWriter.
func (*Renderer) RenderWhitespace ¶
func (r *Renderer) RenderWhitespace(w util.BufWriter, source []byte, node ast.Node, enter bool) (ast.WalkStatus, error)
RenderWhitespace renders an *ast.Text node to the given BufWriter.
func (*Renderer) Write ¶
Write writes a slice of bytes to an io.Writer, ensuring that appropriate indentation and prefices are added at the beginning of each line.
func (*Renderer) WriteByte ¶
WriteByte writes a byte to an io.Writer, ensuring that appropriate indentation and prefices are added at the beginning of each line.
func (*Renderer) WriteRune ¶
WriteRune writes a rune to an io.Writer, ensuring that appropriate indentation and prefices are added at the beginning of each line.
func (*Renderer) WriteString ¶
WriteString writes a string to an io.Writer, ensuring that appropriate indentation and prefices are added at the beginning of each line.
Source Files