processor

Documentation

Index

• type Processor
• type Response

Types

type Processor

type Processor interface {
	// Name Getting the name of the processor
	Name() string

	// CanRenderPage this should be a quick check, if the processor can determine, if the page should be rendered.
	// If not the page will not be added to the render pages
	CanRenderPage(pg model.Page) bool

	// AddPage this method will be called if a new page will be added to a secrion of this processor
	AddPage(folder, pagefile string) (objx.Map, error)

	// GetPageTemplate getting the page template for a page with that name
	GetPageTemplate(name string) string

	// CreateBody creates a body that should be saved to the output folder.
	// if the body part is empty, nothing is to do for this source file.
	CreateBody(content []byte, pg model.Page) (*Response, error)

	// HTMLTemplateName returnin the html template used for this processor
	HTMLTemplateName() string
}

Processor this is the interface for a processor

type Response

type Response struct {
	Render bool
	Body   string
	Script string
	Style  string
}

Response contains scripts, styles and the body