Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

chore: generated vimdoc #165

Merged
merged 1 commit into from
Mar 11, 2024
Merged

chore: generated vimdoc #165

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
20 changes: 10 additions & 10 deletions doc/smart-splits.txt
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
*smart-splits.txt* Last change: 2024 March 04
*smart-splits.txt* Last change: 2024 March 11

==============================================================================
Table of Contents *smart-splits-table-of-contents*
Expand Down Expand Up @@ -73,7 +73,7 @@ nvim-tree.lua <https://github.com/kyazdani42/nvim-tree.lua> which tries to
maintain its own width unless manually resized. Note that nothing is ignored
when moving between splits, only when resizing.

**Note** `smart-splits.nvim` does not map any keys on it's own. See Usage
[!NOTE] `smart-splits.nvim` does not map any keys on it's own. See Usage
<#usage>.

Defaults are shown below:
Expand Down Expand Up @@ -372,16 +372,16 @@ file (customizing the keys and resize amount if desired):

WEZTERM *smart-splits-wezterm*

**Note** It is recommended _not to lazy load_ `smart-splits.nvim` if using the
[!NOTE] It is recommended _not to lazy load_ `smart-splits.nvim` if using the
Wezterm integration. If you need to lazy load, you need to use a different
`is_vim()` implementation below. The plugin is small, and smart about not
loading modules unnecessarily, so it should have minimal impact on your
startup time. It adds about 0.07ms on my setup.

**Note** Pane resizing currently requires a nightly build of Wezterm. Check
the output of `wezterm cli adjust-pane-size --help` to see if your build
supports it; if not, you can check how to obtain a nightly build by following
the instructions here <https://wezfurlong.org/wezterm/installation.html>.
[!NOTE] Pane resizing currently requires a nightly build of Wezterm. Check the
output of `wezterm cli adjust-pane-size --help` to see if your build supports
it; if not, you can check how to obtain a nightly build by following the
instructions here <https://wezfurlong.org/wezterm/installation.html>.

First, ensure that the `wezterm` CLI is on your `$PATH`, as the CLI is used by
the integration.
Expand Down Expand Up @@ -481,10 +481,10 @@ Otherwise, add the following snippet to your `~/.config/wezterm/wezterm.lua`:

KITTY *smart-splits-kitty*

**Note** `config.at_edge = 'wrap'` is not supoprted in Kitty terminal
multiplexer due to inability to determine pane layout from CLI.
[!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
[!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
Expand Down