render

Documentation

Overview

Render html according to html templates

Index

• type Meta
  • func (m *Meta) RenderAll() error
• type RenderData
  • func (rd *RenderData) Render(t *template.Template, isDry bool) error
  • func (rd *RenderData) RenderTags(t *template.Template, isDry bool) error

Types

type Meta

type Meta struct {
	C         *config.Config
	Templates *template.Template
	D         map[string]entry.Entry
	Skip      map[string]bool
	L         map[string][]listing.Listing
	InDir     string
	OutDir    string
	Files     []string
	T         []tag.Tag
	M         parse.Metadata
	IsDry     bool
}

func (*Meta) RenderAll

func (m *Meta) RenderAll() error

Render all files, including tags page, to html.

type RenderData

type RenderData struct {
	Body                                     template.HTML
	Head                                     template.HTML
	Title                                    string
	Description                              string
	Layout                                   string
	RootCrumb                                string
	Filename                                 string
	Date                                     string
	DateUpdated                              string
	MachineDate                              string
	MachineDateUpdated                       string
	Ext                                      string
	OutFilename                              string
	Tags                                     []string
	TagsListing                              []tag.Tag
	Footer                                   []config.FooterLink
	Backlinks, Relatedlinks, Crumbs, Listing []listing.Listing
	TOC                                      bool
	ShowHeader                               bool
}

All fields used in the html templates.

* Title: page title (set in title tags and in document)

* Description: body description

* Filename: has no extension. Used for navigation crumb.

func (*RenderData) Render

func (rd *RenderData) Render(t *template.Template, isDry bool) error

Template html with data d.

func (*RenderData) RenderTags

func (rd *RenderData) RenderTags(t *template.Template, isDry bool) error

Template tags page