Add readme for style guide

This commit is contained in:
exu 2023-07-11 17:50:25 +02:00
parent e3909dfae7
commit a97db82095

28
README.md Normal file
View File

@ -0,0 +1,28 @@
# 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]
````
## Variables / Fill your own
Values that should be replaced by the reader are generally represented this way:
`[VALUE]`