render

package

Go to main page

Versions in this module

v0

v0.3.0

Jul 22, 2026

Changes in this version

type HugoPage

+ func (hp *HugoPage) RegularPagesRecursive() HugoPageList

+ func (hp *HugoPage) Sections() HugoPageList

type TemplateData

+ TermShown int

+ TermTotal int

v0.2.0

Jun 1, 2026

Changes in this version

type AssetRefs

+ ChromaCSS string

+ type HugoPage struct

+ Site *SiteData

+ func (hp *HugoPage) AllTranslations() []any

+ func (hp *HugoPage) AlternativeOutputFormats() *outputFormatsStub

+ func (hp *HugoPage) Ancestors() PageList

+ func (hp *HugoPage) BundleType() string

+ func (hp *HugoPage) Content() template.HTML

+ func (hp *HugoPage) Data() *PageData

+ func (hp *HugoPage) Date() HugoTime

+ func (hp *HugoPage) Description() string

+ func (hp *HugoPage) Draft() bool

+ func (hp *HugoPage) ExpiryDate() HugoTime

+ func (hp *HugoPage) File() *pageFileStub

+ func (hp *HugoPage) FuzzyWordCount() int

+ func (hp *HugoPage) GetPage(args ...any) *HugoPage

+ func (hp *HugoPage) GitInfo() any

+ func (hp *HugoPage) HasShortcode(name string) bool

+ func (hp *HugoPage) IsHome() bool

+ func (hp *HugoPage) IsNode() bool

+ func (hp *HugoPage) IsPage() bool

+ func (hp *HugoPage) IsSection() bool

+ func (hp *HugoPage) IsTranslated() bool

+ func (hp *HugoPage) Keywords() []string

+ func (hp *HugoPage) Kind() string

+ func (hp *HugoPage) Lang() string

+ func (hp *HugoPage) Language() *SiteLanguage

+ func (hp *HugoPage) Lastmod() HugoTime

+ func (hp *HugoPage) LinkTitle() string

+ func (hp *HugoPage) Next() *content.Page

+ func (hp *HugoPage) OutputFormats() *outputFormatsStub

+ func (hp *HugoPage) Pages() HugoPageList

+ func (hp *HugoPage) Param(key string) any

+ func (hp *HugoPage) Params() map[string]any

+ func (hp *HugoPage) Parent() *content.Page

+ func (hp *HugoPage) Path() string

+ func (hp *HugoPage) Permalink() string

+ func (hp *HugoPage) Prev() *content.Page

+ func (hp *HugoPage) PublishDate() HugoTime

+ func (hp *HugoPage) RawContent() string

+ func (hp *HugoPage) ReadingTime() int

+ func (hp *HugoPage) RegularPages() HugoPageList

+ func (hp *HugoPage) RelPermalink() string

+ func (hp *HugoPage) Render(layout string) template.HTML

+ func (hp *HugoPage) Resources() stubResourceSlice

+ func (hp *HugoPage) Scratch() *Scratch

+ func (hp *HugoPage) Section() string

+ func (hp *HugoPage) Store() *Scratch

+ func (hp *HugoPage) Summary() string

+ func (hp *HugoPage) TableOfContents() template.HTML

+ func (hp *HugoPage) Translations() []any

+ func (hp *HugoPage) Truncated() bool

+ func (hp *HugoPage) Type() string

+ func (hp *HugoPage) Weight() int

+ func (hp *HugoPage) WordCount() int

+ type HugoPageGroup struct

+ Key string

+ Pages HugoPageList

+ type HugoPageList []*HugoPage

+ func (pl HugoPageList) ByDate() HugoPageList

+ func (pl HugoPageList) ByLastmod() HugoPageList

+ func (pl HugoPageList) ByLength() HugoPageList

+ func (pl HugoPageList) ByPublishDate() HugoPageList

+ func (pl HugoPageList) ByTitle() HugoPageList

+ func (pl HugoPageList) ByWeight() HugoPageList

+ func (pl HugoPageList) Filter(fn any) HugoPageList

+ func (pl HugoPageList) First(n int) HugoPageList

+ func (pl HugoPageList) GroupByDate(layout string) []HugoPageGroup

+ func (pl HugoPageList) GroupByLastmod(layout string) []HugoPageGroup

+ func (pl HugoPageList) GroupByParam(key string) []HugoPageGroup

