Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-01-26 14:36:18 -05:00
Code Issues Packages Projects Releases Wiki Activity

Update Markdown conventions

Browse Source 
QubesOS/qubes-issues#1452
Closes QubesOS/qubes-issues#2639
This commit is contained in:
Andrew David Wong 2017-02-18 23:18:11 -08:00
parent ab474ee5d2
commit afffe66573
No known key found for this signature in database
GPG Key ID: 8CE137352A019A17
1 changed files with 5 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
basics_dev/doc-guidelines.md
View File

@ -140,7 +140,11 @@ All the documentation is written in Markdown for maximum accessibility. When
making contributions, please try to observe the following style conventions:
* Use spaces instead of tabs.
* Hard wrap Markdown lines at 80 characters.
* Insert a newline at the end of each sentence.
* Rationale: This practice is most appropriate for source that consists
primarily of natural language text. It results in the most useful diffs
and facilitates translation into other languages while mostly preserving
source readability.
* If appropriate, make numerals in numbered lists match between Markdown
source and HTML output.
* Rationale: In the event that a user is required to read the Markdown source