hooks

package
v0.125.7 Latest Latest
Warning

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

Go to latest
Published: May 8, 2024 License: Apache-2.0 Imports: 6 Imported by: 14

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttributesOptionsSliceProvider added in v0.93.0

type AttributesOptionsSliceProvider interface {
	AttributesSlice() []attributes.Attribute
	OptionsSlice() []attributes.Attribute
}

type AttributesProvider added in v0.82.0

type AttributesProvider interface {
	// Attributes passed in from Markdown (e.g. { attrName1=attrValue1 attrName2="attr Value 2" }).
	Attributes() map[string]any
}

type CodeBlockRenderer added in v0.93.0

type CodeBlockRenderer interface {
	RenderCodeblock(cctx context.Context, w hugio.FlexiWriter, ctx CodeblockContext) error
}

type CodeblockContext added in v0.93.0

type CodeblockContext interface {
	AttributesProvider
	text.Positioner
	PageProvider

	// Chroma highlighting processing options. This will only be filled if Type is a known Chroma Lexer.
	Options() map[string]any

	// The type of code block. This will be the programming language, e.g. bash, when doing code highlighting.
	Type() string

	// The text between the code fences.
	Inner() string

	// Zero-based ordinal for all code blocks in the current document.
	Ordinal() int
}

CodeblockContext is the context passed to a code block render hook.

type ElementPositionResolver added in v0.93.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.93.0

type GetRendererFunc func(t RendererType, id any) any

type HeadingContext added in v0.71.0

type HeadingContext interface {
	PageProvider
	// 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 added in v0.71.0

type HeadingRenderer interface {
	// RenderHeading writes the rendered content to w using the data in w.
	RenderHeading(cctx context.Context, w io.Writer, ctx HeadingContext) error
}

HeadingRenderer describes a uniquely identifiable rendering hook.

type ImageLinkContext added in v0.108.0

type ImageLinkContext interface {
	LinkContext

	// Returns true if this is a standalone image and the config option
	// markup.goldmark.parser.wrapStandAloneImageWithinParagraph is disabled.
	IsBlock() bool

	// Zero-based ordinal for all the images in the current document.
	Ordinal() int
}

ImageLinkContext is the context passed to a image link render hook.

type IsDefaultCodeBlockRendererProvider added in v0.93.0

type IsDefaultCodeBlockRendererProvider interface {
	IsDefaultCodeBlockRenderer() bool
}

type LinkContext

type LinkContext interface {
	PageProvider

	// The link URL.
	Destination() string

	// The link title attribute.
	Title() string

	// The rendered (HTML) text.
	Text() hstring.RenderedString

	// The plain variant of Text.
	PlainText() string
}

LinkContext is the context passed to a link render hook.

type LinkRenderer

type LinkRenderer interface {
	RenderLink(cctx context.Context, w io.Writer, ctx LinkContext) error
}

type PageProvider added in v0.125.0

type PageProvider interface {
	// Page is the page being rendered.
	Page() any

	// PageInner may be different than Page when .RenderShortcodes is in play.
	// The main use case for this is to include other pages' markdown into the current page
	// but resolve resources and pages relative to the original.
	PageInner() any
}

type RendererType added in v0.93.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