hooks

package
v0.21.0 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 2, 2022 License: Apache-2.0 Imports: 6 Imported by: 0

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]any
}

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]any
	Type() string
	Inner() string
	Ordinal() int
	Page() any
}

type ElementPositionResolver added in v0.16.0

type ElementPositionResolver interface {
	ResolvePosition(ctx any) text.Position
}

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 added in v0.16.0

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 added in v0.16.0

type IsDefaultCodeBlockRendererProvider interface {
	IsDefaultCodeBlockRenderer() bool
}

type LinkContext

type LinkContext interface {
	Page() any
	Destination() string
	Title() string
	Text() hstring.RenderedString
	PlainText() string
}

type LinkRenderer

type LinkRenderer interface {
	RenderLink(w io.Writer, ctx LinkContext) error
	identity.Provider
}

type RendererType added in v0.16.0

type RendererType int
const (
	LinkRendererType RendererType = iota + 1
	ImageRendererType
	HeadingRendererType
	CodeBlockRendererType
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL