2023-07-11 17:50:25 +02:00
|
|
|
# Style guide
|
|
|
|
|
|
|
|
|
|
## Code blocks
|
|
|
|
|
|
|
|
|
|
PrismJS is used to provide highlighting when the right programming language name is given
|
|
|
|
|
|
|
|
|
|
### Bash / SH
|
|
|
|
|
|
|
|
|
|
Shell highlighting uses additional keywords in markdown to set a desired prefix
|
|
|
|
|
|
|
|
|
|
Available options are `[shroot]` and `[shuser]`
|
|
|
|
|
|
|
|
|
|
Usage:
|
|
|
|
|
|
|
|
|
|
````
|
|
|
|
|
[shroot]
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
echo hello
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
[/shroot]
|
|
|
|
|
````
|
|
|
|
|
|
2023-07-12 20:05:16 +02:00
|
|
|
To filter outputlines, prepend them with `(out)`.
|
|
|
|
|
Don't put a space between the keyword and the output
|
|
|
|
|
|
|
|
|
|
```
|
|
|
|
|
lsusb -d 0781:55a3 -v | grep bcdUSB
|
|
|
|
|
(out)bcdUSB 3.20
|
|
|
|
|
```
|
|
|
|
|
|
2023-07-11 17:50:25 +02:00
|
|
|
## Variables / Fill your own
|
|
|
|
|
|
|
|
|
|
Values that should be replaced by the reader are generally represented this way:
|
|
|
|
|
`[VALUE]`
|
