config

package
v3.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Dec 29, 2025 License: GPL-3.0 Imports: 5 Imported by: 0

Documentation

Overview

Package config defines configuration (read from file) and defaults

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

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"`
	Path          string       `yaml:"path"`
	Head          string       `yaml:"head"`
	CodeTheme     string       `yaml:"codeTheme"`
	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 struct {
	Href string `yaml:"href"`
	Text string `yaml:"text"`
}

Jump to

Keyboard shortcuts

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