config

Documentation

Index

• type Config
  • func DefaultConfig() Config
  • func Read(f string) (*Config, error)
• type FooterLink

Types

type Config

type Config struct {
	Title         string       `yaml:"title"`
	Description   string       `yaml:"description"`
	Url           string       `yaml:"url"`
	AuthorName    string       `yaml:"authorName"`
	AuthorEmail   string       `yaml:"authorEmail"`
	RootCrumb     string       `yaml:"rootCrumb"`
	Head          string       `yaml:"head"`
	Footer        []FooterLink `yaml:"footer"`
	CodeHighlight bool         `yaml:"codeHighlight"`
	IsExt         bool         `yaml:"keepExtension"`
}

func DefaultConfig

func DefaultConfig() Config

func Read

func Read(f string) (*Config, error)

type FooterLink

type FooterLink struct {
	Href string `yaml:"href"`
	Text string `yaml:"text"`
}