engine

package

Go to main page

Versions in this module

v1

v1.4.0

Aug 29, 2026

v1.3.0

Aug 6, 2026

v1.2.0

Aug 4, 2026

Changes in this version

+ var ValidDirectiveFieldPlacements = map[string]bool

+ var ValidDirectiveFieldTypes = map[string]bool

type CatalogDirective

+ Source string

type Frontmatter

+ OGCard *OGCard

type HeroCTAData

+ Icon string

+ type OGCard struct

+ AccentColor string

+ AccentColor2 string

+ BgColor string

+ HideLogo bool

+ HideWatermark bool

+ TextColor string

type PageMeta

+ DateExplicit bool

v1.1.0

Jul 29, 2026

Changes in this version

+ type LogoContext struct

+ Alt string

+ Dark LogoImage

+ Light LogoImage

+ ReplacesTitle bool

+ Single bool

+ type LogoImage struct

+ Height int

+ URL string

+ Width int

type Page

+ func (p *Page) ShowUpdated() bool

type SiteContext

+ Logo LogoContext

v1.0.1

Jul 25, 2026

v1.0.0

Jul 24, 2026

Changes in this version

+ func SectionDepth(sec *Section) int

type BuildResult

+ PublicFiles int

+ type CatalogCategory struct

+ Fields []CatalogField

+ Label string

+ Name string

+ Nested bool

+ ParentKey string

+ type CatalogCollectionType struct

+ ExtraCategories []string

+ Layout string

+ Names []string

+ type CatalogDirective struct

+ BodyTemplate string

+ Bracket *CatalogDirectiveBracket

+ ChildCountField string

+ ChildDefaultCount int

+ ChildTemplate string

+ Description string

+ Fields []CatalogDirectiveField

+ Kind string

+ Label string

+ Name string

+ type CatalogDirectiveBracket struct

+ Label string

+ Placeholder string

+ Required bool

+ type CatalogDirectiveField struct

+ Default string

+ Label string

+ Name string

+ Options []string

+ Placeholder string

+ Placement string

+ Required bool

+ Type string

+ type CatalogField struct

+ Default any

+ Description string

+ Fields []CatalogField

+ Items []CatalogField

+ Key string

+ Label string

+ Max *float64

+ MaxLength *int

+ Min *float64

+ Options []string

+ Required bool

+ Type string

+ Unrendered bool

type Collection

+ IsMultiCourse bool

+ LabNavTrees map[string]*NavTree

type CollectionConfig

+ Labs *LabsConfig

+ type DirectiveCatalog struct

+ Categories []DirectiveCategory

+ func LoadDirectiveCatalog() (*DirectiveCatalog, error)

+ type DirectiveCategory struct

+ Directives []CatalogDirective

+ Label string

+ Name string

+ type FlexDate struct

+ func (d *FlexDate) UnmarshalYAML(value *yaml.Node) error

+ func (d FlexDate) MarshalYAML() (any, error)

type Frontmatter

+ LearningObjectives []string

+ ShowTags *bool

+ type FrontmatterCatalog struct

+ Categories []CatalogCategory

+ CollectionTypes map[string]CatalogCollectionType

+ Layouts map[string][]string

+ func LoadFrontmatterCatalog() (*FrontmatterCatalog, error)

+ type LabsConfig struct

+ StepLabel string

type LayoutType

+ const LayoutLabs

type NavNode

+ Badge Badge

+ Description string

+ GroupIndex int

type NavTree

+ Hash string

type Page

+ ShowTags *bool

type PageContent

+ FrontmatterLines int

+ type RouteLabs struct

+ LabNumber int

+ LabStepIndex int

+ LabStepLabel string

+ LabStepTotal int

+ LearningObjectives []string

type SidebarConfig

+ CollapseLevel int

+ Overrides map[string]*SidebarOverride

+ TabOverrides map[string]*TabOverride

+ func (s *SidebarConfig) MarkOverrideMatched(key string)

+ func (s *SidebarConfig) MarkTabMatched(key string)

+ func (s *SidebarConfig) UnmatchedOverrideKeys() []string

+ func (s *SidebarConfig) UnmatchedTabKeys() []string

+ type SidebarOverride struct

+ Attrs map[string]string

+ Badge Badge

+ Collapsed *bool

+ Description string

+ Hidden *bool

+ Icon string

+ Label string

+ Order *int

type SiteContext

+ SiteID string

+ type TabOverride struct

+ Description string

+ Icon string

+ Label string

+ Order *int

type ThemeResolver

+ PluginDirs []string

type ValidationEntry

+ Lang string

v0

v0.1.1

Jun 27, 2026

Changes in this version

+ var AllowedHeadTags = map[string]bool

+ var VariantAliases = map[string]BadgeVariant

+ func LayoutHasSidebar(layout LayoutType) bool

