mirror of
https://github.com/gohugoio/hugoDocs.git
synced 2025-09-11 02:04:48 -04:00
Move glossary to quick reference section
This commit is contained in:
parent
2d94905bef
commit
6f14084c13
@ -41,7 +41,7 @@ Please follow these guidelines:
|
|||||||
- Remove consecutive blank lines (maximum of two)
|
- Remove consecutive blank lines (maximum of two)
|
||||||
- Remove trailing spaces
|
- Remove trailing spaces
|
||||||
|
|
||||||
### Glossary of terms
|
### Glossary
|
||||||
|
|
||||||
Glossary terms are maintained on individual pages. While not directly accessible to site visitors, these pages act as a central repository for term definitions.
|
Glossary terms are maintained on individual pages. While not directly accessible to site visitors, these pages act as a central repository for term definitions.
|
||||||
|
|
||||||
@ -53,7 +53,7 @@ To link to a term definition on the glossary page, use this custom link syntax:
|
|||||||
[term](g)
|
[term](g)
|
||||||
```
|
```
|
||||||
|
|
||||||
Lookups are case-insensitive, ignore formatting, and support both singular and plural forms. For example, all of these variations will link to the same glossary entry:
|
Lookups are case-insensitive, ignore formatting, and support both singular and plural forms. For example, all of these variations will link to the same glossary term:
|
||||||
|
|
||||||
```text
|
```text
|
||||||
[global resource](g)
|
[global resource](g)
|
||||||
@ -68,12 +68,9 @@ To insert a term definition, use the [`glossary-term`] shortcode:
|
|||||||
{{%/* glossary-term "global resource" */%}}
|
{{%/* glossary-term "global resource" */%}}
|
||||||
```
|
```
|
||||||
|
|
||||||
[glossary of terms]: /getting-started/glossary/
|
|
||||||
[`glossary-term`]: #glossary-term
|
|
||||||
|
|
||||||
### Terminology
|
### Terminology
|
||||||
|
|
||||||
Please link to the [glossary of terms] when necessary, and use the terms consistently throughout the documentation. Of special note:
|
Please link to the glossary (see above) when necessary, and use the terms consistently throughout the documentation. Of special note:
|
||||||
|
|
||||||
- The term "front matter" is two words unless you are referring to the configuration key
|
- The term "front matter" is two words unless you are referring to the configuration key
|
||||||
- The term "home page" is two words
|
- The term "home page" is two words
|
||||||
@ -85,8 +82,6 @@ Please link to the [glossary of terms] when necessary, and use the terms consist
|
|||||||
- Capitalize the word "Markdown"
|
- Capitalize the word "Markdown"
|
||||||
- Hyphenate the term "open-source" when used an adjective.
|
- Hyphenate the term "open-source" when used an adjective.
|
||||||
|
|
||||||
Use the [glossary link] (`gl`) shortcode to insert a link to the glossary entry for the given term, and use the [glossary term] (`gt`) shortcode to insert the definition of the given term.
|
|
||||||
|
|
||||||
### Page titles and headings
|
### Page titles and headings
|
||||||
|
|
||||||
Please follow these guidelines for page titles and headings:
|
Please follow these guidelines for page titles and headings:
|
||||||
@ -124,8 +119,6 @@ Yes → Hugo is fast.
|
|||||||
|
|
||||||
Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms.
|
Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms.
|
||||||
|
|
||||||
[glossary]: /getting-started/glossary/
|
|
||||||
|
|
||||||
### Function and method descriptions
|
### Function and method descriptions
|
||||||
|
|
||||||
When adding a page to the [functions] or [methods] section, begin the description with the word "Returns". With functions and methods that return a boolean value, begin the description with the phrase "Reports whether".
|
When adding a page to the [functions] or [methods] section, begin the description with the word "Returns". With functions and methods that return a boolean value, begin the description with the phrase "Reports whether".
|
||||||
@ -472,13 +465,14 @@ Step 9
|
|||||||
|
|
||||||
[ATX]: https://spec.commonmark.org/0.30/#atx-headings
|
[ATX]: https://spec.commonmark.org/0.30/#atx-headings
|
||||||
[Microsoft Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome/
|
[Microsoft Writing Style Guide]: https://learn.microsoft.com/en-us/style-guide/welcome/
|
||||||
|
[`glossary-term`]: #glossary-term
|
||||||
[basic english]: https://simple.wikipedia.org/wiki/Basic_English
|
[basic english]: https://simple.wikipedia.org/wiki/Basic_English
|
||||||
[code examples]: #code-examples
|
[code examples]: #code-examples
|
||||||
[code shortcode]: #code
|
[code shortcode]: #code
|
||||||
[code-toggle shortcode]: #code-toggle
|
[code-toggle shortcode]: #code-toggle
|
||||||
[documentation repository]: https://github.com/gohugoio/hugoDocs/
|
[documentation repository]: https://github.com/gohugoio/hugoDocs/
|
||||||
[fenced code blocks]: https://spec.commonmark.org/0.30/#fenced-code-blocks
|
[fenced code blocks]: https://spec.commonmark.org/0.30/#fenced-code-blocks
|
||||||
[glossary of terms]: /getting-started/glossary/
|
[glossary]: /quick-reference/glossary/
|
||||||
[indented code blocks]: https://spec.commonmark.org/0.30/#indented-code-blocks
|
[indented code blocks]: https://spec.commonmark.org/0.30/#indented-code-blocks
|
||||||
[issues]: https://github.com/gohugoio/hugoDocs/issues
|
[issues]: https://github.com/gohugoio/hugoDocs/issues
|
||||||
[list items]: https://spec.commonmark.org/0.30/#list-items
|
[list items]: https://spec.commonmark.org/0.30/#list-items
|
||||||
|
@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
title: cache
|
|
||||||
---
|
|
||||||
|
|
||||||
A software component that stores data so that future requests for the same data are faster.
|
|
@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
title: element
|
|
||||||
---
|
|
||||||
|
|
||||||
A member of a slice or array.
|
|
@ -1,5 +0,0 @@
|
|||||||
---
|
|
||||||
title: field
|
|
||||||
---
|
|
||||||
|
|
||||||
A predefined key-value pair in front matter such as `date` or `title`. See also [parameter](g).
|
|
@ -1,10 +0,0 @@
|
|||||||
---
|
|
||||||
title: global resource
|
|
||||||
---
|
|
||||||
|
|
||||||
A file within the `assets` directory, or within any directory [mounted](/hugo-modules/configuration/#module-configuration-mounts) to the `assets` directory. Capture one or more global resources using the [`resources.Get`], [`resources.GetMatch`], [`resources.Match`], or [`resources.ByType`] functions.
|
|
||||||
|
|
||||||
[`resources.Get`]: /functions/resources/get/
|
|
||||||
[`resources.GetMatch`]: /functions/resources/getmatch/
|
|
||||||
[`resources.Match`]: /functions/resources/match/
|
|
||||||
[`resources.ByType`]: /functions/resources/byType/
|
|
@ -1,13 +1,14 @@
|
|||||||
---
|
---
|
||||||
title: Glossary of terms
|
title: Glossary
|
||||||
description: Terms commonly used throughout the documentation.
|
description: Terms commonly used throughout the documentation.
|
||||||
categories: [getting started]
|
categories: [quick-reference]
|
||||||
keywords: [glossary]
|
keywords: [glossary]
|
||||||
menu:
|
menu:
|
||||||
docs:
|
docs:
|
||||||
parent: getting-started
|
parent: quick-reference
|
||||||
weight: 80
|
weight: 40
|
||||||
weight: 80
|
aliases: [/getting-started/glossary/]
|
||||||
|
weight: 40
|
||||||
layout: single
|
layout: single
|
||||||
build:
|
build:
|
||||||
render: always
|
render: always
|
5
content/en/quick-reference/glossary/asset-pipeline.md
Normal file
5
content/en/quick-reference/glossary/asset-pipeline.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: asset pipeline
|
||||||
|
---
|
||||||
|
|
||||||
|
An _asset pipeline_ is a system that automates and optimizes the handling of static assets like images, stylesheets, and JavaScript files.
|
5
content/en/quick-reference/glossary/cache.md
Normal file
5
content/en/quick-reference/glossary/cache.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: cache
|
||||||
|
---
|
||||||
|
|
||||||
|
A _cache_ is a software component that stores data so that future requests for the same data are faster.
|
5
content/en/quick-reference/glossary/duration.md
Normal file
5
content/en/quick-reference/glossary/duration.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: duration
|
||||||
|
---
|
||||||
|
|
||||||
|
A _duration_ is a data type that represent a length of time, expressed using units such as seconds (represented by `s`), minutes (represented by `m`), and hours (represented by `h`). For example, `42s` means 42 seconds, `6m7s` means 6 minutes and 7 seconds, and `6h7m42s` means 6 hours, 7 minutes, and 42 seconds.
|
5
content/en/quick-reference/glossary/element.md
Normal file
5
content/en/quick-reference/glossary/element.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: element
|
||||||
|
---
|
||||||
|
|
||||||
|
An _element_ is a member of a [_slice_](g) or [_array_](g).
|
5
content/en/quick-reference/glossary/field.md
Normal file
5
content/en/quick-reference/glossary/field.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: field
|
||||||
|
---
|
||||||
|
|
||||||
|
A _field_ is a predefined key-value pair in front matter such as `date` or `title`.
|
6
content/en/quick-reference/glossary/glob.md
Normal file
6
content/en/quick-reference/glossary/glob.md
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
---
|
||||||
|
title: glob
|
||||||
|
reference: https://github.com/gobwas/glob?tab=readme-ov-file#example
|
||||||
|
---
|
||||||
|
|
||||||
|
A _glob_ is a pattern used to match filenames and paths. It's a shorthand for specifying a set of files, making it easier to work with multiple files at once.
|
10
content/en/quick-reference/glossary/global-resource.md
Normal file
10
content/en/quick-reference/glossary/global-resource.md
Normal file
@ -0,0 +1,10 @@
|
|||||||
|
---
|
||||||
|
title: global resource
|
||||||
|
---
|
||||||
|
|
||||||
|
A file within the `assets` directory, or within any directory mounted to the `assets` directory. Capture one or more global resources using the [`resources.Get`], [`resources.GetMatch`], [`resources.Match`], or [`resources.ByType`] functions.
|
||||||
|
|
||||||
|
[`resources.Get`]: /functions/resources/get/
|
||||||
|
[`resources.GetMatch`]: /functions/resources/getmatch/
|
||||||
|
[`resources.Match`]: /functions/resources/match/
|
||||||
|
[`resources.ByType`]: /functions/resources/byType/
|
@ -1,5 +1,6 @@
|
|||||||
---
|
---
|
||||||
title: Markdown attribute
|
title: Markdown attribute
|
||||||
|
reference: /content-management/markdown-attributes/
|
||||||
---
|
---
|
||||||
|
|
||||||
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.
|
5
content/en/quick-reference/glossary/pretty-url.md
Normal file
5
content/en/quick-reference/glossary/pretty-url.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: pretty URL
|
||||||
|
---
|
||||||
|
|
||||||
|
A _pretty URL_ is a URL that does not include a file extension.
|
5
content/en/quick-reference/glossary/segment.md
Normal file
5
content/en/quick-reference/glossary/segment.md
Normal file
@ -0,0 +1,5 @@
|
|||||||
|
---
|
||||||
|
title: segment
|
||||||
|
---
|
||||||
|
|
||||||
|
A _segment_ is a subset of a site, filtered by [_logical path_](g), language, [_page kind_](g), and [_output format_](g).
|
Some files were not shown because too many files have changed in this diff Show More
Loading…
x
Reference in New Issue
Block a user