aboutsummaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorFlorian Fischer <florian.fischer@muhq.space>2025-07-30 13:47:28 +0200
committerFlorian Fischer <florian.fischer@muhq.space>2026-01-30 18:01:24 +0100
commit4ec576b6d600711160f7e3d10bbe60308c5b232c (patch)
tree07cc234cd2b15a898d5004f03d60e6d49ad84036 /README.md
parentc12e2a1fc0ff5a4172552196627d8b1d221b66fe (diff)
downloadvis-lspc-4ec576b6d600711160f7e3d10bbe60308c5b232c.tar.gz
vis-lspc-4ec576b6d600711160f7e3d10bbe60308c5b232c.zip
make navigation window configurable and add key bindings
Diffstat (limited to 'README.md')
-rw-r--r--README.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/README.md b/README.md
index de1206a..a5ff2d5 100644
--- a/README.md
+++ b/README.md
@@ -76,7 +76,14 @@ Alternatively, a plugin manager like [vis-plug](https://github.com/erf/vis-plug)
<K> - hover over current position
Normal and Insert mode:
<C- > - get completions
+ < o> - open the symbol navigation window
+#### Non-Auto-Jump Navigation Window
+
+ Normal mode:
+ < s> - scroll to the selected symbol
+ < j> - jump to the selected symbol (switch to the code window)
+ < x> - close the navigaion window
### Available commands
@@ -133,6 +140,9 @@ Available options are:
* `show_message = 'message'` - how to present information. `'message'`: use `vis:message`; `'open'`: use a new window supporting syntax highlighting.
* `universal_root_globs = {}` - Globs to consider as workspace root for any language server (e.g. `*.git` or `*.hg`).
* `fallback_dirname_as_root = false` - If set to true a file's directory is used as workspace root if no explicit root was found.
+* `navwin_symbols_format = '%s[%.1s] %s\n'` - The format string used to display a symbol in the symbol navigation window.
+* `navwin_auto_scroll = true` - If set to true the code window will scroll to the currently selected symbol in the navigation window without user interaction.
+* `navwin_layout = 'vr'` - Layout where the navigation window will be placed (`v[r|l]|h[t|b]`: vertical right or left; horizontal top or bottom).
#### Configure your own Language Server