+ func LayoutHasTOC(layout LayoutType) bool

+ func ResolvePageVersion(page *Page) string

+ func ValidateLayout(layout LayoutType) bool

+ type Badge struct

+ Text string

+ Variant BadgeVariant

+ func (b *Badge) UnmarshalYAML(value *yaml.Node) error

+ func (b Badge) CSSClass() string

+ func (b Badge) IsEmpty() bool

+ type BadgeVariant string

+ const BadgeVariantCaution

+ const BadgeVariantDanger

+ const BadgeVariantDefault

+ const BadgeVariantNote

+ const BadgeVariantSuccess

+ const BadgeVariantTip

+ type BreadcrumbItem struct

+ Current bool

+ Label string

+ URL string

+ type BuildLogEntry struct

+ Message string

+ Source string

+ type BuildLogger struct

+ func NewBuildLogger() *BuildLogger

+ func (l *BuildLogger) Log(source, message string)

+ func (l *BuildLogger) Messages() []BuildLogEntry

+ type BuildResult struct

+ AliasCount int

+ BundleAssets int

+ Collections int

+ Duration time.Duration

+ LogMessages []BuildLogEntry

+ OutputDir string

+ PageCount int

+ PaginatorPages int

+ PhaseTimings []PhaseTiming

+ ProcessedImages int

+ SitemapCount int

+ StaticFiles int

+ Warnings []ValidationWarning

+ type CollectedLink struct

+ Href string

+ IsImage bool

+ type Collection struct

+ CompositeNavTrees map[string]*NavTree

+ CompositeTabSets map[string][]*DocsTab

+ Config *CollectionConfig

+ Featured []*Page

+ IndexPage *Page

+ IsTabbed bool

+ Name string

+ NavTree *NavTree

+ NavTrees map[string]*NavTree

+ Pages []*Page

+ Sections []*Section

+ Tabs []*DocsTab

+ Title string

+ Versioning *VersionConfig

+ type CollectionConfig struct

+ Feed bool

+ Layout LayoutType

+ Paginate int

+ Permalink string

+ PrevNext *PrevNextConfig

+ Sidebar *SidebarConfig

+ SortBy string

+ SortOrder string

+ TOC *TOCConfig

+ Tabs *bool

+ Versioning *VersionConfig

+ type DocsTab struct

+ Description string

+ Icon string

+ IndexPage *Page

+ NavTree *NavTree

+ NavTrees map[string]*NavTree

+ Order int

+ Pages []*Page

+ Permalink string

+ Section *Section

+ Slug string

+ Title string

+ type EditURLValue struct

+ CustomURL string

+ Disabled bool

+ func (e *EditURLValue) UnmarshalYAML(value *yaml.Node) error

+ type FieldDef struct

+ Default any

+ Label string

+ Max *float64

+ MaxLength *int

+ Min *float64

+ Options []string

+ Required bool

+ Type string

+ type Frontmatter struct

+ Banner *PageBanner

+ Cascade map[string]any

+ Categories []string

+ Head []HeadTag

+ Hero *HeroConfig

+ Icon string

+ Params map[string]any

+ Sidebar FrontmatterSidebar

+ TOC FrontmatterTOC

+ Tags []string

+ Transparent bool

+ type FrontmatterIdentity struct

+ Aliases []string

+ Date time.Time

+ ExpiryDate time.Time

+ Layout string

+ PublishDate time.Time

+ Slug string

+ Template string

+ Title string

+ Type string

+ Updated time.Time

+ type FrontmatterMeta struct

+ Description string

+ Draft bool

+ EditURL *EditURLValue

+ Image string

+ Pagefind *bool

+ Render *bool

+ ShowUpdated *bool

+ Summary string

+ type FrontmatterNav struct

+ Next *NavOverride

+ Prev *NavOverride

+ type FrontmatterSchema struct

+ Fields map[string]FieldDef

+ type FrontmatterSidebar struct

+ Attrs map[string]string

+ Badge Badge

+ Group string

+ Hidden bool

+ Icon string

+ Label string

+ Order int

+ type FrontmatterTOC struct

+ Enabled *bool

+ MaxLevel int

+ MinLevel int

+ func (t *FrontmatterTOC) UnmarshalYAML(value *yaml.Node) error

+ type GlobalNav struct

+ Items []GlobalNavItem

+ type GlobalNavItem struct

+ Collection string

+ External bool

+ IsActive bool

+ Label string

+ URL string

+ type HeadTag struct

+ Attrs map[string]string

+ Content string

+ Tag string

+ type Heading struct

+ ID string

+ Level int

+ Text string

+ type HeroAction struct

+ Attrs map[string]string

+ Icon string

+ Link string

+ Text string

+ Variant string

+ type HeroCTAData struct

+ Label string

+ URL string

+ type HeroCodeData struct

