Documentation
¶
Overview ¶
Package config loads and validates kwelea.toml configuration files.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type BuildConfig ¶
BuildConfig controls where kwelea reads and writes files.
type Config ¶
type Config struct {
Site SiteConfig `toml:"site"`
Build BuildConfig `toml:"build"`
Serve ServeConfig `toml:"serve"`
Theme ThemeConfig `toml:"theme"`
}
Config is the top-level configuration loaded from kwelea.toml.
type NavEntry ¶
type NavEntry struct {
}
NavEntry is a manually-ordered navigation section defined in kwelea.toml. When no [[nav]] sections exist the walker builds the nav automatically from the docs/ directory structure.
type ServeConfig ¶
ServeConfig controls the development server.
type SiteConfig ¶
type SiteConfig struct {
Title string `toml:"title"`
Version string `toml:"version"`
BaseURL string `toml:"base_url"`
Repo string `toml:"repo"`
}
SiteConfig holds site-level metadata shown in every page.
type ThemeConfig ¶
type ThemeConfig struct {
LightCodeTheme string `toml:"light_code_theme"`
DarkCodeTheme string `toml:"dark_code_theme"`
}
ThemeConfig controls syntax highlighting colour schemes.
Click to show internal directories.
Click to hide internal directories.