render

Documentation

Overview

Render html according to html templates

Index

• type RenderData
  • func (rd *RenderData) Render(t *template.Template, dryRun bool, templateName string) error
• type RenderDeps
  • func (d *RenderDeps) RenderAll() error

Types

type RenderData

type RenderData struct {
	Body                                     template.HTML
	Head                                     template.HTML
	WikiTitle                                string
	Url                                      string
	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, dryRun bool, templateName string) error

Template html with data d.

type RenderDeps

type RenderDeps struct {
	Config    *config.Config
	Templates *template.Template
	Entries   map[string]entry.Entry
	Skip      map[string]bool
	Listings  map[string][]listing.Listing
	InDir     string
	OutDir    string
	Files     []string
	Tags      []tag.Tag
	Metadata  parse.Metadata
	DryRun    bool
}

func (*RenderDeps) RenderAll

func (d *RenderDeps) RenderAll() error

Render all files, including tags page, to html.