config

Documentation

Index

• func Load()
• type Options

Functions

func Load

func Load()

Load looks for the config.json file in $HOME/.tldr. If the configuration file is not found it will create one with the default configuration options.

Types

type Options

type Options struct {
	PagesURI         string `json:"pages_uri"`
	ZipURI           string `json:"zip_uri"`
	Language         string `json:"language"`
	CacheExpiration  int    `json:"cache_expiration"`
	ExtendedSearch   bool   `json:"extended_search"`
	LookupWarnings   bool   `json:"lookup_warnings"`
	BannerColor1     int    `json:"banner_color_1"`
	BannerColor2     int    `json:"banner_color_2"`
	TLDRColor        int    `json:"tldr_color"`
	HeaderColor      int    `json:"header_color"`
	HeaderDecorColor int    `json:"header_decor_color"`
	PlatformColor    int    `json:"platform_color"`
	PlatformAltColor int    `json:"platform_alt_color"`
	DescriptionColor int    `json:"description_color"`
	ExampleColor     int    `json:"example_color"`
	HyphenColor      int    `json:"hyphen_color"`
	SyntaxColor      int    `json:"syntax_color"`
	VariableColor    int    `json:"variable_color"`
}

Options defines the available configuration options

var Config Options

Config provides the configuration variables read from config.json