+ Body string

+ Language string

+ Title string

+ type HeroConfig struct

+ Actions []HeroAction

+ Image *HeroImage

+ Tagline string

+ Title string

+ func (h *HeroConfig) SanitizeAttrs()

+ type HeroData struct

+ Background string

+ CTA *HeroCTAData

+ Code *HeroCodeData

+ Eyebrow string

+ Image *HeroImageData

+ SecondaryCTA *HeroCTAData

+ Stats []HeroStatData

+ Subtitle string

+ Title string

+ type HeroImage struct

+ Alt string

+ Dark string

+ Light string

+ Src string

+ type HeroImageData struct

+ Alt string

+ Dark string

+ HTML template.HTML

+ Light string

+ Src string

+ type HeroStatData struct

+ Label string

+ Value string

+ type HomepageData struct

+ Hero HeroData

+ Template string

+ type IconLicense struct

+ Prefix string

+ SPDX string

+ Title string

+ URL string

+ type Language struct

+ Code string

+ Dir string

+ Name string

+ Weight int

+ type LayoutType string

+ const LayoutCentered

+ const LayoutDefault

+ const LayoutDocs

+ const LayoutFull

+ const LayoutPresentation

+ const LayoutSplash

+ const LayoutSplit

+ const LayoutWide

+ func ResolveLayout(s string) LayoutType

+ type MarkdownRenderer interface

+ Render func(markdown string) (RenderResult, error)

+ type NavNode struct

+ Attrs map[string]string

+ Children []*NavNode

+ DefaultOpen bool

+ Depth int

+ HasActive bool

+ Icon string

+ IsActive bool

+ IsOpen bool

+ Label string

+ Order int

+ Page *Page

+ Parent *NavNode

+ Position int

+ Slug string

+ URL string

+ type NavOverride struct

+ Disabled bool

+ Label string

+ Link string

+ Slug string

+ func (n *NavOverride) UnmarshalYAML(value *yaml.Node) error

+ type NavTree struct

+ Flat []*NavNode

+ MaxDepth int

+ Root *NavNode

+ TotalPages int

+ type NodeKind string

+ const KindBundle

+ const KindHome

+ const KindPage

+ const KindSection

+ const KindStandalone

+ const KindTaxonomy

+ const KindTerm

+ type Page struct

+ NavNode *NavNode

+ Params map[string]any

+ Resources []Resource

+ Sidebar PageSidebar

+ TOC PageTOC

+ type PageBanner struct

+ Content string

+ Icon string

+ Variant string

+ type PageContent struct

+ Content template.HTML

+ ContentDigest string

+ FrontmatterDigest string

+ HasCodeBlocks bool

+ HasImages bool

+ Headings []Heading

+ RawContent string

+ ReadingTime int

+ Summary template.HTML

+ WordCount int

+ type PageI18n struct

+ AllTranslations []*Page

+ IsFallback bool

+ Lang string

+ LangRelPath string

+ Translations []*Page

+ type PageIdentity struct

+ Date time.Time

+ ExpiryDate time.Time

+ FilePath string

+ Kind NodeKind

+ Permalink string

+ PublishDate time.Time

+ RelPath string

+ RelPermalink string

+ Slug string

+ Title string

+ Updated time.Time

+ func (p *PageIdentity) URL() string

+ type PageMeta struct

+ Description string

+ Draft bool

+ Image string

+ type PageRelationships struct

+ Backlinks []*Page

+ Collection *Collection

+ NextPage *Page

+ PrevPage *Page

+ Section *Section

+ Siblings []*Page

+ type PageSidebar struct

+ Attrs map[string]string

+ Badge Badge

+ Group string

+ Hidden bool

+ Icon string

+ Label string

+ Order int

+ type PageTOC struct

+ Enabled *bool

+ MaxLevel int

+ MinLevel int

+ type PageTaxonomy struct

+ Aliases []string

+ Categories []string

+ Extra map[string][]string

+ Tags []string

+ type PageVersioning struct

+ Version string

+ VersionPeers []*Page

+ VersionRelPath string

+ type PaginationLink struct

+ Title string

+ URL string

+ type PaginationLinks struct

+ Next *PaginationLink

+ Prev *PaginationLink

+ type Paginator struct

+ BaseURL string

+ Current int

+ CurrentPages []*Page

+ FirstURL string

+ HasNext bool

+ HasPrev bool

+ LastURL string

+ NextURL string

+ Pages []PaginationLink

+ PrevURL string

+ Total int

+ TotalItems int

+ type PhaseTiming struct

+ Duration time.Duration

+ Phase string

+ type PrevNextConfig struct

+ Enabled bool

+ Labels [2]string

+ type RenderResult struct

+ HTML string

+ HasCodeBlocks bool

+ HasImages bool

+ Headings []Heading

