mirror of
https://github.com/gohugoio/hugo.git
synced 2024-11-14 20:37:55 -05:00
32ba623541
4c81c6c2a live reload: add section about `--navigateToChanged` 271014257 Update netify hugo version to 0.83.1 14199cff1 Add pull_request event 0c33b05de Hosting on GitHub: Little wording fixes and update Ubuntu runner in example workflow to 20.04 (#1457) e47b6c33a Hugo Modules plural typo (#1266) 0f2bbacdd Add node_modules to .gitignore 1d645d79f Overhaul scratch.md (#1451) 572766889 Add link to golang regex syntax, change modified date 21b0c7459 Add info about contentType config de7d96fa2 Document Go template's multiline support 0c8f2dcb1 Avoid scratch usage 696fa92e1 Rename scratch var 44193f267 Update usage instructions 4230f8fa5 Rename and refactor shortcode e9953751e Strip leading whitespaces d61a58010 Add `insertpages` shortcode 04d30677d Mention WebP under 'Target Format' (#1431) 946784508 Update lookup-order.md (#1443) a7b587988 Update index.md 27907f7ea netlify: Hugo 0.83.1 044d37e57 Merge branch 'tempv0.83.1' b81aedb03 Fix page `.Kind` fcf7775ad releaser: Add release notes to /docs for release of 0.83.1 9b39c77c8 fix typo in 0.83 release notes 1c38993ce Update index.md 45b8aefa6 Update index.md 43902dfaa Update index.md 3d959c7ae Merge branch 'tempv0.83.0' 6c22dc327 Fix URL 497ea3224 Use Hugo version badge shortcode a182d10dd releaser: Add release notes to /docs for release of 0.83.0 287fd9ac0 docs: Fix shortcode e789c879a docs: Regenerate docs helper 1666c7f31 docs: Regenerate CLI docs 117de1d12 Merge commit 'c239c643fee10bfa217cb108755b798f8f5f3b10' a6bf3f7d9 docs: Regen docs helper git-subtree-dir: docs git-subtree-split: 4c81c6c2ace6c23d0d5d24ee37e6a2f30acba01e
4.9 KiB
4.9 KiB
| 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 |
|
|
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.
Get the Site object from a partial
All the methods below, e.g. .Site.RegularPages can also be reached via the global site function, e.g. site.RegularPages, which can be handy in partials where the Page object isn't easily available. {{< new-in "0.53" >}}.
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.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 serverfor 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. See
.Site.Pages. - .Site.RegularPages
- a shortcut to the regular page collection.
.Site.RegularPagesis equivalent towhere .Site.Pages "Kind" "page". See.Site.Pages. - .Site.Sections
- top-level directories of the site.
- .Site.Taxonomies
- the taxonomies for the entire site. Also see section Use
.Site.TaxonomiesOutside of Taxonomy Templates. - .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
{{< getcontent path="readfiles/pages-vs-site-pages.md" >}}