Documentation
¶
Index ¶
- type Builder
- type ChangelogBuilder
- type ContactBuilder
- type FaqBuilder
- type I18nBuilder
- type KBBuilder
- type LandingBuilder
- type LegalBuilder
- type MCPBuilder
- type NavigationBuilder
- type Page
- type PortfolioBuilder
- type StatusBuilder
- func (sb *StatusBuilder) Build(docsRoot string, config core.StatusConfig) (*core.StatusPage, error)
- func (sb *StatusBuilder) CalculateSLAStats(history []core.UptimeDay, target float64) core.SLAStats
- func (sb *StatusBuilder) CalculateUptimeFromIncidents(component core.StatusComponent, incidents []core.Incident, periodDays int) *core.UptimeData
- type VersionBuilder
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Builder ¶
type Builder struct {
// contains filtered or unexported fields
}
Builder orchestrates the site generation process
type ChangelogBuilder ¶
type ChangelogBuilder struct {
// contains filtered or unexported fields
}
ChangelogBuilder handles building the changelog
func NewChangelogBuilder ¶
func NewChangelogBuilder() *ChangelogBuilder
NewChangelogBuilder creates a new changelog builder
func (*ChangelogBuilder) Build ¶
func (cb *ChangelogBuilder) Build(docsRoot string, config core.ChangelogConfig) (*core.ChangelogPage, error)
Build parses and builds the changelog data
type ContactBuilder ¶
type ContactBuilder struct{}
ContactBuilder handles building the contact page
func NewContactBuilder ¶
func NewContactBuilder() *ContactBuilder
NewContactBuilder creates a new contact builder
func (*ContactBuilder) Build ¶
func (cb *ContactBuilder) Build(config core.ContactConfig) (*core.ContactPage, error)
Build creates the contact page from configuration
type FaqBuilder ¶
type FaqBuilder struct {
// contains filtered or unexported fields
}
FaqBuilder handles building the FAQ page
type I18nBuilder ¶
type I18nBuilder struct {
// contains filtered or unexported fields
}
I18nBuilder handles building locale-specific page sets
type KBBuilder ¶
type KBBuilder struct {
// contains filtered or unexported fields
}
KBBuilder handles building the Knowledge Base pages
func NewKBBuilder ¶
func NewKBBuilder() *KBBuilder
NewKBBuilder creates a new Knowledge Base builder
type LandingBuilder ¶
type LandingBuilder struct {
// contains filtered or unexported fields
}
LandingBuilder handles building the landing page
func NewLandingBuilder ¶
func NewLandingBuilder() *LandingBuilder
NewLandingBuilder creates a new landing builder
func (*LandingBuilder) Build ¶
func (lb *LandingBuilder) Build(docsRoot string, config core.LandingConfig, basePath string) (*core.LandingPage, error)
Build creates the landing page from configuration and markdown files
type LegalBuilder ¶
type LegalBuilder struct {
// contains filtered or unexported fields
}
LegalBuilder handles building legal pages
func NewLegalBuilder ¶
func NewLegalBuilder() *LegalBuilder
NewLegalBuilder creates a new legal builder
func (*LegalBuilder) Build ¶
func (lb *LegalBuilder) Build(docsRoot string, config core.LegalConfig, basePath string) ([]*core.LegalPage, error)
Build creates legal pages from markdown files in the legal source directory
type MCPBuilder ¶ added in v1.5.0
type MCPBuilder struct {
// contains filtered or unexported fields
}
MCPBuilder discovers and parses MCP server manifest files
func NewMCPBuilder ¶ added in v1.5.0
func NewMCPBuilder() *MCPBuilder
NewMCPBuilder creates a new MCP builder
type NavigationBuilder ¶
type NavigationBuilder struct{}
NavigationBuilder builds the site navigation tree from pages
func NewNavigationBuilder ¶
func NewNavigationBuilder() *NavigationBuilder
NewNavigationBuilder creates a new navigation builder
func (*NavigationBuilder) Build ¶
func (b *NavigationBuilder) Build(pages []*core.Page, docsDir string, maxDepth int) *core.Navigation
Build creates a navigation tree from a list of pages If TOC.md exists, it will be used to define the navigation structure
type PortfolioBuilder ¶
type PortfolioBuilder struct {
// contains filtered or unexported fields
}
PortfolioBuilder handles building the portfolio page
func NewPortfolioBuilder ¶
func NewPortfolioBuilder() *PortfolioBuilder
NewPortfolioBuilder creates a new portfolio builder
func (*PortfolioBuilder) Build ¶
func (pb *PortfolioBuilder) Build(docsRoot string, config core.PortfolioConfig, basePath string) (*core.PortfolioPage, error)
Build creates the portfolio page from markdown files
type StatusBuilder ¶
type StatusBuilder struct {
// contains filtered or unexported fields
}
StatusBuilder handles building the status page
func NewStatusBuilder ¶
func NewStatusBuilder() *StatusBuilder
NewStatusBuilder creates a new status builder
func (*StatusBuilder) Build ¶
func (sb *StatusBuilder) Build(docsRoot string, config core.StatusConfig) (*core.StatusPage, error)
Build parses and builds the status page data
func (*StatusBuilder) CalculateSLAStats ¶
CalculateSLAStats calculates SLA statistics from uptime history
func (*StatusBuilder) CalculateUptimeFromIncidents ¶
func (sb *StatusBuilder) CalculateUptimeFromIncidents(component core.StatusComponent, incidents []core.Incident, periodDays int) *core.UptimeData
CalculateUptimeFromIncidents calculates uptime data from incident history
type VersionBuilder ¶
type VersionBuilder struct {
// contains filtered or unexported fields
}
VersionBuilder handles building version-specific page sets
func NewVersionBuilder ¶
func NewVersionBuilder() *VersionBuilder
NewVersionBuilder creates a new version builder
Source Files