Skip to content

Commit

Permalink
Update documentation.md
Browse files Browse the repository at this point in the history
  • Loading branch information
jmooring authored Sep 21, 2024
1 parent e9e917f commit 26fb4bb
Showing 1 changed file with 18 additions and 6 deletions.
24 changes: 18 additions & 6 deletions content/en/contribute/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -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, 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

Other guidelines to consider:
Expand All @@ -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.
Expand Down

0 comments on commit 26fb4bb

Please sign in to comment.