Merge pull request #870 from strboul/vim-colors

Add vim docs about cheat syntax highlighting
denisidoro · Jan 6, 2024 · 6968a23 · 6968a23
2 parents 9e20ade + b72a8f9
commit 6968a23
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/docs/vim.md b/docs/vim.md
@@ -0,0 +1,13 @@
+## vim
+
+If you want syntax highlighting support for Navi in Vim, add those syntax rules
+to your syntax files such as at `$VIMRUNTIME/syntax/navi.vim`.
+The rules are defined based on the [Cheatsheet syntax](cheatsheet_syntax.md).
+
+```vim
+syntax match Comment "\v^;.*$"
+syntax match Statement "\v^\%.*$"
+syntax match Operator "\v^\#.*$"
+syntax match String "\v\<.*\>"
+syntax match String "\v^\$.*$"
+```