Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type APISpec ¶ added in v1.1.4
type APISpec struct {
// Spec is the path to the OpenAPI file. It may be given relative to the
// project root (e.g. "apis/teams.yaml") or as a bare file name ("teams.yaml")
// that is matched against the files discovered under apis/.
Spec string `yaml:"spec"`
Slug string `yaml:"slug,omitempty"`
Title string `yaml:"title,omitempty"`
Description string `yaml:"description,omitempty"`
}
APISpec configures a single OpenAPI specification. Configuring a spec is optional: any spec under apis/ is auto-discovered. Listing one here only affects ordering (configured specs come first, in this order; the rest follow auto-discovered at the end) and lets you override the slug/title/description derived from the file name and the spec's info block.
type Config ¶
type Config struct {
Title string `yaml:"title"`
Description string `yaml:"description"`
URL string `yaml:"url"`
Language string `yaml:"language"`
Theme string `yaml:"theme"`
Redirect string `yaml:"redirect,omitempty"`
Branding Branding `yaml:"branding"`
Sections SectionPaths `yaml:"sections"`
Banner Banner `yaml:"banner,omitempty"`
EditBaseURL string `yaml:"edit_base_url,omitempty"`
LLMs LLMsConfig `yaml:"llms,omitempty"`
APIs []APISpec `yaml:"apis,omitempty"`
}
func DefaultConfig ¶
func DefaultConfig() Config
type FooterColumn ¶ added in v1.0.5
type FooterColumn struct {
}
type FooterLink ¶ added in v1.0.5
type FooterLink struct {
}
type FooterSocial ¶ added in v1.0.5
type FooterSocial struct {
}
type LLMsConfig ¶ added in v1.1.0
type SectionPaths ¶
Click to show internal directories.
Click to hide internal directories.