TheCloud/hugoDocs
1
0
Fork 0
mirror of https://github.com/gohugoio/hugoDocs.git synced 2025-09-15 19:14:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

content: Update documentation guide

Browse Source
This commit is contained in:
Joe Mooring 2025-08-31 12:53:43 -07:00 committed by GitHub
parent 9f6213ebef
commit d93340a780
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
content/en/contribute/documentation.md
View File

@ -24,7 +24,15 @@ Follow Google's [developer documentation style guide].
Adhere to these Markdown conventions: Adhere to these Markdown conventions:
- Use [ATX] headings (levels 2-4), not [setext] headings. - Use [ATX] headings (levels 2-4), not [setext] headings.
- Use [fenced code blocks], not [indented code blocks]. - Use [collapsed link references][] instead of full or shortcut references. For example:
```text
This is a [link][].
[link]: https://example.org
```
- Use [fenced code blocks] instead of [indented code blocks].
- Use hyphens, not asterisks, for unordered [list items]. - Use hyphens, not asterisks, for unordered [list items].
- Use [callouts](#callouts) instead of bold text for emphasis. - Use [callouts](#callouts) instead of bold text for emphasis.
- Do not mix [raw HTML] within Markdown. - Do not mix [raw HTML] within Markdown.
@ -522,6 +530,7 @@ Step 9
[ATX]: https://spec.commonmark.org/current/#atx-headings [ATX]: https://spec.commonmark.org/current/#atx-headings
[basic english]: https://simple.wikipedia.org/wiki/Basic_English [basic english]: https://simple.wikipedia.org/wiki/Basic_English
[collapsed link references]: https://discourse.gohugo.io/t/55714
[developer documentation style guide]: https://developers.google.com/style [developer documentation style guide]: https://developers.google.com/style
[documentation repository]: https://github.com/gohugoio/hugoDocs/ [documentation repository]: https://github.com/gohugoio/hugoDocs/
[fenced code blocks]: https://spec.commonmark.org/current/#fenced-code-blocks [fenced code blocks]: https://spec.commonmark.org/current/#fenced-code-blocks