html5

Documentation

Index

• func Render(ctx *renderer.Context, output io.Writer) (map[string]interface{}, error)
• type ContextualPipeline
• type TableOfContents
• type TableOfContentsSection
• type TableOfContentsSectionGroup

Functions

func Render

func Render(ctx *renderer.Context, output io.Writer) (map[string]interface{}, error)

Render renders the given document in HTML and writes the result in the given `writer`

Types

type ContextualPipeline

type ContextualPipeline struct {
	Context *renderer.Context
	// The actual pipeline
	Data interface{}
}

ContextualPipeline as structure that carries the renderer context along with the pipeline data to process in a template or in a nested template

type TableOfContents

type TableOfContents struct {
	Content template.HTML
}

TableOfContents the structure of the table of contents

type TableOfContentsSection

type TableOfContentsSection struct {
	Level       int
	Href        string
	Title       template.HTML
	Subelements template.HTML
}

TableOfContentsSection a section in the table of contents

type TableOfContentsSectionGroup

type TableOfContentsSectionGroup struct {
	Level    int
	Elements []TableOfContentsSection
}

TableOfContentsSectionGroup a group of sections in the table of contents