Documentation ¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type AttributesOptionsSliceProvider ¶ added in v0.16.0
type AttributesOptionsSliceProvider interface { AttributesSlice() []attributes.Attribute OptionsSlice() []attributes.Attribute }
type AttributesProvider ¶ added in v0.8.0
type AttributesProvider interface {
Attributes() map[string]interface{}
}
type CodeBlockRenderer ¶ added in v0.16.0
type CodeBlockRenderer interface { RenderCodeblock(w hugio.FlexiWriter, ctx CodeblockContext) error identity.Provider }
type CodeblockContext ¶ added in v0.16.0
type CodeblockContext interface { AttributesProvider text.Positioner Options() map[string]interface{} Type() string Inner() string Ordinal() int Page() interface{} }
type ElementPositionResolver ¶ added in v0.16.0
ElementPositionResolver provides a way to resolve the start Position of a markdown element in the original source document. This may be both slow and aproximate, so should only be used for error logging.
type GetRendererFunc ¶ added in v0.16.0
type GetRendererFunc func(t RendererType, id interface{}) interface{}
type HeadingContext ¶
type HeadingContext interface { // Page is the page containing the heading. Page() interface{} // Level is the level of the header (i.e. 1 for top-level, 2 for sub-level, etc.). Level() int // Anchor is the HTML id assigned to the heading. Anchor() string // Text is the rendered (HTML) heading text, excluding the heading marker. Text() hstring.RenderedString // PlainText is the unrendered version of Text. PlainText() string // Attributes (e.g. CSS classes) AttributesProvider }
HeadingContext contains accessors to all attributes that a HeadingRenderer can use to render a heading.
type HeadingRenderer ¶
type HeadingRenderer interface { // Render writes the rendered content to w using the data in w. RenderHeading(w io.Writer, ctx HeadingContext) error identity.Provider }
HeadingRenderer describes a uniquely identifiable rendering hook.
type IsDefaultCodeBlockRendererProvider ¶ added in v0.16.0
type IsDefaultCodeBlockRendererProvider interface {
IsDefaultCodeBlockRenderer() bool
}
type LinkContext ¶
type LinkContext interface { Page() interface{} Destination() string Title() string Text() hstring.RenderedString PlainText() string }
type LinkRenderer ¶
type RendererType ¶ added in v0.16.0
type RendererType int
const ( LinkRendererType RendererType = iota + 1 ImageRendererType HeadingRendererType CodeBlockRendererType )
Click to show internal directories.
Click to hide internal directories.