package hugolib

import "github.com/gohugoio/hugo/hugolib"

Index

Functions

func DefaultConfig 

func DefaultConfig() *allconfig.Config

DefaultConfig returns the default configuration.

func ExampleConfig 

func ExampleConfig() (*allconfig.Config, error)

ExampleConfig returns the some example configuration for documentation.

Types

type BuildCfg 

type BuildCfg struct {
	// Skip rendering. Useful for testing.
	SkipRender bool

	// Use this to indicate what changed (for rebuilds).
	WhatChanged *WhatChanged

	// This is a partial re-render of some selected pages.
	PartialReRender bool

	// Set in server mode when the last build failed for some reason.
	ErrRecovery bool

	// Recently visited or touched URLs. This is used for partial re-rendering.
	RecentlyTouched *types.EvictingQueue[string]

	// Can be set to build only with a sub set of the content source.
	ContentInclusionFilter *glob.FilenameFilter

	// Set when the buildlock is already acquired (e.g. the archetype content builder).
	NoBuildLock bool
	// contains filtered or unexported fields
}

BuildCfg holds build options used to, as an example, skip the render step.

type ContentFactory 

type ContentFactory struct {
	// contains filtered or unexported fields
}

ContentFactory creates content files from archetype templates.

func NewContentFactory 

func NewContentFactory(h *HugoSites) ContentFactory

NewContentFactory creates a new ContentFactory for h.

func (ContentFactory) ApplyArchetypeFi 

func (f ContentFactory) ApplyArchetypeFi(w io.Writer, p page.Page, archetypeKind string, fi hugofs.FileMetaInfo) error

ApplyArchetypeFilename archetypeFilename to w as a template using the given Page p as the foundation for the data context.

func (ContentFactory) ApplyArchetypeTemplate 

func (f ContentFactory) ApplyArchetypeTemplate(w io.Writer, p page.Page, archetypeKind, templateSource string) error

ApplyArchetypeTemplate templateSource to w as a template using the given Page p as the foundation for the data context.

func (ContentFactory) CreateContentPlaceHolder 

func (f ContentFactory) CreateContentPlaceHolder(filename string, force bool) (string, error)

CreateContentPlaceHolder creates a content placeholder file inside the best matching content directory.

func (ContentFactory) SectionFromFilename 

func (f ContentFactory) SectionFromFilename(filename string) (string, error)

type HugoSites 

type HugoSites struct {
	Sites []*Site

	Configs *allconfig.Configs

	*deps.Deps
	// contains filtered or unexported fields
}

HugoSites represents the sites to build. Each site represents a language.

func NewHugoSites 

func NewHugoSites(cfg deps.DepsCfg) (*HugoSites, error)

NewHugoSites creates HugoSites from the given config.

func (*HugoSites) Build 

func (h *HugoSites) Build(config BuildCfg, events ...fsnotify.Event) error

Build builds all sites. If filesystem events are provided, this is considered to be a potential partial rebuild.

func (*HugoSites) Close 

func (h *HugoSites) Close() error

func (*HugoSites) Data 

func (h *HugoSites) Data() map[string]any

func (HugoSites) Done 

func (f HugoSites) Done() <-chan bool

func (HugoSites) FatalError 

func (f HugoSites) FatalError(err error)

FatalError error is used in some rare situations where it does not make sense to continue processing, to abort as soon as possible and log the error.

func (*HugoSites) GC 

func (h *HugoSites) GC() (int, error)

GC requires a build first and must run on it's own. It is not thread safe.

func (*HugoSites) GetContentPage 

func (h *HugoSites) GetContentPage(filename string) page.Page

GetContentPage finds a Page with content given the absolute filename. Returns nil if none found.

func (*HugoSites) LanguageSet 

func (h *HugoSites) LanguageSet() map[string]int

TODO(bep) consolidate

func (*HugoSites) LogServerAddresses 

func (h *HugoSites) LogServerAddresses()

func (*HugoSites) NumLogErrors 

func (h *HugoSites) NumLogErrors() int

func (*HugoSites) Pages 

func (h *HugoSites) Pages() page.Pages

Pages returns all pages for all sites.

func (*HugoSites) PrintProcessingStats 

func (h *HugoSites) PrintProcessingStats(w io.Writer)

func (*HugoSites) RegularPages 

func (h *HugoSites) RegularPages() page.Pages

Pages returns all regularpages for all sites.

func (*HugoSites) ShouldSkipFileChangeEvent 

