HUGO
News Docs Themes Community GitHub

AllPages

SITE.AllPages

Returns a collection of all pages in all languages.

BaseURL

SITE.BaseURL

Returns the base URL as defined in the site configuration.

BuildDrafts

SITE.BuildDrafts

Reports whether the current build includes draft pages.

Config

SITE.Config

Returns a subset of the site configuration.

Copyright

SITE.Copyright

Returns the copyright notice as defined in the site configuration.

Data

SITE.Data

Returns a data structure composed from the files in the data directory.

DisqusShortname

SITE.DisqusShortname

Returns the Disqus shortname as defined in the site configuration.

GetPage

SITE.GetPage PATH

Returns a Page object from the given path.

GoogleAnalytics

SITE.GoogleAnalytics

Returns the Google Analytics tracking ID as defined in the site configuration.

Home

SITE.Home

Returns the home Page object for the given site.

IsDevelopment

SITE.IsDevelopment

Reports whether the current running environment is “development”.

IsMultiLingual

SITE.IsMultiLingual

Reports whether there are two or more configured languages.

IsServer

SITE.IsServer

Reports whether the built-in development server is running.

Language

SITE.Language

Returns the language object for the given site.

LanguagePrefix

SITE.LanguagePrefix

Returns the URL language prefix, if any, for the given site.

Languages

SITE.Languages

Returns a collection of language objects for all sites, ordered by language weight.

LastChange

SITE.LastChange

Returns the last modification date of site content.

Lastmod

SITE.Lastmod

Returns the last modification date of site content.

MainSections

SITE.MainSections

Returns a slice of the main section names as defined in the site configuration, falling back to the top level section with the most pages.

Menus

SITE.Menus

Returns a collection of menu objects for the given site.

Pages

SITE.Pages

Returns a collection of all pages.

Param

SITE.Param KEY

Returns the site parameter with the given key.

Params

SITE.Params

Returns a map of custom parameters as defined in the site configuration.

RegularPages

SITE.RegularPages

Returns a collection of all regular pages.

Sections

SITE.Sections

Returns a collection of first level section pages.

Sites

SITE.Sites

Returns a collection of all Site objects, one for each language, ordered by default content language then by language weight.

Store

site.Store

Returns a "scratch pad" to store and manipulate data, scoped to the current site.

Taxonomies

SITE.Taxonomies

Returns a data structure containing the site's Taxonomy objects, the terms within each Taxonomy object, and the pages to which the terms are assigned.

Title

SITE.Title

Returns the title as defined in the site configuration.