Changes based on feedback from Brett Weir, to incorporate a convention around using backticks for commands, filepaths, etc.

This commit is contained in:
Rowan Puttergill 2026-07-17 11:57:18 +01:00
commit 9fcfd4fa81

View file

@ -30,10 +30,16 @@ EOF
----
```
TIP: By quoting the 'EOF' in the command, you can often avoid bash variable expansion if the file contains variable strings. Read more on HEREDOC at [The Linux Documentation Project](https://tldp.org/LDP/abs/html/here-docs.html).
TIP: By quoting the 'EOF' in the command, you can avoid bash variable expansion if the file contains variable strings. Read more on HEREDOC at [The Linux Documentation Project](https://tldp.org/LDP/abs/html/here-docs.html).
## Codeblocks and Command Syntax
When referencing commands, filepaths, or functions, in inline text, surround these with backticks (\`). For example:
```
Run the `echo` command and pipe to `tee` using `sudo` to output to `/etc/config.ini`.
```
Codeblock class directives for shell interactions should use the `[source,console]` classes. This helps to handle the exclusion of the shell prompt in a copy action, and provides some shell syntax highlighting.
Although Asciidoc supports a variety of codeblock delimiters, we always use `----` to indicate the start and the end of a block.