mirror of
https://github.com/gohugoio/hugo.git
synced 2025-08-17 21:01:26 +02:00
Merge commit 'de0df119b504a91c9e1f442b07954f366ffb2932'
This commit is contained in:
@@ -85,6 +85,24 @@ Yes → Hugo is fast.
|
||||
"It's an adverb, Sam. It's a lazy tool of a weak mind." (Outbreak, 1995).
|
||||
{{% /note %}}
|
||||
|
||||
#### Level 6 headings
|
||||
|
||||
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
|
||||
|
||||
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".
|
||||
|
||||
For example:
|
||||
|
||||
- `Returns the URL aliases as defined in front matter.`
|
||||
- `Reports whether the given page is in the given section.`
|
||||
|
||||
[functions]: /functions
|
||||
[methods]: /methods
|
||||
|
||||
#### Miscellaneous
|
||||
|
||||
Other guidelines to consider:
|
||||
@@ -97,12 +115,6 @@ Other guidelines to consider:
|
||||
- When including code samples, use short snippets that demonstrate the concept.
|
||||
- The Hugo user community is global; use [basic english](https://simple.wikipedia.org/wiki/Basic_English) when possible.
|
||||
|
||||
#### Level 6 headings
|
||||
|
||||
Level 6 headings are styled as `dt` elements. This was implemented to support a [glossary] with linkable terms.
|
||||
|
||||
[glossary]: /getting-started/glossary/
|
||||
|
||||
## Code examples
|
||||
|
||||
Indent code by two spaces. With examples of template code, include a space after opening action delimiters, and include a space before closing action delimiters.
|
||||
|
Reference in New Issue
Block a user