func (h *HugoSites) ShouldSkipFileChangeEvent(ev fsnotify.Event) bool

ShouldSkipFileChangeEvent allows skipping filesystem event early before the build is started.

type IntegrationTestBuilder 

type IntegrationTestBuilder struct {
	*qt.C

	H *HugoSites

	Cfg IntegrationTestConfig

	GCCount int
	// contains filtered or unexported fields
}

IntegrationTestBuilder is a (partial) rewrite of sitesBuilder. The main problem with the "old" one was that it was that the test data was often a little hidden, so it became hard to look at a test and determine what it should do, especially coming back to the test after a year or so.

func NewIntegrationTestBuilder 

func NewIntegrationTestBuilder(conf IntegrationTestConfig) *IntegrationTestBuilder

In most cases you should not use this function directly, but the Test or TestRunning function.

func Test 

func Test(t testing.TB, files string, opts ...TestOpt) *IntegrationTestBuilder

Test is a convenience method to create a new IntegrationTestBuilder from some files and run a build.

func TestE 

func TestE(t testing.TB, files string, opts ...TestOpt) (*IntegrationTestBuilder, error)

TestE is the same as Test, but returns an error instead of failing the test.

func TestRunning 

func TestRunning(t testing.TB, files string, opts ...TestOpt) *IntegrationTestBuilder

TestRunning is a convenience method to create a new IntegrationTestBuilder from some files with Running set to true and run a build. Deprecated: Use Test with TestOptRunning instead.

func (*IntegrationTestBuilder) AddFiles 

func (s *IntegrationTestBuilder) AddFiles(filenameContent ...string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) AssertBuildCountData 

func (s *IntegrationTestBuilder) AssertBuildCountData(count int)

func (*IntegrationTestBuilder) AssertBuildCountGitInfo 

func (s *IntegrationTestBuilder) AssertBuildCountGitInfo(count int)

func (*IntegrationTestBuilder) AssertFileContent 

func (s *IntegrationTestBuilder) AssertFileContent(filename string, matches ...string)

func (*IntegrationTestBuilder) AssertFileContentEquals 

func (s *IntegrationTestBuilder) AssertFileContentEquals(filename string, match string)

func (*IntegrationTestBuilder) AssertFileContentExact 

func (s *IntegrationTestBuilder) AssertFileContentExact(filename string, matches ...string)

func (*IntegrationTestBuilder) AssertFileCount 

func (s *IntegrationTestBuilder) AssertFileCount(dirname string, expected int)

func (*IntegrationTestBuilder) AssertFileExists 

func (s *IntegrationTestBuilder) AssertFileExists(filename string, b bool)

func (*IntegrationTestBuilder) AssertFs 

func (s *IntegrationTestBuilder) AssertFs(fs afero.Fs, matches ...string)

func (*IntegrationTestBuilder) AssertIsFileError 

func (s *IntegrationTestBuilder) AssertIsFileError(err error) herrors.FileError

func (*IntegrationTestBuilder) AssertLogContains 

func (s *IntegrationTestBuilder) AssertLogContains(els ...string)

AssertLogContains asserts that the last build log contains the given strings. Each string can be negated with a "! " prefix.

func (*IntegrationTestBuilder) AssertLogMatches 

func (s *IntegrationTestBuilder) AssertLogMatches(expression string)

AssertLogNotContains asserts that the last build log does matches the given regular expressions. The regular expressions can be negated with a "! " prefix.

func (*IntegrationTestBuilder) AssertNoRenderShortcodesArtifacts 

func (s *IntegrationTestBuilder) AssertNoRenderShortcodesArtifacts()

func (*IntegrationTestBuilder) AssertPublishDir 

func (s *IntegrationTestBuilder) AssertPublishDir(matches ...string)

func (*IntegrationTestBuilder) AssertRenderCountContent 

func (s *IntegrationTestBuilder) AssertRenderCountContent(count int)

func (*IntegrationTestBuilder) AssertRenderCountPage 

func (s *IntegrationTestBuilder) AssertRenderCountPage(count int)

func (*IntegrationTestBuilder) AssertRenderCountPageBetween 

func (s *IntegrationTestBuilder) AssertRenderCountPageBetween(from, to int)

func (*IntegrationTestBuilder) Build 

func (s *IntegrationTestBuilder) Build() *IntegrationTestBuilder

func (*IntegrationTestBuilder) BuildE 

func (s *IntegrationTestBuilder) BuildE() (*IntegrationTestBuilder, error)

func (*IntegrationTestBuilder) BuildPartial 

func (s *IntegrationTestBuilder) BuildPartial(urls ...string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) BuildPartialE 

func (s *IntegrationTestBuilder) BuildPartialE(urls ...string) (*IntegrationTestBuilder, error)

func (*IntegrationTestBuilder) Close 

func (s *IntegrationTestBuilder) Close()

func (*IntegrationTestBuilder) EditFileReplaceAll 

func (s *IntegrationTestBuilder) EditFileReplaceAll(filename, old, new string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) EditFileReplaceFunc 

func (s *IntegrationTestBuilder) EditFileReplaceFunc(filename string, replacementFunc func(s string) string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) EditFiles 

func (s *IntegrationTestBuilder) EditFiles(filenameContent ...string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) FileContent 

func (s *IntegrationTestBuilder) FileContent(filename string) string

func (*IntegrationTestBuilder) Init 

func (s *IntegrationTestBuilder) Init() *IntegrationTestBuilder

func (*IntegrationTestBuilder) LogString 

func (s *IntegrationTestBuilder) LogString() string

func (*IntegrationTestBuilder) RemoveFiles 

func (s *IntegrationTestBuilder) RemoveFiles(filenames ...string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) RenameDir 

func (s *IntegrationTestBuilder) RenameDir(old, new string) *IntegrationTestBuilder

func (*IntegrationTestBuilder) RenameFile 

func (s *IntegrationTestBuilder) RenameFile(old, new string) *IntegrationTestBuilder

type IntegrationTestConfig 

type IntegrationTestConfig struct {
	T testing.TB

	// The files to use on txtar format, see
	// https://pkg.go.dev/golang.org/x/exp/cmd/txtar
	// There are some conentions used in this test setup.
	// - §§§ can be used to wrap code fences.
	// - §§ can be used to wrap multiline strings.
	// - filenames prefixed with sourcefilename: will be read from the file system relative to the current dir.
	// - filenames with a .png or .jpg extension will be treated as binary and base64 decoded.
	TxtarString string

	// COnfig to use as the base. We will also read the config from the txtar.
	BaseCfg config.Provider

	// Environment variables passed to the config loader.
	Environ []string

	// Whether to simulate server mode.
	Running bool

	// Watch for changes.
	// This is (currently) always set to true when Running is set.
	// Note that the CLI for the server does allow for --watch=false, but that is not used in these test.
	Watching bool

	// Will print the log buffer after the build
	Verbose bool

	// The log level to use.
	LogLevel logg.Level

	// Whether it needs the real file system (e.g. for js.Build tests).
	NeedsOsFS bool

	// Whether to run GC after each build.
	RunGC bool

	// Do not remove the temp dir after the test.
	PrintAndKeepTempDir bool

	// Whether to run npm install before Build.
	NeedsNpmInstall bool

	// Whether to normalize the Unicode filenames to NFD on Darwin.
	NFDFormOnDarwin bool

	// The working dir to use. If not absolute, a temp dir will be created.
	WorkingDir string

	// The config to pass to Build.
	BuildCfg BuildCfg
}

type IntegrationTestDebugConfig 

type IntegrationTestDebugConfig struct {
	Out io.Writer

	PrintDestinationFs bool
	PrintPagemap       bool

	PrefixDestinationFs string
	PrefixPagemap       string
}

type Permalinker 

type Permalinker interface {
	Permalink() string
	RelPermalink() string
}

Permalinker provides permalinks of both the relative and absolute kind.

type ShortcodeWithPage 

type ShortcodeWithPage struct {
	Params        any
	Inner         template.HTML
	Page          page.Page
	Parent        *ShortcodeWithPage
	Name          string
	IsNamedParams bool

	// Zero-based ordinal in relation to its parent. If the parent is the page itself,
	// this ordinal will represent the position of this shortcode in the page content.
	Ordinal int
	// contains filtered or unexported fields
}

ShortcodeWithPage is the "." context in a shortcode template.

func (*ShortcodeWithPage) Get 

func (scp *ShortcodeWithPage) Get(key any) any

Get is a convenience method to look up shortcode parameters by its key.

func (*ShortcodeWithPage) InnerDeindent 

func (scp *ShortcodeWithPage) InnerDeindent() template.HTML

InnerDeindent returns the (potentially de-indented) inner content of the shortcode.

func (*ShortcodeWithPage) Position 

func (scp *ShortcodeWithPage) Position() text.Position