+ func (pl HugoPageList) GroupByPublishDate(layout string) []HugoPageGroup

+ func (pl HugoPageList) Last(n int) HugoPageList

+ func (pl HugoPageList) Len() int

+ func (pl HugoPageList) Limit(n int) HugoPageList

+ func (pl HugoPageList) Related(page any) HugoPageList

+ func (pl HugoPageList) Reverse() HugoPageList

+ type HugoTime struct

+ func (ht HugoTime) Format(layout any) string

+ type PageData struct

+ Pages HugoPageList

+ Plural string

+ Singular string

+ Term string

+ Terms *TermsData

+ type PageList []*content.Page

+ func (pl PageList) First(n int) PageList

+ func (pl PageList) Last(n int) PageList

+ func (pl PageList) Reverse() PageList

type Renderer

+ func (r *Renderer) Prewarm()

+ type Scratch struct

+ func (s *Scratch) Add(key string, val any) string

+ func (s *Scratch) Delete(key string) string

+ func (s *Scratch) Get(key string) any

+ func (s *Scratch) GetSortedMapValues(key string) []any

+ func (s *Scratch) Set(key string, val any) string

+ func (s *Scratch) SetInMap(key, mapKey string, val any) string

+ func (s *Scratch) Values() map[string]any

type SiteData

+ AllPages []*content.Page

+ AllRegularPages []*content.Page

+ Author map[string]any

+ Copyright string

+ Language *SiteLanguage

+ LanguageCode string

+ Menus map[string][]SiteMenuItem

+ Params map[string]any

+ func (s *SiteData) BuildDrafts() bool

+ func (s *SiteData) Config() *siteConfigStub

+ func (s *SiteData) Data() safeDataMap

+ func (s *SiteData) DisablePathToLower() bool

+ func (s *SiteData) DisqusShortname() string

+ func (s *SiteData) EnableRobotsTXT() bool

+ func (s *SiteData) GetPage(args ...string) *siteHomeStub

+ func (s *SiteData) GoogleAnalytics() string

+ func (s *SiteData) Home() *siteHomeStub

+ func (s *SiteData) Hugo() *hugoNamespace

+ func (s *SiteData) IsMinifyOutput() bool

+ func (s *SiteData) IsMultilingual() bool

+ func (s *SiteData) IsServer() bool

+ func (s *SiteData) LanguagePrefix() string

+ func (s *SiteData) LastChange() time.Time

+ func (s *SiteData) Lastmod() HugoTime

+ func (s *SiteData) Pages() HugoPageList

+ func (s *SiteData) Param(key string) any

+ func (s *SiteData) RSSLink() string

+ func (s *SiteData) RegularPages() HugoPageList

+ func (s *SiteData) Social() map[string]string

+ func (s *SiteData) Store() *Scratch

+ func (s *SiteData) Taxonomies() map[string]any

+ type SiteLanguage struct

+ Direction string

+ Lang string

+ LanguageCode string

+ LanguageDirection string

+ LanguageName string

+ Locale string

+ Weight int

+ func (l *SiteLanguage) Get(key string) any

+ func (l *SiteLanguage) IsRTL() bool

+ func (l *SiteLanguage) Name() string

+ func (l *SiteLanguage) Params() map[string]any

+ func (l *SiteLanguage) String() string

+ type SiteMenuItem struct

+ Children []SiteMenuItem

+ HasChildren bool

+ Identifier string

+ Name string

+ URL string

+ Weight int

type TemplateData

+ func (d *TemplateData) AllTranslations() []any

+ func (d *TemplateData) AlternativeOutputFormats() []any

+ func (d *TemplateData) Ancestors() PageList

+ func (d *TemplateData) BundleType() string

+ func (d *TemplateData) Content() template.HTML

+ func (d *TemplateData) CurrentSection() *TemplateData

+ func (d *TemplateData) Data() *PageData

+ func (d *TemplateData) Date() HugoTime

+ func (d *TemplateData) Description() string

+ func (d *TemplateData) Draft() bool

+ func (d *TemplateData) ExpiryDate() HugoTime

+ func (d *TemplateData) File() *pageFileStub

+ func (d *TemplateData) FuzzyWordCount() int

+ func (d *TemplateData) GetPage(args ...any) *TemplateData

+ func (d *TemplateData) GetTerms(taxonomy string) []any

+ func (d *TemplateData) GitInfo() any

+ func (d *TemplateData) HasShortcode(name string) bool

