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

Update definition list formatting

Browse Source 
The convention has been to NOT monospace the definition term string.

Also "taxonomies" is not a real front-matter param.. it's a place-holder for
taxonomy plural terms like "tags" and "categories".. so indicating that that's a
placeholder by displaying that as "<taxonomies>".
This commit is contained in:
Kaushal Modi 2018-04-17 16:42:14 -04:00
parent 46050042ab
commit ebcfa30d73
1 changed files with 22 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
content/content-management/front-matter.md
View File

@ -56,68 +56,68 @@ slug = "spf13-vim-3-0-release-and-new-website"
There are a few predefined variables that Hugo is aware of. See [Page Variables][pagevars] for how to call many of these predefined variables in your templates. There are a few predefined variables that Hugo is aware of. See [Page Variables][pagevars] for how to call many of these predefined variables in your templates.
`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.
`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][].
`description` description
: the description for the content. : the description for the content.
`draft` draft
: if `true`, the content will not be rendered unless the `--buildDrafts` flag is passed to the `hugo` command. : if `true`, the content will not be rendered unless the `--buildDrafts` flag is passed to the `hugo` command.
`expiryDate` expiryDate
: the datetime at which the content should no longer be published by Hugo; expired content will not be rendered unless the `--buildExpired` flag is passed to the `hugo` command. : the datetime at which the content should no longer be published by Hugo; expired content will not be rendered unless the `--buildExpired` flag is passed to the `hugo` command.
`headless` headless
: if `true`, sets a leaf bundle to be [headless][headless-bundle]. : if `true`, sets a leaf bundle to be [headless][headless-bundle].
`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.
`keywords` keywords
: the meta keywords for the content. : the meta keywords for the content.
`layout` layout
: the layout Hugo should select from the [lookup order][lookup] when rendering the content. If a `type` is not specified in the front matter, Hugo will look for the layout of the same name in the layout directory that corresponds with a content's section. See ["Defining a Content Type"][definetype] : the layout Hugo should select from the [lookup order][lookup] when rendering the content. If a `type` is not specified in the front matter, Hugo will look for the layout of the same name in the layout directory that corresponds with a content's section. See ["Defining a Content Type"][definetype]
`lastmod` lastmod
: the datetime at which the content was last modified. : the datetime at which the content was last modified.
`linkTitle` linkTitle
: used for creating links to content; if set, Hugo defaults to using the `linktitle` before the `title`. Hugo can also [order lists of content by `linktitle`][bylinktitle]. : used for creating links to content; if set, Hugo defaults to using the `linktitle` before the `title`. Hugo can also [order lists of content by `linktitle`][bylinktitle].
`markup` markup
: **experimental**; specify `"rst"` for reStructuredText (requires`rst2html`) or `"md"` (default) for Markdown. : **experimental**; specify `"rst"` for reStructuredText (requires`rst2html`) or `"md"` (default) for Markdown.
`outputs` outputs
: allows you to specify output formats specific to the content. See [output formats][outputs]. : allows you to specify output formats specific to the content. See [output formats][outputs].
`publishDate` publishDate
: if in the future, content will not be rendered unless the `--buildFuture` flag is passed to `hugo`. : if in the future, content will not be rendered unless the `--buildFuture` flag is passed to `hugo`.
`resources` resources
: used for configuring page bundle resources. See [Page Resources][page-resources]. : used for configuring page bundle resources. See [Page Resources][page-resources].
`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.
`taxonomies` \<taxonomies\>
: these will use the field name of the plural form of the index; see the `tags` and `categories` in the above front matter examples. : these will use the field name of the *plural* form of the index; see the `tags` and `categories` in the above front matter examples.
`title` title
: the title for the content. : the title for the content.
`type` type
: the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter. : the type of the content; this value will be automatically derived from the directory (i.e., the [section][]) if not specified in front matter.
`url` 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.
`weight` weight
: used for [ordering your content in lists][ordering]. : used for [ordering your content in lists][ordering].
{{% note "Hugo's Default URL Destinations" %}} {{% note "Hugo's Default URL Destinations" %}}