From 3f25b1c8c999f9660a0f6a1978901a78ab87e1c2 Mon Sep 17 00:00:00 2001 From: Tobias Killer Date: Sun, 2 Dec 2018 15:58:47 +0100 Subject: [PATCH] Fix format --- basics_user/doc-guidelines.md | 25 ++++++++++++++----------- 1 file changed, 14 insertions(+), 11 deletions(-) diff --git a/basics_user/doc-guidelines.md b/basics_user/doc-guidelines.md index 8d246bab..a1d5af97 100644 --- a/basics_user/doc-guidelines.md +++ b/basics_user/doc-guidelines.md @@ -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).