TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-12 16:34:46 -04:00
Code Issues Packages Projects Releases Wiki Activity

Document "images", "videos", etc. in front-matter

Browse Source 
Fixes #319
Adds documentation for "images", "videos", "audio", and "series".
This commit is contained in:
Tiger Oakes 2018-10-13 22:27:36 -07:00 committed by Bjørn Erik Pedersen
parent 6a85b5df18
commit f4d624da32
1 changed files with 12 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
content/en/content-management/front-matter.md
View File

@ -59,6 +59,9 @@ There are a few predefined variables that Hugo is aware of. See [Page Variables]
aliases aliases
: an array of one or more aliases (e.g., old published paths of renamed content) that will be created in the output directory structure . See [Aliases][aliases] for details. : an array of one or more aliases (e.g., old published paths of renamed content) that will be created in the output directory structure . See [Aliases][aliases] for details.
audio
: an array of paths to audio files related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:audio`.
date date
: the datetime at which the content was created; note this value is auto-populated according to Hugo's built-in [archetype][]. : the datetime at which the content was created; note this value is auto-populated according to Hugo's built-in [archetype][].
@ -74,6 +77,9 @@ expiryDate
headless headless
: if `true`, sets a leaf bundle to be [headless][headless-bundle]. : if `true`, sets a leaf bundle to be [headless][headless-bundle].
images
: an array of paths to images related to the page; used by [internal templates](/templates/internal) such as `_internal/twitter_cards.html`.
isCJKLanguage isCJKLanguage
: if `true`, Hugo will explicitly treat the content as a CJK language; both `.Summary` and `.WordCount` work properly in CJK languages. : if `true`, Hugo will explicitly treat the content as a CJK language; both `.Summary` and `.WordCount` work properly in CJK languages.
@ -101,6 +107,9 @@ publishDate
resources resources
: used for configuring page bundle resources. See [Page Resources][page-resources]. : used for configuring page bundle resources. See [Page Resources][page-resources].
series
: an array of series this page belongs to, as a subset of the `series` [taxonomy](/content-management/taxonomies/); used by the `opengraph` [internal template](/templates/internal) to populate `og:see_also`.
slug slug
: appears as the tail of the output URL. A value specified in front matter will override the segment of the URL based on the filename. : appears as the tail of the output URL. A value specified in front matter will override the segment of the URL based on the filename.
@ -114,6 +123,9 @@ url
: the full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of : the full path to the content from the web root. It makes no assumptions about the path of the content file. It also ignores any language prefixes of
the multilingual feature. the multilingual feature.
videos
: an array of paths to videos related to the page; used by the `opengraph` [internal template](/templates/internal) to populate `og:video`.
weight weight
: used for [ordering your content in lists][ordering]. Lower weight gets higher precedence. So content with lower weight will come first. : used for [ordering your content in lists][ordering]. Lower weight gets higher precedence. So content with lower weight will come first.