github/hugo
1
0
Fork 0
mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00
Code Issues Projects Releases Packages Wiki Activity
hugo/content/en/variables/site.md
Bjørn Erik Pedersen 766085c2dc Squashed 'docs/' changes from a4fa0d1d6..81847981f 
81847981f Add notes for installing "extended" Sass/SCSS version
02da3bb58 Include usage of disqus internal template
9b53380c4 Update sitemap-template.md
f3417dd52 Update sitemap-template.md
aae33d9a8 Update sitemap-template.md
834edc205 Release 0.45.1
fb93ab905 Merge branch 'temp451'
79f350906 releaser: Prepare repository for 0.46-DEV
25cd2352c releaser: Add release notes to /docs for release of 0.45.1
e60377c71 releaser: Bump versions for release of 0.45.1
873f6dce2 Update features.md
ecc116642 Update link for Azure
cb88c3185 Added .Site.Home to Site Variiables (#541)
975a88791 Document includePaths
56c4e332f Release Hugo 0.45
c22b25210 Merge branch 'temp45'
0ffad3ada releaser: Prepare repository for 0.46-DEV
08d494cc3 releaser: Add release notes to /docs for release of 0.45
ad546ba45 releaser: Bump versions for release of 0.45
971c46bb2 Fixed "Sratch" to become "Scratch" on line 44
a28255bf3 Clarify the meaning of .Pages vs .Site.Pages
127aeee09 docs: Update ref, relref, GetPage docs
350d674ec resources.Concat doesn't have an alias
1fd1219b0 docs: Document refLinksErrorLevel and refLinksNotFoundURL
af2252ff6 Merge commit 'a3535c8486b2ce762b1a8a9c30b03985c3e02cee'
a11486805 Merge commit 'b6b37a1f00f808f3c0d2715f65ca2d3091f36495'
1c8896cb1 Fix addkit link to account for i18n
468aef3fc releaser: Prepare repository for 0.45-DEV
c6f4b97a2 releaser: Add release notes to /docs for release of 0.44
d3985afb7 releaser: Bump versions for release of 0.44
2c59a330c Adjust release notes
83966769a releaser: Prepare repository for 0.44-DEV
e539613f7 releaser: Add release notes to /docs for release of 0.43
2bf648944 releaser: Bump versions for release of 0.43
d9d6e4bf7 Fix typos
d6798afda Merge commit '98293eaa1570b5aff4452021c8b6d6c8560b3f06'
37cc52261 Add a newScratch template func
1f7f09613 Merge branch 'release-0.42.2'
857b0b26a releaser: Prepare repository for 0.43-DEV

git-subtree-dir: docs
git-subtree-split: 81847981f1f2cb1ebc83d42d275a2afb2bb22df1
2018-08-01 10:01:05 +02:00

4.8 KiB
Raw Blame History

title linktitle description date publishdate lastmod categories keywords draft menu weight sections_weight aliases toc
Site Variables Site Variables Many, but not all, site-wide variables are defined in your site's configuration. However, Hugo provides a number of built-in variables for convenient access to global values in your templates. 2017-02-01 2017-02-01 2017-02-01
variables and params
global
site
false
docs
parent weight
variables 10
10 10
/variables/site-variables/
true

The following is a list of site-level (aka "global") variables. Many of these variables are defined in your site's configuration file, whereas others are built into Hugo's core for convenient usage in your templates.

Site Variables List

.Site.AllPages
array of all pages, regardless of their translation.
.Site.Author
a map of the authors as defined in the site configuration.
.Site.BaseURL
the base URL for the site as defined in the site configuration.
.Site.BuildDrafts
a boolean (default: false) to indicate whether to build drafts as defined in the site configuration.
.Site.Copyright
a string representing the copyright of your website as defined in the site configuration.
.Site.Data
custom data, see Data Templates.
.Site.DisqusShortname
a string representing the shortname of the Disqus shortcode as defined in the site configuration.
.Site.Files
all source files for the Hugo website.
.Site.GoogleAnalytics
a string representing your tracking code for Google Analytics as defined in the site configuration.
.Site.Home
reference to the homepage's page object
.Site.IsMultiLingual
whether there are more than one language in this site. See Multilingual for more information.
.Site.IsServer
a boolean to indicate if the site is being served with Hugo's built-in server. See hugo server for more information.
.Site.Language.Lang
the language code of the current locale (e.g., en).
.Site.Language.LanguageName
the full language name (e.g. English).
.Site.Language.Weight
the weight that defines the order in the .Site.Languages list.
.Site.Language
indicates the language currently being used to render the website. This object's attributes are set in site configurations' language definition.
.Site.LanguageCode
a string representing the language as defined in the site configuration. This is mostly used to populate the RSS feeds with the right language code.
.Site.LanguagePrefix
this can be used to prefix URLs to point to the correct language. It will even work when only one defined language. See also the functions absLangURL and relLangURL.
.Site.Languages
an ordered list (ordered by defined weight) of languages.
.Site.LastChange
a string representing the date/time of the most recent change to your site. This string is based on the date variable in the front matter of your content pages.
.Site.Menus
all of the menus in the site.
.Site.Pages
array of all content ordered by Date with the newest first. This array contains only the pages in the current language. See .Site.Pages.
.Site.Permalinks
a string to override the default permalink format as defined in the site configuration.
.Site.RegularPages
a shortcut to the regular page collection. .Site.RegularPages is equivalent to where .Site.Pages "Kind" "page". See .Site.Pages.
.Site.RSSLink
the URL for the site RSS.
.Site.Sections
top-level directories of the site.
.Site.Taxonomies
the taxonomies for the entire site. Replaces the now-obsolete .Site.Indexes since v0.11. Also see section Taxonomies elsewhere.
.Site.Title
a string representing the title of the site.

The .Site.Params Variable

.Site.Params is a container holding the values from the params section of your site configuration.

Example: .Site.Params

The following config.[yaml|toml|json] defines a site-wide param for description:

{{< code-toggle file="config" >}} baseURL = "https://yoursite.example.com/"

[params] description = "Tesla's Awesome Hugo Site" author = "Nikola Tesla" {{</ code-toggle >}}

You can use .Site.Params in a partial template to call the default site description:

{{< code file="layouts/partials/head.html" >}}

{{< /code >}}

The .Site.Pages Variable

.Site.Pages compared to .Pages

{{< readfile file="/content/en/readfiles/pages-vs-site-pages.md" markdown="true" >}}