manifest

package
v0.6.1 Latest Latest
Warning

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

Go to latest
Published: Feb 11, 2026 License: MIT Imports: 3 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

This section is empty.

Types

type Manifest

type Manifest struct {
	Packages        []PackageManifest `json:"packages"`
	WebsiteSections []WebsiteSection  `json:"website_sections,omitempty"`
	Sidebar         *SidebarConfig    `json:"sidebar,omitempty"`
	GeneratedAt     time.Time         `json:"generated_at"`
}

Manifest represents the complete documentation manifest for all packages

func (*Manifest) Save

func (m *Manifest) Save(path string) error

Save saves the manifest to a JSON file

type PackageManifest

type PackageManifest struct {
	Name          string            `json:"name"`
	Title         string            `json:"title"`
	Description   string            `json:"description"`
	Category      string            `json:"category"`
	DocsPath      string            `json:"docs_path"`
	Version       string            `json:"version"`
	RepoURL       string            `json:"repo_url,omitempty"`
	ChangelogPath string            `json:"changelog_path,omitempty"`
	TocDepth      int               `json:"toc_depth,omitempty"`
	Sections      []SectionManifest `json:"sections"`
}

PackageManifest represents documentation manifest for a single package

type SectionManifest

type SectionManifest struct {
	Name     string    `json:"name"`
	Title    string    `json:"title"`
	Order    int       `json:"order"`
	Path     string    `json:"path"`
	JSONKey  string    `json:"json_key,omitempty"`
	Modified time.Time `json:"modified"`
}

SectionManifest represents a single documentation section

type SidebarCategory

type SidebarCategory struct {
	Icon     string   `json:"icon,omitempty"`
	Flat     bool     `json:"flat,omitempty"`
	Packages []string `json:"packages,omitempty"`
}

SidebarCategory defines configuration for a single category in the sidebar.

type SidebarConfig

type SidebarConfig struct {
	CategoryOrder           []string                   `json:"category_order,omitempty"`
	Categories              map[string]SidebarCategory `json:"categories,omitempty"`
	Packages                map[string]SidebarPackage  `json:"packages,omitempty"`
	PackageCategoryOverride map[string]string          `json:"package_category_override,omitempty"`
}

SidebarConfig defines the sidebar ordering and display configuration for the website.

type SidebarPackage

type SidebarPackage struct {
	Icon   string `json:"icon,omitempty"`
	Color  string `json:"color,omitempty"`
	Status string `json:"status,omitempty"`
}

SidebarPackage defines configuration for a single package in the sidebar.

type WebsiteSection

type WebsiteSection struct {
	Name  string            `json:"name"`  // Directory name (e.g., "overview", "concepts")
	Title string            `json:"title"` // Display title (e.g., "Overview", "Concepts")
	Files []SectionManifest `json:"files"` // Individual markdown files in this section
}

WebsiteSection represents a top-level website content section (e.g., overview, concepts) These are distinct from package docs and map to separate Astro content collections.

Jump to

Keyboard shortcuts

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