config

package

Go to main page

Versions in this module

v1

v1.4.0

Aug 29, 2026

Changes in this version

+ type ValidationError struct

+ Errors []validate.Error

+ func (e *ValidationError) Error() string

v1.3.0

Aug 6, 2026

v1.2.0

Aug 4, 2026

Changes in this version

+ type AsidesSettings struct

+ Style string

type HeroCTA

+ Icon string

type MarkdownSettings

+ Asides AsidesSettings

v1.1.0

Jul 29, 2026

Changes in this version

+ func NormalizeDateFormat(raw string) string

type ContentLintRules

+ TabsMarkerSyntax *bool

type Logo

+ ReplacesTitle *bool

type MarkdownSettings

+ HardWraps *bool

type ThemeSettings

+ DateFormat string

v1.0.1

Jul 25, 2026

v1.0.0

Jul 24, 2026

Changes in this version

+ func IntPtr(v int) *int

+ func IntVal(p *int, fallback int) int

+ type CollectionLabsConfig struct

+ Label string

type CollectionSidebarConfig

+ CollapseLevel *int

type CollectionSiteConfig

+ Labs *CollectionLabsConfig

type PluginSettings

+ Disabled []string

+ type SidebarCollectionEntry struct

+ CollapseLevel *int

+ Items []SidebarItemEntry

+ Overrides map[string]*SidebarNodeOverride

+ Tabs map[string]*SidebarTabOverride

+ type SidebarFile map[string]*SidebarCollectionEntry

+ func LoadSidebarFile(dir string) (SidebarFile, error)

+ type SidebarItemEntry struct

+ Attrs map[string]string

+ Autogenerate string

+ Badge engine.Badge

+ Collapsed *bool

+ External bool

+ Items []SidebarItemEntry

+ Label string

+ Page string

+ URL string

+ type SidebarNodeOverride struct

+ Attrs map[string]string

+ Badge engine.Badge

+ Collapsed *bool

+ Description string

+ Hidden *bool

+ Icon string

+ Label string

+ Order *int

+ type SidebarTabOverride struct

+ Description string

+ Icon string

+ Label string

+ Order *int

type SiteConfig

+ SidebarFile SidebarFile

type SiteIdentity

+ Author string

type TaxonomyConfig

+ ShowTags *bool

v0

v0.1.1

Jun 27, 2026

Changes in this version

+ func BoolPtr(v bool) *bool

+ func BoolVal(p *bool, fallback bool) bool

+ func NormalizeBasePath(raw string) string

+ func Validate(cfg *SiteConfig, knownPlugins []string) (errs []validate.Error, warns []validate.Error)

+ func ValidateVersioning(colName string, vc *VersioningConfig) error

+ type AnalyticsSettings struct

+ Provider string

+ Script string

+ SiteID string

+ type BuildSettings struct

+ BasePath string

+ Cache *bool

+ Clean *bool

+ Drafts *bool

+ Expired *bool

+ Feed *bool

+ Future *bool

+ LastUpdated LastUpdatedStrategy

+ Minify *bool

+ Output string

+ Parallel *bool

+ Sitemap *bool

+ type CodeblocksSettings struct

+ DarkModeSelector string

+ DarkTheme string

+ Engine string

+ LightTheme string

+ Style string

+ Theme string

+ type CollectionPrevNextConfig struct

+ Enabled *bool

+ Labels []string

+ type CollectionSidebarConfig struct

+ CollapsedByDefault *bool

+ Collapsible *bool

+ MaxDepth int

+ Search *bool

+ type CollectionSiteConfig struct

+ Enabled *bool

+ Feed *bool

+ I18nFallback string

+ Layout string

+ Paginate int

+ Path string

+ Permalink string

+ PrevNext *CollectionPrevNextConfig

+ Sidebar *CollectionSidebarConfig

+ Sort string

+ TOC *CollectionTOCConfig

+ Tabs *bool

+ URLPrefix string

+ Versioning *VersioningConfig

+ type CollectionTOCConfig struct

+ Depth int

+ Enabled *bool

+ ScrollHighlight *bool

+ type ContentLintRules struct

+ FrontmatterRequired []string

+ HeadingIncrement *bool

+ HeadingMaxLength int

+ ImageAltRequired *bool

