hooks

package
Version: v0.88.1 Latest Latest
Warning

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

Go to latest
Published: Sep 4, 2021 License: Apache-2.0 Imports: 4 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type AttributesProvider added in v0.82.0

type AttributesProvider interface {
	Attributes() map[string]string
}

type HeadingContext added in v0.71.0

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() string
	// 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 {
	// 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 LinkContext

type LinkContext interface {
	Page() interface{}
	Destination() string
	Title() string
	Text() string
	PlainText() string
}

type LinkRenderer

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

type Renderers added in v0.71.0

type Renderers struct {
	LinkRenderer    LinkRenderer
	ImageRenderer   LinkRenderer
	HeadingRenderer HeadingRenderer
}

func (Renderers) Eq added in v0.71.0

func (r Renderers) Eq(other interface{}) bool

func (Renderers) IsZero added in v0.82.0

func (r Renderers) IsZero() bool

func (Renderers) String added in v0.82.0

func (r Renderers) String() string

Source Files

Jump to

Keyboard shortcuts

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