sitebuilder

type BasicPageMarkdown struct {
	Page Page `yaml:"page"`
}

type BasicPageTemplate struct {
	Meta    TemplateMetadata
	Content template.HTML
}

type CommonPageData struct {
	SiteName         string `validate:"required"`
	SiteDescription  string `validate:"required"`
	BaseURL          string `validate:"required,url"`
	GitHubIssuesLink string `validate:"required,url"`
	// contains filtered or unexported fields
}

type ContentPaths struct {
	IndexPage   string
	ProjectDirs []string
	BasicPages  []string
}

type GoPackage struct {
	RootName  string `yaml:"rootName"  validate:"required"`
	GitHubURL string `yaml:"githubURL" validate:"required,url"`
}

type IconMap map[string]*struct {
	Icon                  string `validate:"required,filepath"`
	Link                  string `validate:"omitempty,url"`
	IndexPageFallbackIcon string `validate:"omitempty,filepath"`
}

type Image struct {
	Path   string `yaml:"path"   validate:"required,filepath"`
	Alt    string `yaml:"alt"    validate:"required"`
	Width  int    `yaml:"width"  validate:"required"`
	Height int    `yaml:"height" validate:"required"`
}

type IndexPageBase struct {
	ProfilePictureMobile  Image `yaml:"profilePictureMobile"`
	ProfilePictureDesktop Image `yaml:"profilePictureDesktop"`
}

type IndexPageMarkdown struct {
	IndexPageBase `                       yaml:",inline"`
	Page          Page                   `yaml:"page"`
	PersonalInfo  PersonalInfoMarkdown   `yaml:"personalInfo"`
	ProjectGroups []ProjectGroupMarkdown `yaml:"projectGroups,flow" validate:"required,dive"`
}

type IndexPageTemplate struct {
	IndexPageBase
	Meta          TemplateMetadata
	AboutMe       template.HTML
	PersonalInfo  []LinkItem // May omit Link field.
	ProjectGroups []ProjectGroupTemplate
}

type LinkGroup struct {
	Title string `yaml:"title"`
	// May omit Icon field.
	Links []LinkItem `yaml:"links,flow"`
}

type LinkItem struct {
	Text string        `yaml:"text" validate:"required"`
	Link string        `yaml:"link" validate:"omitempty,url"`
	Icon template.HTML `yaml:"icon" validate:"omitempty,filepath"`
}

type MarkdownRenderer struct {
	html.Config
}

type Page struct {
	Title        string `yaml:"title"        validate:"required"`
	Path         string `yaml:"path"`
	TemplateName string `yaml:"templateName" validate:"required,filepath"`
	RedirectURL  string `yaml:"redirectURL"` // Optional.

	// Nil if page does not host a Go package.
	GoPackage *GoPackage `yaml:"goPackage" validate:"omitempty"`
}

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

type ParsedProject struct {
	ProjectTemplate
	Page       Page
	ContentDir string
}

type ParsedProjectGroup struct {
	ProjectGroupTemplate
	// contains filtered or unexported fields
}

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

type PersonalInfoMarkdown struct {
	Birthday    string `yaml:"birthday"    validate:"required"`
	Location    string `yaml:"location"    validate:"required"`
	GitHubURL   string `yaml:"githubURL"   validate:"required,url"`
	LinkedInURL string `yaml:"linkedinURL" validate:"required,url"`
}

type ProjectBase struct {
	ProjectProfile `yaml:",inline"`
	// Optional, defaults to DefaultTechStackTitle when TechStack is not empty.
	TechStackTitle string        `yaml:"techStackTitle"`
	LinkGroups     []LinkGroup   `yaml:"linkGroups,flow"` // Optional.
	Footnote       template.HTML `yaml:"footnote"`        // Optional.
}

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

type ProjectGroupMarkdown struct {
	Title        string   `yaml:"title"             validate:"required"`
	ProjectSlugs []string `yaml:"projectSlugs,flow" validate:"required,dive"`
	ContentDir   string   `yaml:"contentDir"        validate:"required"`
}

type ProjectGroupTemplate struct {
	Title    string
	Projects []ProjectProfile
}

type ProjectMarkdown struct {
	ProjectBase `                        yaml:",inline"`
	TechStack   []TechStackItemMarkdown `yaml:"techStack,flow"` // Optional.
	// Optional if project page only needs Title, Path and TemplateName (these are set
	// automatically). Other fields can be set here, e.g. if project page should host a Go package.
	Page Page `yaml:"page"`
}

type ProjectPageTemplate struct {
	Meta    TemplateMetadata
	Project ProjectTemplate
}

type ProjectProfile struct {
	Name    string `yaml:"name"     validate:"required"`
	Slug    string `yaml:"slug"     validate:"required"`
	TagLine string `yaml:"tagLine"  validate:"required"`
	// Optional if not included in index page.
	LogoPath              string `yaml:"logoPath" validate:"omitempty,filepath"`
	LogoAlt               string `yaml:"logoAlt"`
	IndexPageFallbackIcon template.HTML
}

type ProjectTemplate struct {
	ProjectBase
	Description template.HTML
	TechStack   []TechStackItemTemplate
}

type TechStackItemMarkdown struct {
	Tech     string   `yaml:"tech"          validate:"required"`
	UsedFor  string   `yaml:"usedFor"`       // Optional.
	UsedWith []string `yaml:"usedWith,flow"` // Optional.
}

type TechStackItemTemplate struct {
	LinkItem
	UsedFor  string
	UsedWith []LinkItem
}

type TemplateMetadata struct {
	Common CommonPageData
	Page   Page
}