forked from server/user-documentation
Changes based on feedback from Brett Weir, to incorporate a convention around using backticks for commands, filepaths, etc.
This commit is contained in:
parent
3c214148ed
commit
9fcfd4fa81
1 changed files with 7 additions and 1 deletions
8
STYLE.md
8
STYLE.md
|
|
@ -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.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue