Version: v0.101.0 Latest Latest

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

Go to latest
Published: Jun 16, 2022 License: Apache-2.0 Imports: 93 Imported by: 75




This section is empty.


View Source
var ErrNoConfigFile = errors.New("Unable to locate config file or config directory. Perhaps you need to create a new site.\n       Run `hugo help new` for details.\n")


func LoadConfig added in v0.20.1

func LoadConfig(d ConfigSourceDescriptor, doWithConfig ...func(cfg config.Provider) error) (config.Provider, []string, error)

LoadConfig loads Hugo configuration into a new Viper and then adds a set of defaults.

func LoadConfigDefault added in v0.38.1

func LoadConfigDefault(fs afero.Fs) (config.Provider, error)

LoadConfigDefault is a convenience method to load the default "config.toml" config.


type BuildCfg

type BuildCfg struct {
	// Reset site state before build. Use to force full rebuilds.
	ResetState bool
	// If set, we re-create the sites from the given configuration before a build.
	// This is needed if new languages are added.
	NewConfig config.Provider
	// Skip rendering. Useful for testing.
	SkipRender bool

	// This is a partial re-render of some selected pages. This means
	// we should skip most of the processing.
	PartialReRender bool

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

	// Recently visited URLs. This is used for partial re-rendering.
	RecentlyVisited map[string]bool

	// 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 ConfigSourceDescriptor added in v0.38.1

type ConfigSourceDescriptor struct {
	Fs     afero.Fs
	Logger loggers.Logger

	// Path to the config file to use, e.g. /my/project/config.toml
	Filename string

	// The path to the directory to look for configuration. Is used if Filename is not
	// set or if it is set to a relative filename.
	Path string

	// The project's working dir. Is used to look for additional theme config.
	WorkingDir string

	// The (optional) directory for additional configuration files.
	AbsConfigDir string

	// production, development
	Environment string

	// Defaults to os.Environ if not set.
	Environ []string

ConfigSourceDescriptor describes where to find the config (e.g. config.toml etc.).

type ContentFactory added in v0.89.0

type ContentFactory struct {
	// contains filtered or unexported fields

ContentFactory creates content files from archetype templates.

func NewContentFactory added in v0.89.0

func NewContentFactory(h *HugoSites) ContentFactory

NewContentFactory creates a new ContentFactory for h.

func (ContentFactory) ApplyArchetypeFilename added in v0.95.0

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

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

func (ContentFactory) ApplyArchetypeTemplate added in v0.95.0

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 added in v0.89.0

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

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

func (ContentFactory) SectionFromFilename added in v0.89.0

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

type HugoSites

type HugoSites struct {
	Sites []*Site


	// Keeps track of bundle directories and symlinks to enable partial rebuilding.
	ContentChanges *contentChangeMap
	// contains filtered or unexported fields

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

func NewHugoSites added in v0.20.1

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) Data added in v0.55.0

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

func (HugoSites) Done added in v0.55.0

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

func (HugoSites) FatalError added in v0.55.0

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 added in v0.32.1

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 added in v0.25.1

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) IncrContentRender added in v0.63.0

func (h HugoSites) IncrContentRender()

func (HugoSites) IncrPageRender added in v0.92.2

func (h HugoSites) IncrPageRender()

func (*HugoSites) IsMultihost added in v0.31.1

func (h *HugoSites) IsMultihost() bool

func (*HugoSites) LanguageSet added in v0.49.1

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

TODO(bep) consolidate

func (*HugoSites) NumLogErrors added in v0.42.1

func (h *HugoSites) NumLogErrors() int

func (*HugoSites) Pages

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

Pages returns all pages for all sites.

func (*HugoSites) PrintProcessingStats added in v0.32.1

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

func (*HugoSites) ShouldSkipFileChangeEvent added in v0.78.0

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

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

type IntegrationTestBuilder added in v0.92.2

type IntegrationTestBuilder struct {

	H *HugoSites

	Cfg IntegrationTestConfig
	// 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 added in v0.92.2

func NewIntegrationTestBuilder(conf IntegrationTestConfig) *IntegrationTestBuilder

func (*IntegrationTestBuilder) AddFiles added in v0.92.2

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

func (*IntegrationTestBuilder) AssertBuildCountData added in v0.92.2

func (s *IntegrationTestBuilder) AssertBuildCountData(count int)

func (*IntegrationTestBuilder) AssertBuildCountGitInfo added in v0.92.2

func (s *IntegrationTestBuilder) AssertBuildCountGitInfo(count int)

func (*IntegrationTestBuilder) AssertBuildCountLayouts added in v0.92.2

func (s *IntegrationTestBuilder) AssertBuildCountLayouts(count int)

func (*IntegrationTestBuilder) AssertBuildCountTranslations added in v0.92.2

func (s *IntegrationTestBuilder) AssertBuildCountTranslations(count int)

func (*IntegrationTestBuilder) AssertDestinationExists added in v0.92.2

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

func (*IntegrationTestBuilder) AssertFileContent added in v0.92.2

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

func (*IntegrationTestBuilder) AssertFileContentExact added in v0.94.1

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

func (*IntegrationTestBuilder) AssertIsFileError added in v0.92.2

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

func (*IntegrationTestBuilder) AssertLogContains added in v0.92.2

func (s *IntegrationTestBuilder) AssertLogContains(text string)

func (*IntegrationTestBuilder) AssertLogMatches added in v0.96.0

func (s *IntegrationTestBuilder) AssertLogMatches(expression string)

func (*IntegrationTestBuilder) AssertRenderCountContent added in v0.92.2

func (s *IntegrationTestBuilder) AssertRenderCountContent(count int)

func (*IntegrationTestBuilder) AssertRenderCountPage added in v0.92.2

func (s *IntegrationTestBuilder) AssertRenderCountPage(count int)

func (*IntegrationTestBuilder) Build added in v0.92.2

func (*IntegrationTestBuilder) BuildE added in v0.92.2

func (*IntegrationTestBuilder) EditFileReplace added in v0.92.2

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

func (*IntegrationTestBuilder) EditFiles added in v0.92.2

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

func (*IntegrationTestBuilder) FileContent added in v0.92.2

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

func (*IntegrationTestBuilder) RemoveFiles added in v0.92.2

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

func (*IntegrationTestBuilder) RenameFile added in v0.92.2

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

type IntegrationTestConfig added in v0.92.2

type IntegrationTestConfig struct {
	T testing.TB

	// The files to use on txtar format, see
	TxtarString string

	// Whether to simulate server mode.
	Running bool

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

	LogLevel jww.Threshold

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

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

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

	WorkingDir string

type IntegrationTestDebugConfig added in v0.92.2

type IntegrationTestDebugConfig struct {
	Out io.Writer

	PrintDestinationFs bool
	PrintPagemap       bool

	PrefixDestinationFs string
	PrefixPagemap       string

type Multilingual

type Multilingual struct {
	Languages langs.Languages

	DefaultLang *langs.Language
	// contains filtered or unexported fields

Multilingual manages the all languages used in a multilingual site.

func (*Multilingual) Language

func (ml *Multilingual) Language(lang string) *langs.Language

Language returns the Language associated with the given string.

type OrderedTaxonomy

type OrderedTaxonomy []OrderedTaxonomyEntry

OrderedTaxonomy is another representation of an Taxonomy using an array rather than a map. Important because you can't order a map.

func (OrderedTaxonomy) Reverse

func (t OrderedTaxonomy) Reverse() OrderedTaxonomy

Reverse reverses the order of the entries in this taxonomy.

type OrderedTaxonomyEntry

type OrderedTaxonomyEntry struct {
	Name string

OrderedTaxonomyEntry is similar to an element of a Taxonomy, but with the key embedded (as name) e.g: {Name: Technology, page.WeightedPages: TaxonomyPages}

func (OrderedTaxonomyEntry) Count

func (ie OrderedTaxonomyEntry) Count() int

Count returns the count the pages in this taxonomy.

func (OrderedTaxonomyEntry) Pages

func (ie OrderedTaxonomyEntry) Pages() page.Pages

Pages returns the Pages for this taxonomy.

func (OrderedTaxonomyEntry) Term

func (ie OrderedTaxonomyEntry) Term() string

Term returns the name given to this taxonomy.

type PageCollections

type PageCollections struct {
	// contains filtered or unexported fields

PageCollections contains the page collections for a site.

func (*PageCollections) AllPages

func (c *PageCollections) AllPages() page.Pages

AllPages returns all pages for all languages.

func (*PageCollections) AllRegularPages

func (c *PageCollections) AllRegularPages() page.Pages

AllPages returns all regular pages for all languages.

func (*PageCollections) Pages

func (c *PageCollections) Pages() page.Pages

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

func (*PageCollections) RegularPages

func (c *PageCollections) RegularPages() page.Pages

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

type Permalinker added in v0.20.1

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 added in v0.100.0

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

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

func (*ShortcodeWithPage) Position added in v0.54.0

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.

func (*ShortcodeWithPage) Site

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

Site returns information about the current site.

type Site

type Site struct {

	Sections Taxonomy
	Info     *SiteInfo

	// Logger etc.
	*deps.Deps `json:"-"`
	// contains filtered or unexported fields

Site contains all the information relevant for constructing a static site. The basic flow of information is as follows:

1. A list of Files is parsed and then converted into Pages.

  1. Pages contain sections (based on the file they were generated from), aliases and slugs (included in a pages frontmatter) which are the various targets that will get generated. There will be canonical listing. The canonical path can be overruled based on a pattern.
  1. Taxonomies are created via configuration and will present some aspect of the final page and typically a perm url.
  1. All Pages are passed through a template based on their desired layout based on numerous different elements.

5. The entire collection of files is written to disk.

func NewEnglishSite added in v0.20.1

func NewEnglishSite(withTemplate ...func(templ tpl.TemplateManager) error) (*Site, error)

NewEnglishSite creates a new site in English language. The site will have a template system loaded and ready to use. Note: This is mainly used in single site tests. TODO(bep) test refactor -- remove

func NewSite added in v0.20.1

func NewSite(cfg deps.DepsCfg) (*Site, error)

NewSite creates a new site with the given dependency configuration. The site will have a template system loaded and ready to use. Note: This is mainly used in single site tests.

func NewSiteDefaultLang added in v0.20.1

func NewSiteDefaultLang(withTemplate ...func(templ tpl.TemplateManager) error) (*Site, error)

NewSiteDefaultLang creates a new site in the default language. The site will have a template system loaded and ready to use. Note: This is mainly used in single site tests. TODO(bep) test refactor -- remove

func NewSiteForCfg added in v0.20.1

func NewSiteForCfg(cfg deps.DepsCfg) (*Site, error)

NewSiteForCfg creates a new site for the given configuration. The site will have a template system loaded and ready to use. Note: This is mainly used in single site tests.

func (*Site) GetRelatedDocsHandler added in v0.55.0

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

func (*Site) Initialise

func (s *Site) Initialise() (err error)

func (*Site) Language

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

func (*Site) Menus

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

func (*Site) RegisterMediaTypes added in v0.20.1

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) Taxonomies

func (s *Site) Taxonomies() TaxonomyList

type SiteConfig added in v0.42.1

type SiteConfig struct {
	// This contains all privacy related settings that can be used to
	// make the YouTube template etc. GDPR compliant.
	Privacy privacy.Config

	// Services contains config for services such as Google Analytics etc.
	Services services.Config

SiteConfig represents the config in .Site.Config.

type SiteInfo

type SiteInfo struct {
	Authors page.AuthorList
	Social  SiteSocial

	RSSLink      string
	Author       map[string]any
	LanguageCode string
	Copyright    string

	LanguagePrefix string
	Languages      langs.Languages

	BuildDrafts bool
	// contains filtered or unexported fields

func (*SiteInfo) AllPages added in v0.55.0

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

func (*SiteInfo) AllRegularPages added in v0.55.0

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

func (*SiteInfo) BaseURL

func (s *SiteInfo) BaseURL() template.URL

func (*SiteInfo) Config added in v0.42.1

func (s *SiteInfo) Config() SiteConfig

func (*SiteInfo) Current added in v0.97.0

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

Current returns the currently rendered Site. If that isn't set yet, which is the situation before we start rendering, if will return the Site itself.

func (*SiteInfo) Data

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

func (*SiteInfo) DisqusShortname

func (s *SiteInfo) DisqusShortname() string

DisqusShortname is kept here for historic reasons.

func (*SiteInfo) GetPage

func (s *SiteInfo) 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 (*SiteInfo) GetPageWithTemplateInfo added in v0.75.0

func (s *SiteInfo) GetPageWithTemplateInfo(info tpl.Info, ref ...string) (page.Page, error)

func (*SiteInfo) GoogleAnalytics

func (s *SiteInfo) GoogleAnalytics() string

GoogleAnalytics is kept here for historic reasons.

func (*SiteInfo) Home added in v0.22.1

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

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

func (*SiteInfo) HomeAbsURL

func (s *SiteInfo) HomeAbsURL() string

HomeAbsURL is a convenience method giving the absolute URL to the home page.

func (*SiteInfo) Hugo

func (s *SiteInfo) Hugo() hugo.Info

func (*SiteInfo) IsMultiLingual

func (s *SiteInfo) IsMultiLingual() bool

func (*SiteInfo) IsServer added in v0.38.1

func (s *SiteInfo) IsServer() bool

func (*SiteInfo) Language

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

func (*SiteInfo) LastChange

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

func (*SiteInfo) Menus

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

func (*SiteInfo) Pages added in v0.55.0

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

func (*SiteInfo) Param

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

Param is a convenience method to do lookups in SiteInfo's Params map.

This method is also implemented on Page.

func (*SiteInfo) Params

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

func (*SiteInfo) RegularPages added in v0.55.0

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

func (*SiteInfo) Sections

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

Sections returns the top level sections.

func (*SiteInfo) ServerPort added in v0.31.1

func (s *SiteInfo) ServerPort() int

ServerPort returns the port part of the BaseURL, 0 if none found.

func (*SiteInfo) Site added in v0.55.0

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

func (*SiteInfo) SitemapAbsURL

func (s *SiteInfo) SitemapAbsURL() string

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

func (*SiteInfo) Sites added in v0.54.0

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

Sites is a convenience method to get all the Hugo sites/languages configured.

func (*SiteInfo) String

func (s *SiteInfo) String() string

func (*SiteInfo) Taxonomies

func (s *SiteInfo) Taxonomies() any

TODO(bep) type

func (*SiteInfo) Title

func (s *SiteInfo) Title() string

type SiteSocial

type SiteSocial map[string]string

SiteSocial is a place to put social details on a site level. These are the standard keys that themes will expect to have available, but can be expanded to any others on a per site basis github facebook facebook_admin twitter twitter_domain pinterest instagram youtube linkedin

type Taxonomy

type Taxonomy map[string]page.WeightedPages

A Taxonomy is a map of keywords to a list of pages. For example

TagTaxonomy['technology'] = page.WeightedPages
TagTaxonomy['go']  =  page.WeightedPages

func (Taxonomy) Alphabetical

func (i Taxonomy) Alphabetical() OrderedTaxonomy

Alphabetical returns an ordered taxonomy sorted by key name.

func (Taxonomy) ByCount

func (i Taxonomy) ByCount() OrderedTaxonomy

ByCount returns an ordered taxonomy sorted by # of pages per key. If taxonomies have the same # of pages, sort them alphabetical

func (Taxonomy) Count

func (i Taxonomy) Count(key string) int

Count the weighted pages for the given key.

func (Taxonomy) Get

func (i Taxonomy) Get(key string) page.WeightedPages

Get the weighted pages for the given key.

func (Taxonomy) TaxonomyArray

func (i Taxonomy) TaxonomyArray() OrderedTaxonomy

TaxonomyArray returns an ordered taxonomy with a non defined order.

type TaxonomyList

type TaxonomyList map[string]Taxonomy

The TaxonomyList is a list of all taxonomies and their values e.g. List['tags'] => TagTaxonomy (from above)

func (TaxonomyList) String

func (tl TaxonomyList) String() string


Path Synopsis
Package filesystems provides the fine grained file systems used by Hugo.
Package filesystems provides the fine grained file systems used by Hugo.

Jump to

Keyboard shortcuts

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