hugo/content/en/variables/site.md at a3535c8486b2ce762b1a8a9c30b03985c3e02cee

mirror of https://github.com/gohugoio/hugo.git synced 2024-11-14 20:37:55 -05:00

Bjørn Erik Pedersen 83bef6955e Squashed 'docs/' changes from 896bad9f4..e161ea09d

e161ea09d Add one more Chinese file to workaround reflect: Zero(nil)
b595b3a21 Add more Chinese translation
56e4e95d9 Use lang.Merge to "fill in the gaps" for untranslated pages
ef079406c Merge commit '650fac3a4e7d256f4505402ab44cfc3c804b8dea'
650fac3a4 Squashed 'themes/gohugoioTheme/' changes from a1768ebb..f31a3dc8
322eff899 Add Chinese language for menus
d90b886e0 Fix Markdown table syntax in previous commit
737f3dfca Update the leaf bundle vs branch bundle table
09fa1bc4e Clarify that `.Now` is obsolete
879ea3f6a Make release notes somewhat more consistent
0113e2051 Move 0.40.2-relnotes into content/en/news
77578f5bf Move content/ into new contentDir content/en/
4dcf7c709 Fix "reflect: Zero(nil)" error in showcase
63dd25505 Release 0.40.2
2076c0d56 releaser: Prepare repository for 0.41-DEV
070fe565e releaser: Add release notes to /docs for release of 0.40.2
4ce52e913 releaser: Bump versions for release of 0.40.2
41907c487 Fix typos in syntax-highlighting.md
91753ef3d Add missing backtick
b77274301 Remove duplicate release notes (0.27, 0.27.1, 0.35)
6e00da316 Remove obsolete content/release-notes/ directory
00a6d8c02 Change en dash back to `--` in 0.38.2-relnotes
51b32dc00 Update archetypes.md
d0e5c2307 Release 0.40.1
4538a6d5b releaser: Prepare repository for 0.41-DEV
91b391d70 releaser: Add release notes to /docs for release of 0.40.1
e0979d143 releaser: Bump versions for release of 0.40.1
7983967c2 Clean images
fe3fdd77d Polish showcase for Flesland Flis
e6dde3989 Showcase - Flesland Flis AS by Absoluttweb
73aa62290 Revive @spf13's special Hugo font
add67b335 Release Hugo 0.40
c0a26e5a6 Merge branch 'temp40'
beeabaaae releaser: Prepare repository for 0.41-DEV
e67d5e985 releaser: Add release notes to /docs for release of 0.40
6cdd95273 releaser: Bump versions for release of 0.40
bee21fb9b Revive the other Hugo logos too
4f45e8fe1 Fix the link type attribute for RSS in examples
8c67dc89a Fix example in delimit doc
e7f6c00d5 Revive the logo used on the forum
82b0cd26e Merge commit 'a215abf70e018f4bf40d6c09d8bd148d8684b33d'
119c8ca58 Merge commit 'd2ec1a06df8ab6b17ad05cb008d5701b40327d47'
db4683bd2 Improve .Get docs
05260b886 .Get function: fix syntax signature

git-subtree-dir: docs
git-subtree-split: e161ea09d33e3199f4998e4d2e9068d5a850f042

2018-05-04 09:44:21 +02:00

4.5 KiB

Raw Blame History

title

linktitle

description

date

publishdate

lastmod

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.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.
.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".
.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:

4.5 KiB Raw Blame History

Site Variables List

The .Site.Params Variable

Example: .Site.Params

4.5 KiB

Raw Blame History

The `.Site.Params` Variable

Example: `.Site.Params`