reference

type AssetFile struct {
	// Name is the file name to serve, relative to the assets directory. The
	// stylesheet and scripts carry a content hash, so they can be cached
	// forever; fonts keep their names, which the stylesheet refers to.
	Name string
	// Source is the name layouts ask for, such as "reference.css".
	Source string
	Data   []byte
}

type ExportOptions struct {
	// BaseURL is the API's address, the collection's baseUrl variable.
	// Default: http://localhost:8080.
	BaseURL string
	// DocsPath is where the app serves this reference, for llms.txt links.
	// Default: /docs.
	DocsPath string
}

type Heading struct {
	ID, Text string
	Level    int
}

type Options struct {
	// Title names the API in headers and on the overview. Default: the
	// document's info.title.
	Title string
	// Intro is Markdown shown at the top of the overview. Default: the
	// document's info.description.
	Intro string
	// BasePath is where the pages are served. Default "/docs".
	BasePath string
	// TrailingSlash ends page URLs with a slash, for static hosts that serve
	// directories.
	TrailingSlash bool
	// SameOrigin says the pages are served by the API they document: "Try
	// it" sends requests to the page's own origin with the browser's cookies.
	// Otherwise readers choose the server, and cookies aren't sent.
	SameOrigin bool
	// SpecURL, when set, is linked from standalone pages.
	SpecURL string
}

type Page struct {
	URL   string
	Title string
	// Tag groups operations in navigation; "Overview" for the overview.
	Tag string
	// Method and Path are empty on the overview.
	Method, Path string
	// Description is plain text for meta tags and search.
	Description string
	// Main is the page's content. Panel holds an operation's examples and
	// "Try it", shown beside it; it is empty on the overview.
	Main, Panel template.HTML
	// TOC lists the overview's sections.
	TOC []Heading
	// Markdown is the page as Markdown, served next to it with .md.
	Markdown string
	// Text is the page's words, for search.
	Text string
}

type Reference struct {
	// Title names the API.
	Title string
	// Version is the document's info.version.
	Version string
	// Pages are the overview, then a page per operation grouped by tag.
	Pages []*Page
	// contains filtered or unexported fields
}