+ Links []CollectedLink

+ type Resource struct

+ Height int

+ MediaType string

+ Name string

+ RelPermalink string

+ SrcPath string

+ Title string

+ Width int

+ type RouteAssets struct

+ InlineScripts []template.JS

+ ModuleScripts []string

+ Scripts []string

+ Styles []string

+ type RouteData struct

+ Collection *Collection

+ Homepage *HomepageData

+ Layout LayoutType

+ Page *Page

+ PageBanner *PageBanner

+ Site *SiteContext

+ Taxonomy *Taxonomy

+ TaxonomyTerm *TaxonomyTerm

+ Template string

+ TermEntries []*TermEntry

+ Theme *ThemeConfig

+ type RouteI18n struct

+ AllTranslations []TranslationLink

+ Dir string

+ Lang string

+ Translations []TranslationLink

+ type RouteNav struct

+ Breadcrumbs []BreadcrumbItem

+ GlobalNav *GlobalNav

+ HasSidebar bool

+ IsSection bool

+ Pagination *PaginationLinks

+ Paginator *Paginator

+ Section *Section

+ Sidebar *NavTree

+ SidebarCollapsedByDefault bool

+ SidebarType string

+ type RouteTabs struct

+ ActiveTab *DocsTab

+ DocsTabs []*DocsTab

+ IsTabbed bool

+ type RouteVersioning struct

+ IsLatest bool

+ Version string

+ VersionBanner string

+ VersionLabel string

+ Versions []VersionLink

+ type Section struct

+ Collection *Collection

+ IndexPage *Page

+ Pages []*Page

+ Parent *Section

+ Permalink string

+ Render bool

+ Sections []*Section

+ Slug string

+ Title string

+ Transparent bool

+ type SidebarConfig struct

+ CollapsedByDefault bool

+ Collapsible bool

+ MaxDepth int

+ Search bool

+ type SiteContext struct

+ BasePath string

+ BaseURL string

+ BuildTime time.Time

+ Collections map[string]*Collection

+ Config any

+ Data map[string]any

+ DefaultLang string

+ EditURL string

+ Favicon string

+ FaviconType string

+ Generator string

+ IconLicenses []IconLicense

+ KazariScriptURL string

+ Language string

+ Languages []Language

+ Pages []*Page

+ SitemapEnabled bool

+ Taxonomies map[string]*Taxonomy

+ TaxonomiesByLang map[string]map[string]*Taxonomy

+ Title string

+ type TOCConfig struct

+ Enabled bool

+ MaxLevel int

+ MinLevel int

+ ScrollHighlight bool

+ type Taxonomy struct

+ Name string

+ PaginateBy int

+ Permalink string

+ Singular string

+ Terms map[string]*TaxonomyTerm

+ type TaxonomyTerm struct

+ Color string

+ ContentType string

+ CustomSlug string

+ Description string

+ Difficulty string

+ Hidden bool

+ Icon string

+ Label string

+ Name string

+ Pages []*Page

+ Permalink string

+ Priority int

+ Slug string

+ type TermEntry struct

+ Count int

+ PopTier int

+ type ThemeConfig struct

+ Author string

+ DarkEnabled bool

+ DarkTokens map[string]string

+ Name string

+ Slug string

+ StyleTag template.HTML

+ Tokens map[string]string

+ Version string

+ type ThemeResolver struct

+ EmbeddedFS fs.FS

+ ProjectDir string

+ ThemeName string

+ type TranslationLink struct

+ Dir string

+ IsFallback bool

+ Lang string

+ Name string

+ Title string

+ URL string

+ type URLResolver struct

+ BasePath string

+ BaseURL string

+ CollectionMounts []string

+ DefaultLang string

+ I18nEnabled bool

+ Languages map[string]bool

+ Strategy string

+ VersionIDs map[string]bool

+ func (r *URLResolver) AbsURL(relPath, lang, version string) string

+ func (r *URLResolver) CacheKey() string

+ func (r *URLResolver) IsVersionID(seg string) bool

+ func (r *URLResolver) OutputRelPath(relPath, lang, version string) string

+ func (r *URLResolver) URL(relPath, lang, version string) string

+ type ValidationEntry struct

+ FilePath string

+ Links []CollectedLink

+ type ValidationWarning struct

+ Field string

+ File string

+ Level string

+ Message string

+ type VersionConfig struct

+ Enabled bool

+ LastVersion string

+ PublishLatestAtVersionURL bool

+ Versions []VersionDef

+ type VersionDef struct

+ Banner string

+ ID string

+ Label string

+ Path string

+ Redirect string

+ type VersionLink struct

+ Banner string

+ ID string

+ IsCurrent bool

+ IsLatest bool

+ Label string

+ Redirect string

+ Title string

+ URL string

v0.1.0

Jun 27, 2026

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