contentspec

Documentation

Index

• type Converter
• type ConverterRegistry
• type DocumentContext
• type Provider
• type ProviderProvider
• type RenderContext
• type Result

Types

type Converter

type Converter interface {
	Convert(ctx RenderContext) (Result, error)
}

Converter wraps the Convert method that converts some markup into another format, e.g. Markdown to HTML.

type ConverterRegistry

type ConverterRegistry interface {
	Get(name string) Provider
}

type DocumentContext

type DocumentContext struct {
	Document     any // May be nil. Usually a page.Page
	DocumentID   string
	DocumentName string
	Filename     string
}

DocumentContext holds contextual information about the document to convert.

type Provider

type Provider interface {
	New(ctx DocumentContext) (Converter, error)
	Name() string
}

Provider creates converters.

type ProviderProvider

type ProviderProvider interface {
	New() (Provider, error)
}

ProviderProvider creates converter providers.

type RenderContext

type RenderContext struct {
	// Src is the content to render.
	Src []byte

	// Whether to render TableOfContents.
	RenderTOC bool
}

RenderContext holds contextual information about the content to render.

type Result

type Result interface {
	Bytes() []byte
}

Result represents the minimum returned from Convert.