Mirrors/navi
1
0
Fork 0
mirror of https://github.com/denisidoro/navi.git synced 2026-01-23 02:14:19 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #961 from kit494way/docs-cheat-md

Browse source 
Add documentation on .cheat.md
This commit is contained in:
Alexis Opolka 2025-03-27 12:42:17 +01:00 • committed by GitHub
commit 6bdc59a460
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 17 additions and 3 deletions
Download patch file Download diff file Expand all files Collapse all files

20
docs/cheatsheet_syntax.md
View file

@ -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
@ -32,8 +32,22 @@ Lines starting with:
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).
> [!TIP]
> If you are editing cheatsheets in Visual Studio Code, you could enable syntax highlighting
> by installing this extension: [@yanivmo/navi-cheatsheet-language](https://marketplace.visualstudio.com/items?itemName=yanivmo.navi-cheatsheet-language).
You can place commands in code blocks fenced with triple backticks (```` ``` ````).
````sh
% git, code
# Change branch
```sh
git checkout <branch>
```
$ branch: git branch | awk '{print $NF}'
````
### Variables