package hooks
import "github.com/gohugoio/hugo/markup/converter/hooks"
Index ¶
- type AttributesOptionsSliceProvider
- type AttributesProvider
- type CodeBlockRenderer
- type CodeblockContext
- type ElementPositionResolver
- type GetRendererFunc
- type HeadingContext
- type HeadingRenderer
- type IsDefaultCodeBlockRendererProvider
- type LinkContext
- type LinkRenderer
- type RendererType
Types ¶
type AttributesOptionsSliceProvider ¶
type AttributesOptionsSliceProvider interface { AttributesSlice() []attributes.Attribute OptionsSlice() []attributes.Attribute }
type AttributesProvider ¶
type CodeBlockRenderer ¶
type CodeBlockRenderer interface { RenderCodeblock(w hugio.FlexiWriter, ctx CodeblockContext) error identity.Provider }
type CodeblockContext ¶
type CodeblockContext interface { AttributesProvider text.Positioner Options() map[string]any Type() string Inner() string Ordinal() int Page() any }
type ElementPositionResolver ¶
ElementPositionResolver provides a way to resolve the start Position of a markdown element in the original source document. This may be both slow and approximate, so should only be used for error logging.
type GetRendererFunc ¶
type GetRendererFunc func(t RendererType, id any) any
type HeadingContext ¶
type HeadingContext interface { // Page is the page containing the heading. Page() any // 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 ¶
type IsDefaultCodeBlockRendererProvider interface { IsDefaultCodeBlockRenderer() bool }
type LinkContext ¶
type LinkContext interface { Page() any Destination() string Title() string Text() hstring.RenderedString PlainText() string }
type LinkRenderer ¶
type RendererType ¶
type RendererType int
const ( LinkRendererType RendererType = iota + 1 ImageRendererType HeadingRendererType CodeBlockRendererType )
Source Files ¶
- Version
- v0.101.0
- Published
- Jun 16, 2022
- Platform
- linux/amd64
- Imports
- 6 packages
- Last checked
- 1 minute ago –
Tools for package owners.