summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMetin Yazici <me@strboul.com>2024-01-05 15:40:49 +0100
committerMetin Yazici <me@strboul.com>2024-01-05 15:51:42 +0100
commitb72a8f96994f5e91e2168c63effb38f3f6e17b25 (patch)
tree3eef92446e13e770ec5192a3e819df18cd0d7af7
parent9e20adeb4140dd11cd74f91e0b38e48438bbd1c9 (diff)
Add vim docs about cheat syntax highlighting
-rw-r--r--docs/vim.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/docs/vim.md b/docs/vim.md
new file mode 100644
index 0000000..914da75
--- /dev/null
+++ 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^\$.*$"
+```