generator

Documentation

Index

• type Generator
  • func New(rootFolder string, force bool, gs ...Option) Generator
  • func (g *Generator) ClearOutput()
  • func (g *Generator) Execute() error
  • func (g *Generator) GenConfig() config.Generate
  • func (g *Generator) IsRefreshed() bool
  • func (g *Generator) RenderHTML(layoutName string, pg model.Page) error
  • func (g *Generator) SiteConfig() config.Site
• type Option
  • func WithAutoreload(b bool) Option

Types

type Generator

type Generator struct {
	// contains filtered or unexported fields
}

Generator this the main generator engine

func New

func New(rootFolder string, force bool, gs ...Option) Generator

New creates a new initialised generator

func (*Generator) ClearOutput

func (g *Generator) ClearOutput()

ClearOutput clean the output folder

func (*Generator) Execute

func (g *Generator) Execute() error

Execute walk thru the folders and register section/pages. After that processing each file.

func (*Generator) GenConfig

func (g *Generator) GenConfig() config.Generate

GenConfig return the configuration of the generator

func (*Generator) IsRefreshed

func (g *Generator) IsRefreshed() bool

func (*Generator) RenderHTML

func (g *Generator) RenderHTML(layoutName string, pg model.Page) error

func (*Generator) SiteConfig

func (g *Generator) SiteConfig() config.Site

SiteConfig return the configuration of the site

type Option

type Option func(*Generator)

Option func to set a generator option

func WithAutoreload

func WithAutoreload(b bool) Option

WithAutoreload adapt autorelaod