+ NoEmptyLinks *bool

+ type ContentLintSettings struct

+ Enabled *bool

+ Rules ContentLintRules

+ type ContentSettings struct

+ Dir string

+ SummaryLength int

+ type DeployConfig struct

+ Branch string

+ Command string

+ ProjectID string

+ ProjectName string

+ Provider string

+ RedirectFormat string

+ SiteID string

+ type ExternalCheckSettings struct

+ Cache string

+ CacheTTL string

+ Check *bool

+ Concurrency int

+ Ignore []string

+ Method string

+ OnBroken string

+ Timeout string

+ type FooterSettings struct

+ Credits *bool

+ Links []NavLink

+ Text string

+ type HeadSettings struct

+ CustomCSS []string

+ CustomJS []string

+ Tags []HeadTag

+ type HeadTag struct

+ Attrs map[string]string

+ Content string

+ Tag string

+ type HeaderSettings struct

+ Links []NavLink

+ Search *bool

+ Social *bool

+ ThemeToggle *bool

+ type HeroCTA struct

+ Label string

+ URL string

+ type HeroCode struct

+ Body string

+ Language string

+ Title string

+ type HeroImageSettings struct

+ Alt string

+ Dark string

+ HTML string

+ Light string

+ Src string

+ type HeroSettings struct

+ Background string

+ CTA *HeroCTA

+ Code *HeroCode

+ Eyebrow string

+ Image *HeroImageSettings

+ SecondaryCTA *HeroCTA

+ Stats []HeroStat

+ Subtitle string

+ Title string

+ type HeroStat struct

+ Label string

+ Value string

+ type HomepageSettings struct

+ Hero HeroSettings

+ Template string

+ type I18nSettings struct

+ DefaultLanguage string

+ Fallback string

+ Languages map[string]LanguageConfig

+ Strategy string

+ Strict bool

+ func (s *I18nSettings) GetDefaultLanguage() string

+ func (s *I18nSettings) IsLanguageCode(seg string) bool

+ func (s *I18nSettings) IsMultiLang() bool

+ func (s *I18nSettings) Language(code string) (LanguageConfig, bool)

+ func (s *I18nSettings) LanguageCodes() []string

+ func (s *I18nSettings) ResolveLang(lang string) string

+ type IconSet struct

+ File string

+ Prefix string

+ type IconSettings struct

+ Attribution string

+ DefaultPrefix string

+ LocalDir string

+ Render string

+ Sets []IconSet

+ SetsDir string

+ type ImageSettings struct

+ Dimensions *bool

+ Formats []string

+ LazyLoading *bool

+ MaxWidth int

+ Placeholder string

+ Quality int

+ Widths []int

+ type LanguageConfig struct

+ Dir string

+ Name string

+ Title string

+ Weight int

+ type LastUpdatedStrategy string

+ func (l *LastUpdatedStrategy) UnmarshalYAML(value *yaml.Node) error

+ type LinkValidationSettings struct

+ CheckAnchors *bool

+ CheckImages *bool

+ Enabled *bool

+ Exclude []string

+ External ExternalCheckSettings

+ FailBuild *bool

+ Ignore []string

+ Level string

+ OnBroken string

+ OnBrokenAnchor string

+ OnLocalLinks string

+ OnRelativeLinks string

+ OnUnverifiedInternal string

+ Report string

+ SameSitePolicy string

+ SiteRootEscapePrefix string

+ func (s *LinkValidationSettings) EffectiveExternalOnBroken() string

+ func (s *LinkValidationSettings) EffectiveOnBroken() string

+ func (s *LinkValidationSettings) EffectiveOnBrokenAnchor() string

+ func (s *LinkValidationSettings) EffectiveOnLocalLinks() string

+ func (s *LinkValidationSettings) EffectiveOnRelativeLinks() string

+ func (s *LinkValidationSettings) EffectiveOnUnverifiedInternal() string

+ func (s *LinkValidationSettings) EffectiveReport() string

+ type LlmsTxtSettings struct

+ Enabled *bool

+ IncludeBlog *bool

+ type Logo struct

+ Alt string

+ Dark string

+ Light string

+ func (l *Logo) UnmarshalYAML(value *yaml.Node) error

+ type MarkdownSettings struct

