Update documentation.md

This commit is contained in:
Joe Mooring
2024-09-21 09:58:55 -07:00
committed by GitHub
parent e9e917f377
commit 26fb4bb4c5
+18 -6
View File
@@ -85,6 +85,24 @@ Yes → Hugo is fast.
"It's an adverb, Sam. It's a lazy tool of a weak mind." (Outbreak, 1995). "It's an adverb, Sam. It's a lazy tool of a weak mind." (Outbreak, 1995).
{{% /note %}} {{% /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, beging 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 #### Miscellaneous
Other guidelines to consider: Other guidelines to consider:
@@ -97,12 +115,6 @@ Other guidelines to consider:
- When including code samples, use short snippets that demonstrate the concept. - 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. - 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 ## 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. 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.