diff --git a/docs/cheatsheet_syntax.md b/docs/cheatsheet_syntax.md index 78d8a5e..53f053c 100644 --- a/docs/cheatsheet_syntax.md +++ b/docs/cheatsheet_syntax.md @@ -11,7 +11,7 @@ ### Syntax overview -Cheatsheets are described in `.cheat` files that look like this: +Cheatsheets are described in `.cheat` (or `.cheat.md`) files that look like this: ```sh % git, code @@ -35,6 +35,19 @@ All the other non-empty lines are considered as executable commands. Tip: if you are editing cheatsheets in Visual Studio Code, you could enable syntax highlighting by installing [this extension](https://marketplace.visualstudio.com/items?itemName=yanivmo.navi-cheatsheet-language). +If you use `.cheat.md` as an extension of cheat files, you can place commands in code blocks fenced with triple backticks (```` ``` ````). + +````sh +% git, code + +# Change branch +```sh +git checkout +``` + +$ branch: git branch | awk '{print $NF}' +```` + ### Variables The interface prompts for variable names inside brackets (eg ``).