config

Documentation

Index

• type Banner
• type Branding
• type Config
  • func DefaultConfig() Config
  • func Load(rootDir string) (Config, error)
  • func (c Config) Save(rootDir string) error
• type Footer
• type FooterColumn
• type FooterLink
• type FooterSocial
• type LLMsConfig
• type NavItem
• type SectionPaths

Types

type Banner

type Banner struct {
	Message     string `yaml:"message"`
	Color       string `yaml:"color"`
	Dismissible bool   `yaml:"dismissible"`
}

type Branding

type Branding struct {
	LogoLight string `yaml:"logo_light"`
	LogoDark  string `yaml:"logo_dark"`
	LogoAlt   string `yaml:"logo_alt"`
	LogoLink  string `yaml:"logo_link"`
	Favicon   string `yaml:"favicon"`
}

type Config

type Config struct {
	Title       string       `yaml:"title"`
	Description string       `yaml:"description"`
	URL         string       `yaml:"url"`
	Language    string       `yaml:"language"`
	Theme       string       `yaml:"theme"`
	Redirect    string       `yaml:"redirect,omitempty"`
	Branding    Branding     `yaml:"branding"`
	Footer      Footer       `yaml:"footer"`
	Navigation  []NavItem    `yaml:"navigation"`
	Sections    SectionPaths `yaml:"sections"`
	Banner      Banner       `yaml:"banner,omitempty"`
	EditBaseURL string       `yaml:"edit_base_url,omitempty"`
	LLMs        LLMsConfig   `yaml:"llms,omitempty"`
}

func DefaultConfig

func DefaultConfig() Config

func Load

func Load(rootDir string) (Config, error)

func (Config) Save

func (c Config) Save(rootDir string) error

type Footer

type Footer struct {
	Copyright string         `yaml:"copyright"`
	Position  string         `yaml:"position"`
	Columns   []FooterColumn `yaml:"columns"`
	Social    []FooterSocial `yaml:"social"`
}

type FooterColumn

type FooterColumn struct {
	Title string       `yaml:"title"`
	Links []FooterLink `yaml:"links"`
}

type FooterLink

type FooterLink struct {
	Label string `yaml:"label"`
	Href  string `yaml:"href"`
}

type FooterSocial

type FooterSocial struct {
	Icon  string `yaml:"icon"`
	Href  string `yaml:"href"`
	Label string `yaml:"label"`
}

type LLMsConfig

type LLMsConfig struct {
	LLMsTxt     bool `yaml:"llms_txt"`
	LLMsTxtFull bool `yaml:"llms_txt_full"`
}

type NavItem

type NavItem struct {
	Label string `yaml:"label"`
	Path  string `yaml:"path"`
}

type SectionPaths

type SectionPaths struct {
	Docs      string `yaml:"docs"`
	Guides    string `yaml:"guides"`
	Tutorials string `yaml:"tutorials"`
}