+ CDN *bool

+ Codeblocks CodeblocksSettings

+ GithubAlerts *bool

+ KaTeX *bool

+ Mermaid *bool

+ TOC MarkdownTOCSettings

+ TripleColonCallouts *bool

+ Typographer *bool

+ Unsafe *bool

+ type MarkdownTOCSettings struct

+ MaxHeadingLevel int

+ MinHeadingLevel int

+ type NavLink struct

+ External bool

+ Label string

+ URL string

+ type PluginSettings struct

+ Config map[string]map[string]any

+ Enabled []string

+ type PrefetchSettings struct

+ Delay int

+ Enabled *bool

+ Strategy string

+ type ResolveOptions struct

+ CLIFlags map[string]any

+ ConfigPath string

+ EnvPrefix string

+ KnownPlugins []string

+ Strict bool

+ ThemeDir string

+ type SearchSettings struct

+ Enabled *bool

+ Provider string

+ type SecurityConfig struct

+ BlockedHrefSchemes []string

+ type ServerSettings struct

+ Host string

+ LiveReload *bool

+ Port int

+ type SidebarItem struct

+ Collapsed *bool

+ Items []SidebarItem

+ Label string

+ Link string

+ type SidebarSettings struct

+ AutoGenerate *bool

+ Badges *bool

+ Collapsed *bool

+ Items []SidebarItem

+ Pagination *bool

+ type SiteConfig struct

+ Analytics AnalyticsSettings

+ Build BuildSettings

+ Collections map[string]*CollectionSiteConfig

+ Content ContentSettings

+ ContentLint ContentLintSettings

+ Deploy DeployConfig

+ Footer FooterSettings

+ Head HeadSettings

+ Header HeaderSettings

+ Homepage HomepageSettings

+ I18n I18nSettings

+ Icons IconSettings

+ Images ImageSettings

+ LinkValidation LinkValidationSettings

+ LlmsTxt LlmsTxtSettings

+ Markdown MarkdownSettings

+ Permalinks map[string]string

+ Plugins PluginSettings

+ Prefetch PrefetchSettings

+ Redirects map[string]string

+ Search SearchSettings

+ Security SecurityConfig

+ Server ServerSettings

+ Sidebar SidebarSettings

+ Site SiteIdentity

+ Social []SocialLink

+ TOC TOCSettings

+ Taxonomies map[string]TaxonomyConfig

+ Theme ThemeSettings

+ func Defaults() *SiteConfig

+ func LoadFile(path string) (*SiteConfig, error)

+ func LoadFileStrict(path string) (*SiteConfig, error)

+ func Resolve(opts ResolveOptions) (*SiteConfig, error)

+ type SiteIdentity struct

+ Custom404 string

+ Description string

+ EditURL string

+ Favicon string

+ HeadingLinks *bool

+ Language string

+ Logo Logo

+ Title string

+ TitleDelimiter string

+ URL string

+ type SocialLink struct

+ Icon string

+ Label string

+ URL string

+ type TOCSettings struct

+ Enabled *bool

+ MaxLevel int

+ MinLevel int

+ type TaxonomyConfig struct

+ PaginateBy int

+ Render *bool

+ Singular string

+ UndefinedTags string

+ func (tc *TaxonomyConfig) UnmarshalYAML(value *yaml.Node) error

+ func (tc TaxonomyConfig) ShouldRender() bool

+ type ThemeSettings struct

+ AccentColor string

+ CodeDark string

+ CodeLight string

+ Dark *bool

+ DarkOverrides map[string]string

+ FontFamily string

+ FontMono string

+ Name string

+ Overrides map[string]string

+ Preset string

+ PrimaryColor string

+ type VersionBanner string

+ const BannerNone

+ const BannerUnmaintained

+ const BannerUnreleased

+ type VersionEntry struct

+ Banner VersionBanner

+ ID string

+ Label string

+ Path string

+ Redirect VersionRedirect

+ type VersionRedirect string

+ const RedirectRoot

+ const RedirectSamePage

+ type VersioningConfig struct

+ Enabled *bool

+ Fallback string

+ LastVersion string

+ PublishLatestAtVersionURL bool

+ Versions []VersionEntry

v0.1.0

Jun 27, 2026

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL