site

package

v1.11.0 Latest Latest Go to latest Published: Nov 21, 2025 License: MIT Imports: 16 Imported by: 0

Details

This section is empty.

View Source

var Tags = tags{
	Public:      "Public",
	Private:     "Private",
	PrivateUser: "Private user",
}

This section is empty.

type APIPage struct {
	Spec         *spec.API
	OrderedPaths []APIPath
}

type APIPath struct {
	APIURL        string
	SiteURL       string
	PathItemProps openAPI.PathItemProps
}

type MethodResponse struct {
	Status int
	openAPI.ResponseProps
	ExampleResponse string
}

type Nav []NavItem

func (n *Nav) AppendNavItem(title string, url string, requiresJS bool)

type NavItem struct {
	Name    string
	SiteURL string
	JSOnly  bool
}

func (n NavItem) GetRelativePath(currentPath string) string

func (n NavItem) IsActive(currentPath string) bool

type Page struct {
	Data interface{}

	Title        string
	Path         string
	TemplateName string
	// contains filtered or unexported fields
}

func (p Page) Nav() Nav

Nav dereferencing the pointer so that the template can iterate over it

type PathMethod struct {
	openAPI.OperationProps
	Method           string
	OrderedResponses []MethodResponse
}

type PathPage struct {
	Spec       *spec.API
	Path       string
	Methods    []PathMethod
	Parameters []openAPI.Parameter
	APITitle   string
}

type Site map[string]Page

func NewSite(nav *Nav, APIs spec.APIs, staticRootDir string) *Site