Commit a38f4d9f authored by Achilleas Pipinellis's avatar Achilleas Pipinellis

Merge branch '199675-code-block-styling' into 'master'

Provide more specifics on formatting code blocks in docs

Closes #199675

See merge request gitlab-org/gitlab!24022
parents 6ad7f2d8 1bdd9cc9
...@@ -771,6 +771,9 @@ nicely on different mobile devices. ...@@ -771,6 +771,9 @@ nicely on different mobile devices.
To make things easier for the user, always add a full code block for things that can be To make things easier for the user, always add a full code block for things that can be
useful to copy and paste, as they can easily do it with the button on code blocks. useful to copy and paste, as they can easily do it with the button on code blocks.
- Add a blank line above and below code blocks. - Add a blank line above and below code blocks.
- When providing a shell command and its output, prefix the shell command with `$` and
leave a blank line between the command and the output.
- When providing a command without output, don't prefix the shell command with `$`.
- For regular code blocks, always use a highlighting class corresponding to the - For regular code blocks, always use a highlighting class corresponding to the
language for better readability. Examples: language for better readability. Examples:
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment