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/docs/content/templates/variables.md

210 lines
13 KiB
Markdown
Raw Normal View History

sanity: move from json to yaml
2013-07-06 19:36:30 -04:00
---
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
aliases:
- /doc/variables/
- /layout/variables/
Revert the "standardize author data" There were some breaking changes etc. that is too late to fix for 0.17. Let us think this through and add proper author support for Hugo 0.18. Fixes #2464 Revert "docs: Add documentation for author profiles" This reverts commit b6673e5309685ae162fdef2dc39c3ce4385c6005. Revert "Add First Class Author Support" This reverts commit cf978c06496d99e76b08418422dda5797d90fed6.
2016-09-18 13:10:11 -04:00
lastmod: 2015-12-08
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
date: 2013-07-01
linktitle: Variables
Implementing new menu system in the docs site
2014-04-23 03:00:11 -04:00
menu:
main:
Converting front matter to YAML
2014-05-29 18:42:05 -04:00
parent: layout
next: /templates/content
prev: /templates/functions
title: Template Variables
weight: 20
docs: add ToC to some more pages
2015-05-22 14:46:09 -04:00
toc: true
YAML support similar to jekyll (start and end with '---')
2013-07-08 17:57:01 -04:00
---
adding hugo
2013-07-04 11:32:55 -04:00
Hugo makes a set of values available to the templates. Go templates are context based. The following
are available in the context for the templates.
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
## Page Variables
Updating page variable documentation (for templates).
2014-01-21 20:05:26 -05:00
The following is a list of most of the accessible variables which can be
defined for a piece of content. Many of these will be defined in the front
matter, content or derived from file location.
Add doc for Scratch
2015-01-31 15:33:34 -05:00
**See also:** [Scratch](/extras/scratch) for page-scoped writable variables.
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Title** The title for the content.<br>
**.Content** The content itself, defined below the front matter.<br>
[Docs] Correct description of "Read More" links in Summaries Also revise some paragraphs for succinctness. Fixes #788
2015-01-20 17:45:57 -05:00
**.Summary** A generated summary of the content for easily showing a snippet in a summary view. Note that the breakpoint can be set manually by inserting <code>&lt;!&#x2d;&#x2d;more&#x2d;&#x2d;&gt;</code> at the appropriate place in the content page. See [Summaries](/content/summaries/) for more details.<br>
**.Truncated** A boolean, `true` if the `.Summary` is truncated. Useful for showing a "Read more..." link only if necessary. See [Summaries](/content/summaries/) for more details.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Description** The description for the content.<br>
**.Keywords** The meta keywords for this content.<br>
**.Date** The date the content is associated with.<br>
docs: Document lastmod variable Fixes #1351
2016-03-28 07:44:02 -04:00
**.Lastmod** The date the content was last modified.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.PublishDate** The date the content is published on.<br>
docs: Add ExpiryDate to the list of variables
2016-05-11 10:17:33 -04:00
**.ExpiryDate** The date where the content is scheduled to expire on.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Type** The content [type](/content/types/) (e.g. post).<br>
**.Section** The [section](/content/sections/) this content belongs to.<br>
**.Permalink** The Permanent link for this page.<br>
**.RelPermalink** The Relative permanent link for this page.<br>
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
**.LinkTitle** Access when creating links to this content. Will use `linktitle` if set in front matter, else `title`.<br>
[Docs] Complete the transition from "indexes" to "taxonomies" (almost) Also mention `.Site.Indexes` → `.Site.Taxonomies` as well as the upcoming `.Site.Recent` → `.Site.Pages` transitions.
2015-01-29 14:34:56 -05:00
**.RSSLink** Link to the taxonomies' RSS link.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.TableOfContents** The rendered table of contents for this content.<br>
**.Prev** Pointer to the previous content (based on pub date).<br>
**.Next** Pointer to the following content (based on pub date).<br>
docs: Add an example of how to use .PrevInSection It's not a common knowledge what the "pointer" is so let's add an example of how to use .PrevInSection
2016-05-18 03:43:30 -04:00
**.PrevInSection** Pointer to the previous content within the same section (based on pub date). For example, `{{if .PrevInSection}}{{.PrevInSection.Permalink}}{{end}}`.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.NextInSection** Pointer to the following content within the same section (based on pub date)<br>
**.FuzzyWordCount** The approximate number of words in the content.<br>
**.WordCount** The number of words in the content.<br>
**.ReadingTime** The estimated time it takes to read the content in minutes.<br>
**.Weight** Assigned weight (in the front matter) to this content, used in sorting.<br>
Document Page.RawContent in templates/variables/
2015-07-02 11:58:38 -04:00
**.RawContent** Raw Markdown content without the metadata header. Useful with [remarkjs.com](http://remarkjs.com)<br>
docs: Drop .isDraft to new line Bring **.isDraft** onto a new line, to be consistent with the other list items.
2016-07-15 14:38:02 -04:00
**.UniqueID** The MD5-checksum of the page's filename<br>
Add Draft page variable to docs Also tweaks language used in page params sentence.
2015-11-28 14:26:01 -05:00
**.Draft** A boolean, `true` if the content is marked as a draft in the front matter.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.IsNode** Always false for pages.<br>
**.IsPage** Always true for page.<br>
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br>
**.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Translations** A list of translated versions of the current page. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info. Note that the `Translation` variable is also available on node, e.g. home page etc. <br>
docs: Fix spelling: HasTranslations > IsTranslated
2016-08-12 03:39:13 -04:00
**.IsTranslated** Whether there are any translations to display.<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Lang** Language taken from the language extension notation. <br>
adding hugo
2013-07-04 11:32:55 -04:00
Updating page variable documentation (for templates).
2014-01-21 20:05:26 -05:00
## Page Params
[Docs] Complete the transition from "indexes" to "taxonomies" (almost) Also mention `.Site.Indexes` → `.Site.Taxonomies` as well as the upcoming `.Site.Recent` → `.Site.Pages` transitions.
2015-01-29 14:34:56 -05:00
Any other value defined in the front matter, including taxonomies, will be made available under `.Params`.
Add Draft page variable to docs Also tweaks language used in page params sentence.
2015-11-28 14:26:01 -05:00
For example, the *tags* and *categories* taxonomies are accessed with:
adding hugo
2013-07-04 11:32:55 -04:00
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
* **.Params.tags**
* **.Params.categories**
**All Params are only accessible using all lowercase characters.**
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
Expanded the Page Params section in variables.md Expanded on the use of Page Params in the templates/variables.md documentation. Added sample code for something that keeps coming up on discuss.github.io
2016-01-29 17:43:29 -05:00
This is particularly useful for the introduction of user defined fields in content files. For example, a Hugo website on book reviews could have in the front matter of <code>/content/review/book01.md</code>
---
...
Docs: fix some typos in templates/variables.md
2016-01-30 05:12:24 -05:00
affiliatelink: "http://www.my-book-link.here"
Expanded the Page Params section in variables.md Expanded on the use of Page Params in the templates/variables.md documentation. Added sample code for something that keeps coming up on discuss.github.io
2016-01-29 17:43:29 -05:00
recommendedby: "my Mother"
---
Fixed example and cross-reference in content/variables.md Fixed a path in a Page Params example to reflect real directory structure, removed extra quotes from sample code, and fixed link to Archetypes which read "cross-references" before. See #1805
2016-02-01 10:52:47 -05:00
Which would then be accessible to a template at `/themes/yourtheme/layouts/review/single.html` through `.Params.affiliatelink` and `.Params.recommendedby`, respectively. Two common situations where these could be introduced are as a value of a certain attribute (like `href=""` below) or by itself to be displayed. Sample syntaxes include:
Expanded the Page Params section in variables.md Expanded on the use of Page Params in the templates/variables.md documentation. Added sample code for something that keeps coming up on discuss.github.io
2016-01-29 17:43:29 -05:00
Fixed example and cross-reference in content/variables.md Fixed a path in a Page Params example to reflect real directory structure, removed extra quotes from sample code, and fixed link to Archetypes which read "cross-references" before. See #1805
2016-02-01 10:52:47 -05:00
<h3><a href={{ printf "%s" $.Params.affiliatelink }}>Buy this book</a></h3>
Expanded the Page Params section in variables.md Expanded on the use of Page Params in the templates/variables.md documentation. Added sample code for something that keeps coming up on discuss.github.io
2016-01-29 17:43:29 -05:00
<p>It was recommended by {{ .Params.recommendedby }}.</p>
which would render
<h3><a href="http://www.my-book-link.here">Buy this book</a></h3>
<p>It was recommended by my Mother.</p>
Fixed example and cross-reference in content/variables.md Fixed a path in a Page Params example to reflect real directory structure, removed extra quotes from sample code, and fixed link to Archetypes which read "cross-references" before. See #1805
2016-02-01 10:52:47 -05:00
**See also:** [Archetypes]({{% ref "content/archetypes.md" %}}) for consistency of `Params` across pieces of content.
Expanded the Page Params section in variables.md Expanded on the use of Page Params in the templates/variables.md documentation. Added sample code for something that keeps coming up on discuss.github.io
2016-01-29 17:43:29 -05:00
Add Param to the docs See #1462
2015-10-12 00:00:58 -04:00
### Param method
Fix spell mistake in variables.md
2015-10-24 10:28:55 -04:00
In Hugo you can declare params both for the site and the individual page. A common use case is to have a general value for the site and a more specific value for some of the pages (i.e. an image).
Add Param to the docs See #1462
2015-10-12 00:00:58 -04:00
With the `Param` method the most specific value will be selected for you, and it is safe to use it in any template (it's defined on both Page and Node):
```
docs: Fix example for Param method Fixes #2070
2016-04-11 07:26:33 -04:00
$.Param "image"
Add Param to the docs See #1462
2015-10-12 00:00:58 -04:00
```
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
## Node Variables
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
In Hugo, a node is any page not rendered directly by a content file. This
[Docs] Complete the transition from "indexes" to "taxonomies" (almost) Also mention `.Site.Indexes` → `.Site.Taxonomies` as well as the upcoming `.Site.Recent` → `.Site.Pages` transitions.
2015-01-29 14:34:56 -05:00
includes taxonomies, lists and the homepage.
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
Add doc for Scratch
2015-01-31 15:33:34 -05:00
**See also:** [Scratch](/extras/scratch) for global node variables.
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Title** The title for the content.<br>
**.Date** The date the content is published on.<br>
docs: Document lastmod variable Fixes #1351
2016-03-28 07:44:02 -04:00
**.Lastmod** The date the content was last modified.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Permalink** The Permanent link for this node<br>
Update Hugo docs with the initialisms suggested by golint In particular: * .Url → .URL (for node, menu and paginator) * .Site.BaseUrl → .Site.BaseURL * getJson → getJSON * getCsv → getCSV * safeHtml → safeHTML * safeCss → safeCSS * safeUrl → safeURL Continued effort in fixing #959.
2015-03-18 02:44:12 -04:00
**.URL** The relative URL for this node.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Ref(ref)** Returns the permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
**.RelRef(ref)** Returns the relative permalink for `ref`. See [cross-references]({{% ref "extras/crossreferences.md" %}}). Does not handle in-page fragments correctly.<br>
[Docs] Complete the transition from "indexes" to "taxonomies" (almost) Also mention `.Site.Indexes` → `.Site.Taxonomies` as well as the upcoming `.Site.Recent` → `.Site.Pages` transitions.
2015-01-29 14:34:56 -05:00
**.RSSLink** Link to the taxonomies' RSS link.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Data** The data specific to this type of node.<br>
Docs: document Node.IsHome
2015-12-08 15:54:05 -05:00
**.IsHome** True if the node is the site home page.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.IsNode** Always true for nodes.<br>
**.IsPage** Always false for nodes.<br>
[Docs] Copyediting * Add meta author, description and generator tags * Add Hugo version beside the logo and in the footer * Suggest the user to run `go get -u -v` to update dependencies * Requires Go 1.3+ rather than Go 1.1+ * Improve rendering/formatting in some places * Add trailing slash to URLs where appropriate * GitHub redirects all http requests to https, update accordingly
2015-01-27 21:17:09 -05:00
**.Site** See [Site Variables]({{< relref "#site-variables" >}}) below.<br>
**.Hugo** See [Hugo Variables]({{< relref "#hugo-variables" >}}) below.<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Translations** A list of translated versions of the current node. All nodes (except the pager nodes) can have translated counter parts. See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info. <br>
docs: Fix spelling: HasTranslations > IsTranslated
2016-08-12 03:39:13 -04:00
**.IsTranslated** Whether there are any translations to display.<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Lang** The language code of this node.<br>
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
Add multilingual support in Hugo Implements: * support to render: * content/post/whatever.en.md to /en/2015/12/22/whatever/index.html * content/post/whatever.fr.md to /fr/2015/12/22/whatever/index.html * gets enabled when `Multilingual:` is specified in config. * support having language switchers in templates, that know where the translated page is (with .Page.Translations) (when you're on /en/about/, you can have a "Francais" link pointing to /fr/a-propos/) * all translations are in the `.Page.Translations` map, including the current one. * easily tweak themes to support Multilingual mode * renders in a single swift, no need for two config files. Adds a couple of variables useful for multilingual sites Adds documentation (content/multilingual.md) Added language prefixing for all URL generation/permalinking see in the code base. Implements i18n. Leverages the great github.com/nicksnyder/go-i18n lib.. thanks Nick. * Adds "i18n" and "T" template functions..
2016-05-14 00:35:16 -04:00
### Taxonomy Terms Node Variables
Docs: Add taxonomy term variables to the list of vars. Taxonomy Term pages have variables in addition to those on "node" pages. Documenting these variables with all the other node variables makes them easier to find. Fixes: #1155
2015-05-22 13:06:18 -04:00
Revert the "standardize author data" There were some breaking changes etc. that is too late to fix for 0.17. Let us think this through and add proper author support for Hugo 0.18. Fixes #2464 Revert "docs: Add documentation for author profiles" This reverts commit b6673e5309685ae162fdef2dc39c3ce4385c6005. Revert "Add First Class Author Support" This reverts commit cf978c06496d99e76b08418422dda5797d90fed6.
2016-09-18 13:10:11 -04:00
[Taxonomy Terms](/templates/terms/) pages are of the type "node" and have the following additional variables. These are available in `layouts/_defaults/terms.html` for example.
Docs: Add taxonomy term variables to the list of vars. Taxonomy Term pages have variables in addition to those on "node" pages. Documenting these variables with all the other node variables makes them easier to find. Fixes: #1155
2015-05-22 13:06:18 -04:00
Added mention of .Data.Pages, removed duplicate .Site.Pages mention.
2015-08-06 01:21:18 -04:00
**.Data.Singular** The singular name of the taxonomy<br>
**.Data.Plural** The plural name of the taxonomy<br>
**.Data.Pages** the list of pages in this taxonomy<br>
**.Data.Terms** The taxonomy itself<br>
**.Data.Terms.Alphabetical** The Terms alphabetized<br>
**.Data.Terms.ByCount** The Terms ordered by popularity<br>
Docs: Add taxonomy term variables to the list of vars. Taxonomy Term pages have variables in addition to those on "node" pages. Documenting these variables with all the other node variables makes them easier to find. Fixes: #1155
2015-05-22 13:06:18 -04:00
The last two can also be reversed: **.Data.Terms.Alphabetical.Reverse**, **.Data.Terms.ByCount.Reverse**.
Add multilingual support in Hugo Implements: * support to render: * content/post/whatever.en.md to /en/2015/12/22/whatever/index.html * content/post/whatever.fr.md to /fr/2015/12/22/whatever/index.html * gets enabled when `Multilingual:` is specified in config. * support having language switchers in templates, that know where the translated page is (with .Page.Translations) (when you're on /en/about/, you can have a "Francais" link pointing to /fr/a-propos/) * all translations are in the `.Page.Translations` map, including the current one. * easily tweak themes to support Multilingual mode * renders in a single swift, no need for two config files. Adds a couple of variables useful for multilingual sites Adds documentation (content/multilingual.md) Added language prefixing for all URL generation/permalinking see in the code base. Implements i18n. Leverages the great github.com/nicksnyder/go-i18n lib.. thanks Nick. * Adds "i18n" and "T" template functions..
2016-05-14 00:35:16 -04:00
### Taxonomies elsewhere
The **.Site.Taxonomies** variable holds all taxonomies defines site-wide. It is a map of the taxonomy name to a list of its values. For example: "tags" -> ["tag1", "tag2", "tag3"]. Each value, though, is not a string but rather a [Taxonomy variable](#the-taxonomy-variable).
#### The Taxonomy variable
The Taxonomy variable, available as **.Site.Taxonomies.tags** for example, contains the list of tags (values) and, for each of those, their corresponding content pages.
Complete overhaul of the docs
2013-08-17 08:34:25 -04:00
## Site Variables
adding hugo
2013-07-04 11:32:55 -04:00
Also available is `.Site` which has the following:
Update Hugo docs with the initialisms suggested by golint In particular: * .Url → .URL (for node, menu and paginator) * .Site.BaseUrl → .Site.BaseURL * getJson → getJSON * getCsv → getCSV * safeHtml → safeHTML * safeCss → safeCSS * safeUrl → safeURL Continued effort in fixing #959.
2015-03-18 02:44:12 -04:00
**.Site.BaseURL** The base URL for the site as defined in the site configuration file.<br>
Add RSSLink to SiteInfo
2015-11-10 22:31:52 -05:00
**.Site.RSSLink** The URL for the site RSS.<br>
Add multilingual support in Hugo Implements: * support to render: * content/post/whatever.en.md to /en/2015/12/22/whatever/index.html * content/post/whatever.fr.md to /fr/2015/12/22/whatever/index.html * gets enabled when `Multilingual:` is specified in config. * support having language switchers in templates, that know where the translated page is (with .Page.Translations) (when you're on /en/about/, you can have a "Francais" link pointing to /fr/a-propos/) * all translations are in the `.Page.Translations` map, including the current one. * easily tweak themes to support Multilingual mode * renders in a single swift, no need for two config files. Adds a couple of variables useful for multilingual sites Adds documentation (content/multilingual.md) Added language prefixing for all URL generation/permalinking see in the code base. Implements i18n. Leverages the great github.com/nicksnyder/go-i18n lib.. thanks Nick. * Adds "i18n" and "T" template functions..
2016-05-14 00:35:16 -04:00
**.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).<br>
**.Site.Pages** Array of all content ordered by Date, newest first. Replaces the now-deprecated `.Site.Recent` starting v0.13. This array contains only the pages in the current language.<br>
**.Site.AllPages** Array of all pages regardless of their translation.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Site.Params** A container holding the values from the `params` section of your site configuration file. For example, a TOML config file might look like this:
all: Unify case of config variable names All config variables starts with low-case and uses camelCase. If there is abbreviation at the beginning of the name, the whole abbreviation will be written in low-case. If there is abbreviation at the end of the name, the whole abbreviation will be written in upper-case. For example, rssURI.
2016-10-24 14:56:00 -04:00
baseURL = "http://yoursite.example.com/"
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
[params]
description = "Tesla's Awesome Hugo Site"
author = "Nikola Tesla"
**.Site.Sections** Top level directories of the site.<br>
**.Site.Files** All of the source files of the site.<br>
**.Site.Menus** All of the menus in the site.<br>
**.Site.Title** A string representing the title of the site.<br>
Revert the "standardize author data" There were some breaking changes etc. that is too late to fix for 0.17. Let us think this through and add proper author support for Hugo 0.18. Fixes #2464 Revert "docs: Add documentation for author profiles" This reverts commit b6673e5309685ae162fdef2dc39c3ce4385c6005. Revert "Add First Class Author Support" This reverts commit cf978c06496d99e76b08418422dda5797d90fed6.
2016-09-18 13:10:11 -04:00
**.Site.Author** A map of the authors as defined in the site configuration.<br>
Add multilingual support in Hugo Implements: * support to render: * content/post/whatever.en.md to /en/2015/12/22/whatever/index.html * content/post/whatever.fr.md to /fr/2015/12/22/whatever/index.html * gets enabled when `Multilingual:` is specified in config. * support having language switchers in templates, that know where the translated page is (with .Page.Translations) (when you're on /en/about/, you can have a "Francais" link pointing to /fr/a-propos/) * all translations are in the `.Page.Translations` map, including the current one. * easily tweak themes to support Multilingual mode * renders in a single swift, no need for two config files. Adds a couple of variables useful for multilingual sites Adds documentation (content/multilingual.md) Added language prefixing for all URL generation/permalinking see in the code base. Implements i18n. Leverages the great github.com/nicksnyder/go-i18n lib.. thanks Nick. * Adds "i18n" and "T" template functions..
2016-05-14 00:35:16 -04:00
**.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.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Site.DisqusShortname** A string representing the shortname of the Disqus shortcode as defined in the site configuration.<br>
Add internal Google Analytics template This commits also adds the GoogleAnalytics variable to insert the tracking code. Fixes #1424.
2015-10-19 07:31:03 -04:00
**.Site.GoogleAnalytics** A string representing your tracking code for Google Analytics as defined in the site configuration.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Site.Copyright** A string representing the copyright of your web site as defined in the site configuration.<br>
docs: More detailed explanation of .Site.LastChange
2015-08-08 01:30:11 -04:00
**.Site.LastChange** A string representing the date/time of the most recent change to your site, based on the [`date` variable]({{< ref "content/front-matter.md#required-variables" >}}) in the front matter of your content pages.<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Site.Permalinks** A string to override the default permalink format. Defined in the site configuration.<br>
**.Site.BuildDrafts** A boolean (Default: false) to indicate whether to build drafts. Defined in the site configuration.<br>
Add docs for Data Files Fixes #887
2015-02-09 10:52:52 -05:00
**.Site.Data** Custom data, see [Data Files](/extras/datafiles/).<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Site.IsMultiLingual** Whether there are more than one language in this site.<br> See [Multilingual]({{< relref "content/multilingual.md" >}}) for more info.<br>
docs: List multilingual tpl vars and show menu creation Fixes #2436
2016-09-16 09:35:19 -04:00
**.Site.Language** This indicates which language you are currently rendering the website for. This is an object with the attributes set in your language definition in your site config.<br>
**.Site.Language.Lang** The language code of the current locale, e.g. `en`.<br>
**.Site.Language.Weight** The weight that defines the order in the `.Site.Languages` list.<br>
**.Site.Language.LanguageName** The full language name, e.g. `English`.<br>
docs: Get the variable and funcs re multilingual up-to-date
2016-08-11 04:45:54 -04:00
**.Site.LanguagePrefix** This can be used to prefix theURLs with whats needed to point to the correct language. It will even work when only one language defined. See also the functions [absLangURL and relLangURL]({{< relref "templates/functions.md#abslangurl-rellangurl" >}}).<br>
**.Site.Languages** An ordered list (ordered by defined weight) of languages.<br>
Added top level .Hugo variable with version, commit and generator information + docs Added Version, CommitHash and BuildDate to hugolib/hugo.go and used it in build Removed commitHash and buildDate from commands/version.go and used hugolib vars Removed getDateFormat function from commands/version.go Conflicts: README.md docs/content/templates/variables.md
2014-12-09 10:36:07 -05:00
docs: Document .File variables for pages Fixes #2154.
2016-05-18 15:07:06 -04:00
## File Variables
The `.File` variable gives you additional information of a page.
> **Note:** `.File` is only accessible on *Pages* but **not** on *Nodes* (like the homepage and list pages).
Available are the following attributes:
**.File.Path** The original relative path of the page, e.g. `content/posts/foo.md`<br>
**.File.LogicalName** The name of the content file that represents a page, e.g. `foo.md`<br>
**.File.BaseFileName** The filename without extension, e.g. `foo`<br>
**.File.Ext** or **.File.Extension** The file extension of the content file, e.g. `md`<br>
**.File.Dir** Given the path `content/posts/dir1/dir2/`, the relative directory path of the content file will be returned, e.g. `posts/dir1/dir2/`<br>
Added top level .Hugo variable with version, commit and generator information + docs Added Version, CommitHash and BuildDate to hugolib/hugo.go and used it in build Removed commitHash and buildDate from commands/version.go and used hugolib vars Removed getDateFormat function from commands/version.go Conflicts: README.md docs/content/templates/variables.md
2014-12-09 10:36:07 -05:00
## Hugo Variables
Also available is `.Hugo` which has the following:
docs: Improve description for .Hugo.Generator
2016-05-11 14:59:31 -04:00
**.Hugo.Generator** Meta tag for the version of Hugo that generated the site. Highly recommended to be included by default in all theme headers so we can start to track the usage and popularity of Hugo. Unlike other variables it outputs a **complete** HTML tag, e.g. `<meta name="generator" content="Hugo 0.15" />`<br>
Revert "[Docs] Use <dl> for definition lists of variables" This reverts commit 5d6dfe81b8c78d86fad677b4ba452b7bcf52aed9. The extra styling in docs/static/css/style.css has been retained.
2015-01-19 13:44:14 -05:00
**.Hugo.Version** The current version of the Hugo binary you are using e.g. `0.13-DEV`<br>
**.Hugo.CommitHash** The git commit hash of the current Hugo binary e.g. `0e8bed9ccffba0df554728b46c5bbf6d78ae5247`<br>
**.Hugo.BuildDate** The compile date of the current Hugo binary formatted with RFC 3339 e.g. `2002-10-02T10:00:00-05:00`<br>
Reference in a new issue Copy permalink