Documentation
¶
Index ¶
- func NewConfluenceBlockQuoteRenderer(opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceCodeBlockRenderer(stdlib *stdlib.Lib, path string, opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceFencedCodeBlockRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, mermaidProvider string, ...) renderer.NodeRenderer
- func NewConfluenceHTMLBlockRenderer(stdlib *stdlib.Lib, opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceHeadingRenderer(dropFirstH1 bool, opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceImageRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, path string, ...) renderer.NodeRenderer
- func NewConfluenceLinkRenderer(opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceParagraphRenderer(opts ...html.Option) renderer.NodeRenderer
- func NewConfluenceTextRenderer(stripNL bool, opts ...html.Option) renderer.NodeRenderer
- func ParseLanguage(lang string) string
- func ParseTitle(lang string) string
- type BlockQuoteClassifier
- type BlockQuoteLevelMap
- type BlockQuoteType
- type ConfluenceBlockQuoteRenderer
- type ConfluenceCodeBlockRenderer
- type ConfluenceFencedCodeBlockRenderer
- type ConfluenceHTMLBlockRenderer
- type ConfluenceHeadingRenderer
- type ConfluenceImageRenderer
- type ConfluenceLinkRenderer
- type ConfluenceParagraphRenderer
- type ConfluenceTextRenderer
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func NewConfluenceBlockQuoteRenderer ¶
func NewConfluenceBlockQuoteRenderer(opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceCodeBlockRenderer ¶
func NewConfluenceCodeBlockRenderer(stdlib *stdlib.Lib, path string, opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceFencedCodeBlockRenderer ¶
func NewConfluenceFencedCodeBlockRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, mermaidProvider string, mermaidScale float64, opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceHTMLBlockRenderer ¶
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceHeadingRenderer ¶
func NewConfluenceHeadingRenderer(dropFirstH1 bool, opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceImageRenderer ¶
func NewConfluenceImageRenderer(stdlib *stdlib.Lib, attachments attachment.Attacher, path string, opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceLinkRenderer ¶
func NewConfluenceLinkRenderer(opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceParagraphRenderer ¶
func NewConfluenceParagraphRenderer(opts ...html.Option) renderer.NodeRenderer
NewConfluenceRenderer creates a new instance of the ConfluenceRenderer
func NewConfluenceTextRenderer ¶
func NewConfluenceTextRenderer(stripNL bool, opts ...html.Option) renderer.NodeRenderer
NewConfluenceTextRenderer creates a new instance of the ConfluenceTextRenderer
func ParseLanguage ¶
func ParseTitle ¶
Types ¶
type BlockQuoteClassifier ¶
type BlockQuoteClassifier struct {
// contains filtered or unexported fields
}
func GHAlertsBlockQuoteClassifier ¶
func GHAlertsBlockQuoteClassifier() BlockQuoteClassifier
func LegacyBlockQuoteClassifier ¶
func LegacyBlockQuoteClassifier() BlockQuoteClassifier
func (BlockQuoteClassifier) ClassifyingBlockQuote ¶
func (classifier BlockQuoteClassifier) ClassifyingBlockQuote(literal string) BlockQuoteType
ClassifyingBlockQuote compares a string against a set of patterns and returns a BlockQuoteType
type BlockQuoteLevelMap ¶
func GenerateBlockQuoteLevel ¶
func GenerateBlockQuoteLevel(someNode ast.Node) BlockQuoteLevelMap
GenerateBlockQuoteLevel walks a given node and returns a map of blockquote levels
type BlockQuoteType ¶
type BlockQuoteType int
Define BlockQuoteType enum
const ( Info BlockQuoteType = iota Note Warn Tip None )
func ParseBlockQuoteType ¶
func ParseBlockQuoteType(node ast.Node, source []byte) BlockQuoteType
ParseBlockQuoteType parses the first line of a blockquote and returns its type
func (BlockQuoteType) String ¶
func (t BlockQuoteType) String() string
type ConfluenceBlockQuoteRenderer ¶
type ConfluenceBlockQuoteRenderer struct {
html.Config
LevelMap BlockQuoteLevelMap
}
func (*ConfluenceBlockQuoteRenderer) RegisterFuncs ¶
func (r *ConfluenceBlockQuoteRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceCodeBlockRenderer ¶
func (*ConfluenceCodeBlockRenderer) RegisterFuncs ¶
func (r *ConfluenceCodeBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceFencedCodeBlockRenderer ¶
type ConfluenceFencedCodeBlockRenderer struct {
html.Config
Stdlib *stdlib.Lib
MermaidProvider string
MermaidScale float64
Attachments attachment.Attacher
}
func (*ConfluenceFencedCodeBlockRenderer) RegisterFuncs ¶
func (r *ConfluenceFencedCodeBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceHTMLBlockRenderer ¶
func (*ConfluenceHTMLBlockRenderer) RegisterFuncs ¶
func (r *ConfluenceHTMLBlockRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceHeadingRenderer ¶
func (*ConfluenceHeadingRenderer) RegisterFuncs ¶
func (r *ConfluenceHeadingRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceImageRenderer ¶
type ConfluenceImageRenderer struct {
html.Config
Stdlib *stdlib.Lib
Path string
Attachments attachment.Attacher
}
func (*ConfluenceImageRenderer) RegisterFuncs ¶
func (r *ConfluenceImageRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceLinkRenderer ¶
func (*ConfluenceLinkRenderer) RegisterFuncs ¶
func (r *ConfluenceLinkRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceParagraphRenderer ¶
func (*ConfluenceParagraphRenderer) RegisterFuncs ¶
func (r *ConfluenceParagraphRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
type ConfluenceTextRenderer ¶
ConfluenceTextRenderer slightly alters the default goldmark behavior for inline text block. It allows for soft breaks (c.f. https://spec.commonmark.org/0.30/#softbreak) to be rendered into HTML as either '\n' (the goldmark default) or as ' '. This latter option is useful for Confluence, which inserts <br> tags into uploaded HTML where it sees '\n'. See also https://sembr.org/ for partial motivation.
func (*ConfluenceTextRenderer) RegisterFuncs ¶
func (r *ConfluenceTextRenderer) RegisterFuncs(reg renderer.NodeRendererFuncRegisterer)
RegisterFuncs implements NodeRenderer.RegisterFuncs .
Source Files