mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
2c0d1ccdcd
73f355ce Update theme 83ff50c2 Use example.com in examples 71292134 Add alias news > release-notes 2e15f642 Update theme 8eef09d2 Add Pygments configuration 572b9e75 Clean up the code shortcode use a1b2fd3b Remove the code fence language codes 1473b1d9 Remove redundant text b92c2042 Update theme 8f439c28 Edit contributing section in README 8bcf8a19 Add contributing section to README 4c44ee1c Fix broken content file 2bdc7710 Clarify .Data.Pages sorting in lists.md 092271c2 Use infinitive mood for main titles b9b8abef Update theme to reflect change to home page content b897b71b Change copy to use sentence case fd675ee5 Enable RSS feed for sections 060a5e27 Correct movie title in taxonomies.md 6a5ca96a Update displayed site name for Hub 22f4b7a4 Add example of starting up the local server d9612cb3 Update theme a8c3988a Update theme 4198189d Update theme 12d6b016 Update theme 2b1c4197 Update theme b6d90a1e Fix News release titles cfe751db Add some build info to README git-subtree-dir: docs git-subtree-split: 73f355ce0dd88d032062ea70067431ab980cdd8d
4.3 KiB
4.3 KiB
| title | linktitle | description | date | publishdate | lastmod | categories | 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 |
|
false |
|
10 | 10 |
|
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.IsMultiLingual- whether there are more than one language in this site. See Multilingual 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.Languageslist. .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
datevariable 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.
.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.RegularPagesis equivalent towhere .Site.Pages "Kind" "page". .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.Indexessince 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.toml defines a site-wide param for description:
baseURL = "http://yoursite.example.com/"
[params]
description = "Tesla's Awesome Hugo Site"
author = "Nikola Tesla"
You can use .Site.Params in a partial template to call the default site description:
{{< code file="layouts/partials/head.html" >}}
{{< /code >}}