Add readme for style guide

2023-07-11 17:50:25 +02:00 · 2023-07-11 17:50:25 +02:00 · a97db82095
commit a97db82095
parent e3909dfae7
1 changed files with 28 additions and 0 deletions
--- a/README.md
+++ b/README.md
@ -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]`