Documentation
¶
Index ¶
- type HTMLRenderer
- type MarkdownRenderer
- func (r *MarkdownRenderer) Render(nodes []nodes.Node) error
- func (r *MarkdownRenderer) RenderChildren(node nodes.Node) error
- func (r *MarkdownRenderer) RenderCode(node *nodes.CodeNode) error
- func (r *MarkdownRenderer) RenderDirective(node *nodes.DirectiveNode) error
- func (r *MarkdownRenderer) RenderEmphasis(node *nodes.EmphasisNode) error
- func (r *MarkdownRenderer) RenderHeading(node *nodes.HeadingNode) error
- func (r *MarkdownRenderer) RenderLink(node *nodes.LinkNode) error
- func (r *MarkdownRenderer) RenderList(node *nodes.ListNode) error
- func (r *MarkdownRenderer) RenderListItem(node *nodes.ListItemNode) error
- func (r *MarkdownRenderer) RenderMeta(node *nodes.MetaNode) error
- func (r *MarkdownRenderer) RenderNode(node nodes.Node) error
- func (r *MarkdownRenderer) RenderParagraph(node *nodes.ParagraphNode) error
- func (r *MarkdownRenderer) RenderStrong(node *nodes.StrongNode) error
- func (r *MarkdownRenderer) RenderTable(node *nodes.TableNode) error
- func (r *MarkdownRenderer) String() string
- type PDFRenderer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type HTMLRenderer ¶
type HTMLRenderer struct {
// contains filtered or unexported fields
}
HTMLRederer is a renderer that renders nodes to HTML.
func NewHTMLRenderer ¶
func NewHTMLRenderer() *HTMLRenderer
NewHTMLRederer creates a new HTMLRederer.
func (*HTMLRenderer) Render ¶
func (r *HTMLRenderer) Render(nodes []nodes.Node) string
Render renders nodes to HTML.
func (*HTMLRenderer) RenderPretty ¶
func (r *HTMLRenderer) RenderPretty(nodes []nodes.Node) string
RenderPretty renders the given nodes as pretty-formatted HTML.
type MarkdownRenderer ¶
type MarkdownRenderer struct {
// contains filtered or unexported fields
}
MarkdownRenderer implements a Markdown renderer with the same interface as HTMLRenderer
func NewMarkdownRenderer ¶
func NewMarkdownRenderer() *MarkdownRenderer
NewMarkdownRenderer creates a new Markdown renderer
func (*MarkdownRenderer) Render ¶
func (r *MarkdownRenderer) Render(nodes []nodes.Node) error
Render renders a slice of nodes to Markdown
func (*MarkdownRenderer) RenderChildren ¶
func (r *MarkdownRenderer) RenderChildren(node nodes.Node) error
RenderChildren renders child nodes
func (*MarkdownRenderer) RenderCode ¶
func (r *MarkdownRenderer) RenderCode(node *nodes.CodeNode) error
RenderCode renders a code node
func (*MarkdownRenderer) RenderDirective ¶
func (r *MarkdownRenderer) RenderDirective(node *nodes.DirectiveNode) error
RenderDirective renders a directive node
func (*MarkdownRenderer) RenderEmphasis ¶
func (r *MarkdownRenderer) RenderEmphasis(node *nodes.EmphasisNode) error
RenderEmphasis renders an emphasis node
func (*MarkdownRenderer) RenderHeading ¶
func (r *MarkdownRenderer) RenderHeading(node *nodes.HeadingNode) error
RenderHeading renders a heading node
func (*MarkdownRenderer) RenderLink ¶
func (r *MarkdownRenderer) RenderLink(node *nodes.LinkNode) error
RenderLink renders a link node
func (*MarkdownRenderer) RenderList ¶
func (r *MarkdownRenderer) RenderList(node *nodes.ListNode) error
RenderList renders a list node
func (*MarkdownRenderer) RenderListItem ¶
func (r *MarkdownRenderer) RenderListItem(node *nodes.ListItemNode) error
RenderListItem renders a list item node
func (*MarkdownRenderer) RenderMeta ¶
func (r *MarkdownRenderer) RenderMeta(node *nodes.MetaNode) error
RenderMeta renders a meta node
func (*MarkdownRenderer) RenderNode ¶
func (r *MarkdownRenderer) RenderNode(node nodes.Node) error
RenderNode renders a single node to Markdown
func (*MarkdownRenderer) RenderParagraph ¶
func (r *MarkdownRenderer) RenderParagraph(node *nodes.ParagraphNode) error
RenderParagraph renders a paragraph node
func (*MarkdownRenderer) RenderStrong ¶
func (r *MarkdownRenderer) RenderStrong(node *nodes.StrongNode) error
RenderStrong renders a strong node
func (*MarkdownRenderer) RenderTable ¶
func (r *MarkdownRenderer) RenderTable(node *nodes.TableNode) error
RenderTable renders a table node
func (*MarkdownRenderer) String ¶
func (r *MarkdownRenderer) String() string
String returns the rendered markdown as a string
type PDFRenderer ¶
type PDFRenderer struct {
// contains filtered or unexported fields
}
PDFRenderer implements rendering RST nodes to PDF format
func (*PDFRenderer) Render ¶
func (r *PDFRenderer) Render(nodes []nodes.Node) error
Render renders a slice of nodes to PDF
func (*PDFRenderer) SaveToFile ¶
func (r *PDFRenderer) SaveToFile(filename string) error
SaveToFile saves the PDF to a file
Source Files