Closed edibotopic closed 4 months ago
@CarlosNihelton --- I updated the PR with some of the following changes:
#
as a prompt symbol. We do not (currently) use it in these docs and I think we should avoid using a third symbol if possible (if needed we can just specify root
). In addition, a side-effect of including them now is that it creates problems in Python/PowerShell code blocks, where #
followed by whitespace (comments) can be marked as a prompt by the regex.contributing.md
on how the code blocks are implemented and things that a contributor should be aware of.
This PR improves the consistency and functionality of code blocks in the docs.
The main changes are:
A code block with the regular behaviour is written:
```{code-block) text PS C:\Users\myuser> echo $env:USERPROFILE ```
Result (note the button on cursor hover):
If we do not want the copy button, we write:
```{code-block) text :class: no-copy C:\Users\myuser ```
Result (note the lack of button on cursor hover):
The example below shows two lines with complex prompts and a symbol sometimes used as a prompt ($) in the commands (top). After the copy button is clicked, only the relevant information is pasted into the text editor (bottom). This means that users can more easily and quickly copy commands from the docs:
Other minor changes:
UDENG-3441