cmd

Documentation

Index

• func Run() error
• type CommandOptions
• type SiteData

Functions

func Run

func Run() error

Run is the main entrypoint for the binary. It takes various options and then works through the process

Types

type CommandOptions

type CommandOptions struct {
	ConfigFile                   string `json:"config" yaml:"config"` // if this is provided, it is set first THEN the rest will be used
	D2Theme                      int64  `json:"d2_theme" yaml:"d2_theme"`
	D2Layout                     string `json:"d2_layout" yaml:"d2_layout"`
	InputDirectory               string `json:"input_directory" yaml:"input_directory"`
	OutputDirectory              string `json:"output_directory" yaml:"output_directory"`
	PageTemplateFile             string `json:"page_template" yaml:"page_template"`
	DiagramIndexPageTemplateFile string `json:"index_template" yaml:"index_template"`
	TagPageTemplateFile          string `json:"tag_template" yaml:"tag_template"`
	CleanOutputDirectoryFirst    bool   `json:"clean" yaml:"clean"`
	ContinueOnCompileErrors      bool   `json:"continue_errors" yaml:"continue_errors"`

	// the below are needed post-processing
	PageTemplate             *template.Template
	DiagramIndexPageTemplate *template.Template
	TagPageTemplate          *template.Template
}

CommandOptions holds all of the options to pass in to the processors

type SiteData

type SiteData struct {
	Title       string
	Content     template.HTML
	Links       []d2s.LeafData
	Tags        []string
	SiteTags    map[string][]d2s.LeafData
	AllDiagrams map[string]*d2s.LeafData
}

SiteData is the main store of the site data