+ func (d *TemplateData) IsHome() bool

+ func (d *TemplateData) IsNode() bool

+ func (d *TemplateData) IsPage() bool

+ func (d *TemplateData) IsSection() bool

+ func (d *TemplateData) IsTranslated() bool

+ func (d *TemplateData) Keywords() []string

+ func (d *TemplateData) Kind() string

+ func (d *TemplateData) Lang() string

+ func (d *TemplateData) Language() *SiteLanguage

+ func (d *TemplateData) Lastmod() HugoTime

+ func (d *TemplateData) Layout() string

+ func (d *TemplateData) LinkTitle() string

+ func (d *TemplateData) Name() string

+ func (d *TemplateData) Next() *content.Page

+ func (d *TemplateData) NextInSection() *content.Page

+ func (d *TemplateData) OutputFormats() *outputFormatsStub

+ func (d *TemplateData) Paginate(pages any, args ...any) *paginatorStub

+ func (d *TemplateData) Paginator(args ...any) *paginatorStub

+ func (d *TemplateData) Param(key string) any

+ func (d *TemplateData) Params() map[string]any

+ func (d *TemplateData) Parent() *safePageRef

+ func (d *TemplateData) Permalink() string

+ func (d *TemplateData) Prev() *content.Page

+ func (d *TemplateData) PrevInSection() *content.Page

+ func (d *TemplateData) PublishDate() HugoTime

+ func (d *TemplateData) ReadingTime() int

+ func (d *TemplateData) RegularPages() HugoPageList

+ func (d *TemplateData) RegularPagesRecursive() HugoPageList

+ func (d *TemplateData) RelPermalink() string

+ func (d *TemplateData) Render(layout string) template.HTML

+ func (d *TemplateData) Resources() stubResourceSlice

+ func (d *TemplateData) Scratch() *Scratch

+ func (d *TemplateData) Section() string

+ func (d *TemplateData) Sections() HugoPageList

+ func (d *TemplateData) Slug() string

+ func (d *TemplateData) Store() *Scratch

+ func (d *TemplateData) Summary() string

+ func (d *TemplateData) TableOfContents() template.HTML

+ func (d *TemplateData) Title() string

+ func (d *TemplateData) TranslationKey() string

+ func (d *TemplateData) Translations() []any

+ func (d *TemplateData) Truncated() bool

+ func (d *TemplateData) Type() string

+ func (d *TemplateData) Weight() int

+ func (d *TemplateData) WordCount() int

+ type TermEntry struct

+ Count int

+ Name string

+ Term string

+ func (t TermEntry) Page() *content.Page

+ func (t TermEntry) Pages() HugoPageList

+ type TermsData struct

+ func (td *TermsData) Alphabetical() []TermEntry

+ func (td *TermsData) ByCount() []TermEntry

v0.1.0

May 27, 2026

Changes in this version

+ type AssetRefs struct

+ CSS string

+ Extra map[string]string

+ FlexSearch string

+ JS string

+ JSHead string

+ KaTeX string

+ type Renderer struct

+ func New(site *SiteData, assets AssetRefs, layoutsDir string, liveReload bool) *Renderer

+ func (r *Renderer) InvalidateCache()

+ func (r *Renderer) Render404(outputDir string, allPages []*content.Page) error

+ func (r *Renderer) RenderPage(page *content.Page, allPages []*content.Page) error

+ func (r *Renderer) RenderSearchPage(outputDir string) error

+ func (r *Renderer) RenderTagPage(tag string, pages []*content.Page, outputDir string) error

+ func (r *Renderer) RenderTaxonomyPage(tags []TagCount, outputDir string) error

+ type SidebarItem struct

+ Active bool

+ Children []*SidebarItem

+ HasActive bool

+ IsParent bool

+ Title string

+ URL string

+ type SiteData struct

+ BaseURL string

+ Description string

+ EditURLBase string

+ Title string

+ type TagCount struct

+ Count int

+ Name string

+ type TemplateData struct

+ Assets AssetRefs

+ CalendarDataJSON string

+ GraphDataJSON string

+ NextPage *content.Page

+ Page *content.Page

+ Pages []*content.Page

+ PrevPage *content.Page

+ SidebarBack *content.Page

+ SidebarItems []*SidebarItem

+ SidebarRoot *content.Page

+ Site *SiteData

+ Tags []TagCount

+ TreeDataJSON string

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