markdown

Documentation

Index

• Variables
• type Attribute
• type AttributesOptionsSliceProvider
• type AttributesProvider
• type CodeBlockRenderer
• type CodeblockContext
• type ContextData
• type DocumentContext
• type ElementPositionResolver
• type GetRendererFunc
• type HeadingContext
• type HeadingRenderer
• type HighlightResult
• type Highlighter
• type IsDefaultCodeBlockRendererProvider
• type LinkContext
• type LinkRenderer
• type Markdown
• type RenderContext
• type RenderResult
• type RendererType
• type Result
• type ResultParse
• type TableOfContentsProvider
• type TocFragments

Variables

var DefaultRendererFunc = func(t RendererType, id any) any { return nil }

Types

type Attribute

type Attribute interface {
	Name() string
	Value() any
	ValueString() string
}

type AttributesOptionsSliceProvider

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

type AttributesProvider

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

type CodeBlockRenderer

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

type CodeblockContext

type CodeblockContext interface {
	AttributesProvider
	text.Positioner

	// 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

	// The owning Page.
	Page() any
}

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

type ContextData

type ContextData interface {
	RenderContext() RenderContext
	DocumentContext() DocumentContext
}

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 ElementPositionResolver

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

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 {
	// 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 HighlightResult

type HighlightResult interface {
	Wrapped() template.HTML
	Inner() template.HTML
}

type Highlighter

type Highlighter interface {
	Highlight(code, lang string, opts any) (string, error)
	HighlightCodeBlock(ctx CodeblockContext, opts any) (HighlightResult, error)
	CodeBlockRenderer
	IsDefaultCodeBlockRendererProvider
}

type IsDefaultCodeBlockRendererProvider

type IsDefaultCodeBlockRendererProvider interface {
	IsDefaultCodeBlockRenderer() bool
}

type LinkContext

type LinkContext interface {
	// The Page being rendered.
	Page() any

	// 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 Markdown

type Markdown interface {
	Render(rctx RenderContext, dctx DocumentContext) (Result, error)

	Highlighter
}

type RenderContext

type RenderContext struct {
	// Ctx is the context.Context for the current Page render.
	Ctx context.Context

	// Src is the content to render.
	Src []byte

	// Whether to render TableOfContents.
	RenderTOC bool

	// GerRenderer provides hook renderers on demand.
	GetRenderer GetRendererFunc
}

RenderContext holds contextual information about the content to render.

type RenderResult

type RenderResult interface {
	Bytes() []byte
}

type RendererType

type RendererType int

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

type Result

type Result interface {
	RenderResult
	TableOfContentsProvider
}

Result represents the minimum returned from Convert.

type ResultParse

type ResultParse interface {
	Doc() any
	TableOfContentsProvider
}

ResultParse represents the minimum returned from Parse.

type TableOfContentsProvider

type TableOfContentsProvider interface {
	TableOfContents() TocFragments
}

type TocFragments

type TocFragments interface {
	ToHTML(startLevel, stopLevel int, ordered bool) template.HTML
}