hooks

Documentation

Index

• type AttributesProvider
• type HeadingContext
• type HeadingRenderer
• type LinkContext
• type LinkRenderer
• type Renderers
  • func (r Renderers) Eq(other interface{}) bool
  • func (r Renderers) IsZero() bool
  • func (r Renderers) String() string

Types

type AttributesProvider

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

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() 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

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

type Renderers struct {
	LinkRenderer    LinkRenderer
	ImageRenderer   LinkRenderer
	HeadingRenderer HeadingRenderer
}

func (Renderers) Eq

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

func (Renderers) IsZero

func (r Renderers) IsZero() bool

func (Renderers) String

func (r Renderers) String() string