Skip to content

Commit 7c1f882

Browse files
authored
Merge pull request #311 from mrjones2014/bot/vimdoc/master
chore: generated vimdoc
2 parents 52c3ec4 + 86947f6 commit 7c1f882

File tree

2 files changed

+7
-17
lines changed

2 files changed

+7
-17
lines changed

doc/smart-splits.txt

+7-16
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,6 @@ Key Mappings ..................................... |smart-splits-key-mappings|
1212
Lua API ............................................... |smart-splits-lua-api|
1313
Multiplexer Integrations ............. |smart-splits-multiplexer-integrations|
1414
Tmux ..................................................... |smart-splits-tmux|
15-
Quirks with Alacritty ................... |smart-splits-quirks-with-alacritty|
1615
Zellij ................................................. |smart-splits-zellij|
1716
Wezterm ............................................... |smart-splits-wezterm|
1817
Kitty ................................................... |smart-splits-kitty|
@@ -234,6 +233,10 @@ If you are a legendary.nvim <https://github.com/mrjones2014/legendary.nvim>
234233
extension documentation in `legendary.nvim`
235234
<https://github.com/mrjones2014/legendary.nvim/blob/master/doc/EXTENSIONS.md#smart-splitsnvim>.
236235

236+
[!NOTE] The recommended mappings use the Alt/Meta key. In some terminals, such
237+
as Alacritty and Ghostty, on macOS you will need to set a configuration option
238+
for it to treat the macOS Option key as Alt
239+
237240
>lua
238241
require('legendary').setup({
239242
extensions = {
@@ -336,8 +339,9 @@ LUA API *smart-splits-lua-api*
336339
MULTIPLEXER INTEGRATIONS *smart-splits-multiplexer-integrations*
337340

338341
`smart-splits.nvim` can also enable seamless navigation between Neovim splits
339-
and `tmux`, `wezterm`, or `kitty` panes. You will need to set up keymaps in
340-
your `tmux`, `wezterm`, or `kitty` configs to match the Neovim keymaps.
342+
and `tmux`, `zellij`, `wezterm`, or `kitty` panes. You will need to set up
343+
keymaps in your `tmux`, `wezterm`, or `kitty` configs to match the Neovim
344+
keymaps.
341345

342346
You can also set the desired multiplexer integration in lazy environments
343347
before the plugin is loaded by setting
@@ -414,19 +418,6 @@ resize amount if desired):
414418
bind-key -T copy-mode-vi 'C-\' select-pane -l
415419
<
416420

417-
QUIRKS WITH ALACRITTY *smart-splits-quirks-with-alacritty*
418-
419-
By default, on macOS, Alacritty does not treat the `Option` key as an
420-
`Alt`/`Meta` key. This is not useful and probably not what you want. If you
421-
want to use `Option` key as an `Alt` key for keymaps in `tmux`, you will have
422-
to configure Alacritty to interpret the key code correctly. \ reference
423-
<https://alacritty.org/config-alacritty.html#s20>
424-
425-
>yaml
426-
window:
427-
option_as_alt: "Both" # or "OnlyLeft" or "OnlyRight" if you prefer
428-
<
429-
430421

431422
ZELLIJ *smart-splits-zellij*
432423

doc/tags

-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,6 @@ smart-splits-kitty smart-splits.txt /*smart-splits-kitty*
1111
smart-splits-lua-api smart-splits.txt /*smart-splits-lua-api*
1212
smart-splits-multiplexer-integrations smart-splits.txt /*smart-splits-multiplexer-integrations*
1313
smart-splits-multiplexer-lua-api smart-splits.txt /*smart-splits-multiplexer-lua-api*
14-
smart-splits-quirks-with-alacritty smart-splits.txt /*smart-splits-quirks-with-alacritty*
1514
smart-splits-table-of-contents smart-splits.txt /*smart-splits-table-of-contents*
1615
smart-splits-tmux smart-splits.txt /*smart-splits-tmux*
1716
smart-splits-usage smart-splits.txt /*smart-splits-usage*

0 commit comments

Comments
 (0)