rendering

Documentation

Index

• Variables
• func ExecutePlan(plan RenderPlan) error
• func SvgToPng(ctx context.Context, svg []byte, customFontPath *string) ([]byte, error)
• type Font
  • func ListFonts(customFontPath *string) ([]Font, error)
• type PlanMode
• type PlannedRender
• type RenderPlan
  • func PlanRender(configPath, statePath string, mode PlanMode) (RenderPlan, error)

Variables

var PlanModes = map[string]PlanMode{
	"all":     PlanModeAll,
	"missing": PlanModeMissing,
	"changed": PlanModeChanged,
}

Functions

func ExecutePlan

func ExecutePlan(plan RenderPlan) error

func SvgToPng

func SvgToPng(ctx context.Context, svg []byte, customFontPath *string) ([]byte, error)

Types

type Font

type Font struct {
	Name      string
	Embedded  bool
	FS        fs.FS
	License   string
	Copyright string
	Variants  []string
	Paths     []string
}

func ListFonts

func ListFonts(customFontPath *string) ([]Font, error)

type PlanMode

type PlanMode int

const (
	PlanModeAll PlanMode = iota
	PlanModeMissing
	PlanModeChanged
)

type PlannedRender

type PlannedRender struct {
	Template templating.TemplateDefinition
	Cover    templating.Cover
}

type RenderPlan

type RenderPlan struct {
	ConfigPath string
	StatePath  string

	Config templating.Config
	State  templating.StateFile

	PlannedRenders []PlannedRender

	ProgressBar *pterm.ProgressbarPrinter
}

func PlanRender

func PlanRender(configPath, statePath string, mode PlanMode) (RenderPlan, error)