mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-14 16:14:42 -04:00
Use key-value consistently throughout documentation
This commit is contained in:
parent
d03ed18872
commit
463adcf268
@ -68,7 +68,7 @@ You may add [global HTML attributes], or HTML attributes specific to the current
|
|||||||
|
|
||||||
[global HTML attributes]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes
|
[global HTML attributes]: https://developer.mozilla.org/en-US/docs/Web/HTML/Global_attributes
|
||||||
|
|
||||||
The attribute list consists of one or more key/value pairs, separated by spaces or commas, wrapped by braces. You must quote string values that contain spaces. Unlike HTML, boolean attributes must have both key and value.
|
The attribute list consists of one or more key-value pairs, separated by spaces or commas, wrapped by braces. You must quote string values that contain spaces. Unlike HTML, boolean attributes must have both key and value.
|
||||||
|
|
||||||
For example:
|
For example:
|
||||||
|
|
||||||
|
@ -134,7 +134,7 @@ title
|
|||||||
: Sets the value returned in `Title`
|
: Sets the value returned in `Title`
|
||||||
|
|
||||||
params
|
params
|
||||||
: A map of custom key/values.
|
: A map of custom key-value pairs.
|
||||||
|
|
||||||
### Resources metadata example
|
### Resources metadata example
|
||||||
|
|
||||||
|
@ -47,7 +47,7 @@ Place this in your baseof.html template:
|
|||||||
|
|
||||||
The example above:
|
The example above:
|
||||||
|
|
||||||
1. Creates a map with the relevant key/value pairs using the [`dict`] function
|
1. Creates a map with the relevant key-value pairs using the [`dict`] function
|
||||||
2. Encodes the map as a JSON string using the [`jsonify`] function
|
2. Encodes the map as a JSON string using the [`jsonify`] function
|
||||||
3. Creates a resource from the JSON string using the `resources.FromString` function
|
3. Creates a resource from the JSON string using the `resources.FromString` function
|
||||||
4. Publishes the file to the root of the public directory using the resource's `.Publish` method
|
4. Publishes the file to the root of the public directory using the resource's `.Publish` method
|
||||||
|
@ -46,7 +46,7 @@ targetPath
|
|||||||
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
|
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
|
||||||
|
|
||||||
vars
|
vars
|
||||||
: (`map`) A map of key/value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/).
|
: (`map`) A map of key-value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/).
|
||||||
|
|
||||||
```scss
|
```scss
|
||||||
// LibSass
|
// LibSass
|
||||||
|
@ -1,6 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: safe.HTMLAttr
|
title: safe.HTMLAttr
|
||||||
description: Declares the given key/value pair as a safe HTML attribute.
|
description: Declares the given key-value pair as a safe HTML attribute.
|
||||||
categories: []
|
categories: []
|
||||||
keywords: []
|
keywords: []
|
||||||
action:
|
action:
|
||||||
|
@ -192,7 +192,7 @@ This is the default configuration for the AsciiDoc renderer:
|
|||||||
|
|
||||||
###### attributes
|
###### attributes
|
||||||
|
|
||||||
(`map`) A map of key/value pairs, each a document attributes,See Asciidoctor’s [attributes].
|
(`map`) A map of key-value pairs, each a document attributes,See Asciidoctor’s [attributes].
|
||||||
|
|
||||||
[attributes]: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#attributes-and-substitutions
|
[attributes]: https://asciidoctor.org/docs/asciidoc-syntax-quick-reference/#attributes-and-substitutions
|
||||||
|
|
||||||
|
@ -126,7 +126,7 @@ To determine the current environment within a template, use the [`hugo.Environme
|
|||||||
|
|
||||||
###### field
|
###### field
|
||||||
|
|
||||||
A predefined key/value pair in front matter such as `date` or `title`. See also [parameter](#parameter).
|
A predefined key-value pair in front matter such as `date` or `title`. See also [parameter](#parameter).
|
||||||
|
|
||||||
|
|
||||||
###### flag
|
###### flag
|
||||||
@ -224,7 +224,7 @@ An unordered group of elements, each indexed by a unique key. See the [Go d
|
|||||||
|
|
||||||
###### Markdown attribute
|
###### Markdown attribute
|
||||||
|
|
||||||
A list of attributes, containing one or more key/value pairs, separated by spaces or commas, and wrapped by braces. Apply Markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. See [details](/getting-started/configuration-markup/#goldmark).
|
A list of attributes, containing one or more key-value pairs, separated by spaces or commas, and wrapped by braces. Apply Markdown attributes to images and block-level elements including blockquotes, fenced code blocks, headings, horizontal rules, lists, paragraphs, and tables. See [details](/getting-started/configuration-markup/#goldmark).
|
||||||
|
|
||||||
###### marshal
|
###### marshal
|
||||||
|
|
||||||
@ -295,7 +295,7 @@ The process of [paginating](#paginate) a [section](#section) list.
|
|||||||
|
|
||||||
###### parameter
|
###### parameter
|
||||||
|
|
||||||
Typically, a user-defined key/value pair at the site or page level, but may also refer to a configuration setting or an [argument](#argument). See also [field](#field).
|
Typically, a user-defined key-value pair at the site or page level, but may also refer to a configuration setting or an [argument](#argument). See also [field](#field).
|
||||||
|
|
||||||
###### partial
|
###### partial
|
||||||
|
|
||||||
|
@ -43,7 +43,7 @@ targetPath
|
|||||||
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
|
: (`string`) If not set, the transformed resource's target path will be the original path of the asset file with its extension replaced by `.css`.
|
||||||
|
|
||||||
vars {{< new-in 0.109.0 >}}
|
vars {{< new-in 0.109.0 >}}
|
||||||
: (`map`) A map of key/value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/).
|
: (`map`) A map of key-value pairs that will be available in the `hugo:vars` namespace. Useful for [initializing Sass variables from Hugo templates](https://discourse.gohugo.io/t/42053/).
|
||||||
|
|
||||||
```scss
|
```scss
|
||||||
// LibSass
|
// LibSass
|
||||||
|
Loading…
x
Reference in New Issue
Block a user