Git-Mirrors/qubes-doc
1
0
Fork 0
mirror of https://github.com/QubesOS/qubes-doc.git synced 2024-10-01 01:25:40 -04:00
Code Issues Packages Projects Releases Wiki Activity

Fix format

Browse Source
This commit is contained in:
Tobias Killer 2018-12-02 15:58:47 +01:00
parent 8d1fa2f6be
commit 3f25b1c8c9
No known key found for this signature in database
GPG Key ID: 2DA5EF6F6E40B328
1 changed files with 14 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

25
basics_user/doc-guidelines.md
View File

@ -255,17 +255,20 @@ When making contributions, please try to observe the following style conventions
* 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.
* 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).