wiki-grav/README.md

54 lines
1.2 KiB
Markdown
Raw Normal View History

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-21 13:21:53 +02:00
#### Sudo
Although I try to avoid using `sudo`, in some cases it is quite handy. Examples can be seen on the Nextcloud page, where commands **need** to be executed as `www-data`.
Following a [post on lemmy](https://programming.dev/post/569497), I learned of a cool way to do this with just `su`
This example copies a file in the web directory, using the user `www-data`. Command blocks using this style should be prefixed with `#` using `[shroot]`
````
[shroot]
```
su -s /bin/sh -c 'cp /var/www/html/html1 /var/www/html/html2' www-data
```
[/shroot]
````
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]`