Position returns this shortcode's detailed position. Note that this information may be expensive to calculate, so only use this in error situations.

func (*ShortcodeWithPage) Ref 

func (scp *ShortcodeWithPage) Ref(args map[string]any) (string, error)

Ref is a shortcut to the Ref method on Page. It passes itself as a context to get better error messages.

func (*ShortcodeWithPage) RelRef 

func (scp *ShortcodeWithPage) RelRef(args map[string]any) (string, error)

RelRef is a shortcut to the RelRef method on Page. It passes itself as a context to get better error messages.

func (*ShortcodeWithPage) Scratch 

func (scp *ShortcodeWithPage) Scratch() *maps.Scratch

Scratch returns a scratch-pad scoped for this shortcode. This can be used as a temporary storage for variables, counters etc. Deprecated: Use Store instead. Note that from the templates this should be considered a "soft deprecation".

func (*ShortcodeWithPage) Site 

func (scp *ShortcodeWithPage) Site() page.Site

Site returns information about the current site.

func (*ShortcodeWithPage) Store 

func (scp *ShortcodeWithPage) Store() *maps.Scratch

Store returns this shortcode's Store.

func (*ShortcodeWithPage) Unwrapv 

func (scp *ShortcodeWithPage) Unwrapv() any

For internal use only.

type Site 

type Site struct {
	*deps.Deps
	// contains filtered or unexported fields
}

func (*Site) AllPages 

func (s *Site) AllPages() page.Pages

AllPages returns all pages for all sites.

func (*Site) AllRegularPages 

func (s *Site) AllRegularPages() page.Pages

AllRegularPages returns all regular pages for all sites.

func (*Site) Author 

func (s *Site) Author() map[string]any

Deprecated: Use taxonomies instead.

func (*Site) Authors 

func (s *Site) Authors() page.AuthorList

Deprecated: Use taxonomies instead.

func (*Site) BaseURL 

func (s *Site) BaseURL() string

Returns the BaseURL for this Site.

func (*Site) BuildDrafts 

func (s *Site) BuildDrafts() bool

func (*Site) CheckReady 

func (s *Site) CheckReady()

func (*Site) Config 

func (s *Site) Config() page.SiteConfig

func (*Site) Copyright 

func (s *Site) Copyright() string

func (*Site) Current 

func (s *Site) Current() page.Site

Returns Site currently rendering.

func (*Site) Data 

func (s *Site) Data() map[string]any

Returns a map of all the data inside /data.

func (*Site) Debug 

func (s *Site) Debug()

func (*Site) ForEeachIdentityByName 

func (s *Site) ForEeachIdentityByName(name string, f func(identity.Identity) bool)

func (*Site) GetPage 

func (s *Site) GetPage(ref ...string) (page.Page, error)

GetPage looks up a page of a given type for the given ref. In Hugo <= 0.44 you had to add Page Kind (section, home) etc. as the first argument and then either a unix styled path (with or without a leading slash)) or path elements separated. When we now remove the Kind from this API, we need to make the transition as painless as possible for existing sites. Most sites will use {{ .Site.GetPage "section" "my/section" }}, i.e. 2 arguments, so we test for that.

func (*Site) GetRelatedDocsHandler 

func (s *Site) GetRelatedDocsHandler() *page.RelatedDocsHandler

func (*Site) Home 

func (s *Site) Home() page.Page

Home is a shortcut to the home page, equivalent to .Site.GetPage "home".

func (*Site) Hugo 

func (s *Site) Hugo() hugo.HugoInfo

Returns a struct with some information about the build.

func (*Site) IsMultiLingual 

func (s *Site) IsMultiLingual() bool

Deprecated: Use hugo.IsMultilingual instead.

func (*Site) Language 

func (s *Site) Language() *langs.Language

func (*Site) LanguageCode 

func (s *Site) LanguageCode() string

func (*Site) LanguagePrefix 

func (s *Site) LanguagePrefix() string

func (*Site) Languages 

func (s *Site) Languages() langs.Languages

func (*Site) LastChange 

func (s *Site) LastChange() time.Time

Deprecated: Use .Site.Lastmod instead.

func (*Site) Lastmod 

func (s *Site) Lastmod() time.Time

Returns the last modification date of the content.

func (*Site) MainSections 

func (s *Site) MainSections() []string

MainSections returns the list of main sections.

func (*Site) Menus 

func (s *Site) Menus() navigation.Menus

func (*Site) Pages 

