Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2025-02-17 21:34:17 -05:00
Code Issues Packages Projects Releases Wiki Activity

Add Markdown conventions for files and shell sessions

Browse Source 
Concerns issue #4179.
This commit is contained in:
Tobias Killer 2018-12-02 15:49:51 +01:00
parent e36b26c5f4
commit 8d1fa2f6be
No known key found for this signature in database
GPG Key ID: 2DA5EF6F6E40B328
1 changed files with 16 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
basics_user/doc-guidelines.md
View File

@ -254,6 +254,22 @@ When making contributions, please try to observe the following style conventions
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 ###`).
* When writing commands to be entered into a terminal:
* State in the text above the commands that the user shall open a terminal and run those commands. E.g.
~~~markdown
Open a terminal in your AppVM and run
```shell_session
$ cd test
$ echo Hello
Hello
```
~~~
* Precede each command with a non-empty prompt that fits the needs. As a minimum, the prompt should contain a trailing `#` (for the user `root`) or `$` (for other users) on Linux systems and `>` on Windows systems, respectively.
* Put the expected output below the command as usual or use a separate code block for that. You should write `[...]` for omitted parts of the output.
* Use [syntax highlighting](https://github.github.com/gfm/#info-string) where [possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers).
* When quoting (script) files:
* Use code blocks with [syntax highlighting](https://github.github.com/gfm/#info-string) where [possible](https://github.com/jneen/rouge/wiki/List-of-supported-languages-and-lexers).
* You should write `[...]` for omitted parts.
* Use `[reference-style][ref]` links.
`[ref]: https://daringfireball.net/projects/markdown/syntax#link`