chore: generated vimdoc

doc/smart-splits.txt

@@ -6,13 +6,15 @@ Table of Contents                             *smart-splits-table-of-contents*
 Install ............................................... |smart-splits-install|
 Configuration ................................... |smart-splits-configuration|
 Hooks ................................................... |smart-splits-hooks|
+Examples ............................................. |smart-splits-examples|
 Usage ................................................... |smart-splits-usage|
 Key Mappings ..................................... |smart-splits-key-mappings|
 Lua API ............................................... |smart-splits-lua-api|
 Multiplexer Integrations ............. |smart-splits-multiplexer-integrations|
 Tmux ..................................................... |smart-splits-tmux|
 Wezterm ............................................... |smart-splits-wezterm|
 Kitty ................................................... |smart-splits-kitty|
+Credits ............................................... |smart-splits-credits|
 Multiplexer Lua API ....................... |smart-splits-multiplexer-lua-api|
 
 ==============================================================================
@@ -178,10 +180,8 @@ The hook table allows you to define callbacks for the `on_enter` and
 `on_leave` events of the resize mode.
 
 
-==============================================================================
 EXAMPLES                                               *smart-splits-examples*
 
-
 Integration with bufresize.nvim
 <https://github.com/kwkarlwang/bufresize.nvim>:
 
@@ -484,6 +484,9 @@ KITTY                                                     *smart-splits-kitty*
   [!NOTE] The `config.at_edge = 'wrap'` option is not supoprted in Kitty
   terminal multiplexer due to inability to determine pane layout from CLI.
 
+  [!NOTE] This won't work if the pane is connected over SSH, as the pane will
+  not properly report the foreground process name.
+
 Add the following snippet to `~/.config/kitty/kitty.conf`, adjusting the
 keymaps and resize amount as desired.
 
@@ -499,20 +502,17 @@ keymaps and resize amount as desired.
     map alt+h kitten pass_keys.py relative_resize left  3 alt+h
     map alt+l kitten pass_keys.py relative_resize right 3 alt+l
 <
-By default the nvim plugin sets a kitty user-var `in_editor` via autocmd when
-the plugin loads. You can take advantage of this together with kittys
-[conditional mappings feature](https://sw.kovidgoyal.net/kitty/mapping/#conditional-mappings-depending-on-the-state-of-the-focused-window)
-
-    map ctrl+j neighboring_window down
-    map ctrl+k neighboring_window up
-    map ctrl+h neighboring_window left
-    map ctrl+l neighboring_window right
-
-    map --when-focus-on var:in_editor ctrl+j
-    map --when-focus-on var:in_editor ctrl+k
-    map --when-focus-on var:in_editor ctrl+h
-    map --when-focus-on var:in_editor ctrl+l
+By default, it matches against the name of the current foreground process to
+detect if `vim`/`nvim` is running. If that doesn't work for you, or you want
+to include other CLI/TUI programs in the exclusion, you can provide an
+additional regex argument:
 
+>
+    map ctrl+j kitten pass_keys.py neighboring_window bottom ctrl+j "^.* - nvim$"
+    map ctrl+k kitten pass_keys.py neighboring_window top    ctrl+k "^.* - nvim$"
+    map ctrl+h kitten pass_keys.py neighboring_window left   ctrl+h "^.* - nvim$"
+    map ctrl+l kitten pass_keys.py neighboring_window right  ctrl+l "^.* - nvim$"
+    
     # the 3 here is the resize amount, adjust as needed
     map alt+j kitten pass_keys.py relative_resize down  3 alt+j "^.* - nvim$"
     map alt+k kitten pass_keys.py relative_resize up    3 alt+k "^.* - nvim$"
@@ -541,10 +541,8 @@ Or, by adding the following to `~/.config/kitty/kitty.conf`:
     listen_on unix:/tmp/mykitty
 <
 
-==============================================================================
 CREDITS                                                 *smart-splits-credits*
 
-
 Thanks @knubie for inspiration for the Kitty implementation from
 vim-kitty-navigator <https://github.com/knubie/vim-kitty-navigator>.
 
@@ -578,4 +576,4 @@ currently in use. The API offers the following methods:
     ---@field type 'tmux'|'wezterm'|'kitty'
 <
 
-vim:tw=78:ts=8:ft=help:norl:
+vim:tw=78:ts=8:ft=help:norl: