Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-01-12 15:59:37 -05:00
Code Issues Packages Projects Releases Wiki Activity

Do not strictly require Atx-style headings on both sides

Browse Source 
Having the headings on both the left and right sides is more difficult
to edit and maintain, and not much is gained from having them on both
sides. It's still fine to have them on both sides, but this is a
stylistic choice left to the author.
This commit is contained in:
Andrew David Wong 2019-08-09 22:01:50 -05:00
parent 34f3da3731
commit 35e7f92bc7
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 1 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
developer/general/doc-guidelines.md
View File

@ -246,7 +246,7 @@ When making contributions, please try to observe the following style conventions
* Use hanging indentations
where appropriate.
* Use underline headings (`=====` and `-----`) if possible.
If this is not possible, use Atx-style headings on both the left and right sides (`### H3 ###`).
If this is not possible, use Atx-style headings: (`### H3 ###`).
* When writing code blocks, use [syntax highlighting](https://github.github.com/gfm/#info-string) where [possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers) and use `[...]` for anything omitted.
* When providing command line examples:
* Tell the reader where to open a terminal (dom0 or a specific domU), and show the command along with its output (if any) in a code block, e.g.: