mirror of
https://github.com/gohugoio/hugo.git
synced 2025-02-14 04:52:48 +00:00
f3cd083961
fc61378a3 Add Hugo 0.32 related docs 77edf7fd7 commands: Regenerate af9d25458 Fix Blackfriday's Markdown extension name 1223dd63a Remove roadmap b8bcb2fb8 Include note to allow hugo write permissions outside home dir 7dbccb936 Fix typo in roadmap 3a38da6f5 Fix spelling 94ebe50ff Merge branch 'master' of github.com:gohugoio/hugoDocs 89376e21d Clarify Hugo Roadmap 03d191fec Mention Reverse function in taxonomy tpl page. a4ea3402d Fix ref and relref function pages. b36632b31 Remove non-existing source variable a638160dc Update Content Organization to match the world 47eb431ca Correct one link in templates/output-formats.md 8bf933629 Spell fix ce2d48728 Add docs for .AllTranslations de94b4942 Move sponsor data to theme data 41fe75254 Merge commit 'f463ef99ed2862e4042557e28aece7ca858e1d0a' f463ef99e Squashed 'themes/gohugoioTheme/' changes from bc851da9..75da2f6b 532c65f2a Move sponsor logo to theme 899e2defe Add sponsor logos to home page and footer 3ca53db97 Release 0.31.1 bb9876ce2 Merge branch 'temp0311' c7c3ee7e5 releaser: Prepare repository for 0.32-DEV 4ac554792 releaser: Add release notes to /docs for release of 0.31.1 52bfb5c15 releaser: Bump versions for release of 0.31.1 cfdc2e4ea Fix output formats example 5746c10c2 More on output format de2ee0fe0 Improve suffix redefinition example c9997839e Update gitlab CI submodule management 82d74e306 Add Bootstrap styling to breadcrumb example c8c9601a8 Use the code shortcode for the breadcrumb example 16be43e7d Clean up formatting in variable definition lists 149c2c157 Add nested section docs 783c3d636 Sync theme 60a220bbd Squashed 'themes/gohugoioTheme/' changes from 6b632895..bc851da9 4b33a04d0 Fix typo 94cffc43c Fix little typo a5d4f762f Fix typo 36c5a0b43 Add a note about the 2 in staticDir2 087bd9a9f Add KeyCDN to menu 4ac8aae38 Hugo 0.31 Released 8fdd995e7 releaser: Prepare repository for 0.32-DEV eb0f38fbb releaser: Add release notes to /docs for release of 0.31 60efdfff7 releaser: Bump versions for release of 0.31 44dafb10b Merge commit '30c0d485eaff6d70df1be0353911ddca485d52bf' e6b847b95 Merge commit '05e42bc643f1840ed2ad9c2eff82a269d1381683' 15d86a525 Handle Taxonomy permalinks 5c3c18d7f Add support for height argument to figure shortcode git-subtree-dir: docs git-subtree-split: fc61378a3227c14883a2942d67c806014e7bb6cb
125 lines
No EOL
4.3 KiB
Markdown
125 lines
No EOL
4.3 KiB
Markdown
---
|
|
title: Site Variables
|
|
linktitle: Site Variables
|
|
description: 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.
|
|
date: 2017-02-01
|
|
publishdate: 2017-02-01
|
|
lastmod: 2017-02-01
|
|
categories: [variables and params]
|
|
keywords: [global,site]
|
|
draft: false
|
|
menu:
|
|
docs:
|
|
parent: "variables"
|
|
weight: 10
|
|
weight: 10
|
|
sections_weight: 10
|
|
aliases: [/variables/site-variables/]
|
|
toc: true
|
|
---
|
|
|
|
The following is a list of site-level (aka "global") variables. Many of these variables are defined in your site's [configuration file][config], 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](/templates/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](/content-management/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.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](/functions/abslangurl/) and [relLangURL](/functions/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](/content-management/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](/content-management/urls/) 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"`.
|
|
|
|
.Site.RSSLink
|
|
: the URL for the site RSS.
|
|
|
|
.Site.Sections
|
|
: top-level directories of the site.
|
|
|
|
.Site.Taxonomies
|
|
: the [taxonomies](/taxonomies/usage/) for the entire site. Replaces the now-obsolete `.Site.Indexes` since v0.11. Also see section [Taxonomies elsewhere](#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 = "https://yoursite.example.com/"
|
|
|
|
[params]
|
|
description = "Tesla's Awesome Hugo Site"
|
|
author = "Nikola Tesla"
|
|
```
|
|
|
|
You can use `.Site.Params` in a [partial template](/templates/partials/) to call the default site description:
|
|
|
|
{{< code file="layouts/partials/head.html" >}}
|
|
<meta name="description" content="{{if .IsHome}}{{ $.Site.Params.description }}{{else}}{{.Description}}{{end}}" />
|
|
{{< /code >}}
|
|
|
|
[config]: /getting-started/configuration/ |