func (s *Site) Pages() page.Pages

Pages returns all pages. This is for the current language only.

func (*Site) Param 

func (s *Site) Param(key any) (any, error)

func (*Site) Params 

func (s *Site) Params() maps.Params

Returns the Params configured for this site.

func (*Site) RegisterMediaTypes 

func (s *Site) RegisterMediaTypes()

RegisterMediaTypes will register the Site's media types in the mime package, so it will behave correctly with Hugo's built-in server.

func (*Site) RegularPages 

func (s *Site) RegularPages() page.Pages

RegularPages returns all the regular pages. This is for the current language only.

func (*Site) Sections 

func (s *Site) Sections() page.Pages

Sections returns the top level sections.

func (*Site) ServerPort 

func (s *Site) ServerPort() int

Returns the server port.

func (*Site) Site 

func (s *Site) Site() page.Site

func (*Site) SitemapAbsURL 

func (s *Site) SitemapAbsURL() string

SitemapAbsURL is a convenience method giving the absolute URL to the sitemap.

func (*Site) Sites 

func (s *Site) Sites() page.Sites

Returns all Sites for all languages.

func (*Site) Social 

func (s *Site) Social() map[string]string

Deprecated: Use .Site.Params instead.

func (*Site) Store 

func (s *Site) Store() *maps.Scratch

func (*Site) Taxonomies 

func (s *Site) Taxonomies() page.TaxonomyList

func (*Site) Title 

func (s *Site) Title() string

Returns the configured title for this Site.

type TestOpt 

type TestOpt func(*IntegrationTestConfig)

func TestOptDebug 

func TestOptDebug() TestOpt

TestOptDebug will enable debug logging in integration tests.

func TestOptInfo 

func TestOptInfo() TestOpt

TestOptInfo will enable info logging in integration tests.

func TestOptOsFs 

func TestOptOsFs() TestOpt

TestOptOsFs will enable the real file system in integration tests.

func TestOptRunning 

func TestOptRunning() TestOpt

TestOptRunning will enable running in integration tests.

func TestOptTrace 

func TestOptTrace() TestOpt

Enable tracing in integration tests. THis should only be used during development and not committed to the repo.

func TestOptWarn 

func TestOptWarn() TestOpt

TestOptWarn will enable warn logging in integration tests.

func TestOptWatching 

func TestOptWatching() TestOpt

TestOptWatching will enable watching in integration tests.

func TestOptWithConfig 

func TestOptWithConfig(fn func(c *IntegrationTestConfig)) TestOpt

TestOptWithWorkingDir allows setting any config optiona as a function al option.

func TestOptWithNFDOnDarwin 

func TestOptWithNFDOnDarwin() TestOpt

TestOptWithNFDOnDarwin will normalize the Unicode filenames to NFD on Darwin.

func TestOptWithOSFs 

func TestOptWithOSFs() TestOpt

TestOptWithOSFs enables the real file system.

func TestOptWithPrintAndKeepTempDir 

func TestOptWithPrintAndKeepTempDir(b bool) TestOpt

type WhatChanged 

type WhatChanged struct {
	// contains filtered or unexported fields
}

func (*WhatChanged) Add 

func (w *WhatChanged) Add(ids ...identity.Identity)

func (*WhatChanged) Changes 

func (w *WhatChanged) Changes() []identity.Identity

func (*WhatChanged) Clear 

func (w *WhatChanged) Clear()

func (*WhatChanged) Drain 

func (w *WhatChanged) Drain() []identity.Identity

Source Files

alias.go codeowners.go collections.go config.go content_factory.go content_map.go content_map_page.go fileInfo.go gitinfo.go hugo_sites.go hugo_sites_build.go integrationtest_builder.go page.go page__common.go page__content.go page__data.go page__menus.go page__meta.go page__new.go page__output.go page__paginator.go page__paths.go page__per_output.go page__position.go page__ref.go page__tree.go page_kinds.go page_unwrap.go pagecollections.go pages_capture.go permalinker.go prune_resources.go shortcode.go shortcode_page.go site.go site_output.go site_render.go site_sections.go

Directories

PathSynopsis
hugolib/doctree
hugolib/filesystemsPackage filesystems provides the fine grained file systems used by Hugo.
hugolib/pagesfromdata
hugolib/paths
hugolib/segments
Version
v0.144.2 (latest)
Published
Feb 19, 2025
Platform
linux/amd64
Imports
104 packages
Last checked
12 hours ago –

Tools for package owners.