diff --git a/README.md b/README.md new file mode 100644 index 0000000..5c798e1 --- /dev/null +++ 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]`