temingo

Documentation

Index

• func ProjectTypes() []string
• type Engine
  • func DefaultEngine() Engine
  • func (engine *Engine) InitProject(projectType string) error
  • func (engine *Engine) Render() error

Functions

func ProjectTypes

func ProjectTypes() []string

Returns the available ProjectTypes for the Init() function

Types

type Engine

type Engine struct {
	InputDir                string
	OutputDir               string
	TemingoignorePath       string
	TemplateExtension       string
	MetaTemplateExtension   string
	PartialExtension        string
	MetaFilename            string
	MarkdownContentFilename string
	Verbose                 bool
	DryRun                  bool
	Beautify                bool
	Minify                  bool
}

func DefaultEngine

func DefaultEngine() Engine

Returns an engine with default values

func (*Engine) InitProject

func (engine *Engine) InitProject(projectType string) error

Initializes the current directory with an example project It checks beforehand if the files / folders that will be written already exist and not do a thing if they do.

func (*Engine) Render

func (engine *Engine) Render() error

Renders the templates in the inputDir, writes them to the outputDir and copies the static files