Skip to content

Commit

Permalink
chore(build): auto-generate vimdoc
Browse files Browse the repository at this point in the history
  • Loading branch information
github-actions[bot] committed Nov 1, 2023
1 parent 537858e commit 18c1142
Showing 1 changed file with 14 additions and 6 deletions.
20 changes: 14 additions & 6 deletions doc/kitty-scrollback.nvim.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,7 +72,7 @@ MIGRATING TO V2.0.0 *kitty-scrollback.nvim-migrating-to-v2.0.0*
The Kitten defined in `kitty.conf` references the configuration file `get_text_last_cmd_output.lua`
>kitty
# Browse output of the last shell command in nvim
map ctrl+shift+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
map kitty_mod+g kitty_scrollback_nvim --config-file get_text_last_cmd_output.lua
<
>lua
-- get_text_last_cmd_output.lua
Expand All @@ -92,7 +92,7 @@ MIGRATING TO V2.0.0 *kitty-scrollback.nvim-migrating-to-v2.0.0*
The Kitten defined in `kitty.conf` references the builtin configuration name `ksb_builtin_last_cmd_output`
>kitty
# Browse output of the last shell command in nvim
map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
<
>lua
require('kitty-scrollback').setup({
Expand Down Expand Up @@ -255,7 +255,15 @@ The following steps outline how to properly configure kitty.conf

- Follow the instructions of any `ERROR` or `WARNINGS` reported during the healthcheck

- Test kitty-scrollback.nvim is working as expected by pressing ctrl+shift+h to open the scrollback buffer in Neovim
- Test kitty-scrollback.nvim is working as expected by pressing kitty_mod+h to open the scrollback buffer in Neovim

`kitty_mod` is a special modifier key alias for default shortcuts. You can
change the value of this option to alter all default shortcuts that use
`kitty_mod`. See Kitty documentation #opt-kitty.kitty_mod
<https://sw.kovidgoyal.net/kitty/conf/#opt-kitty.kitty_mod>.

The default value of `kitty_mod` is `ctrl+shift`. In this example,
`kitty_mod+h` represents `ctrl+shift+h`.

- See example kitty.conf for reference

Expand All @@ -268,11 +276,11 @@ The following steps outline how to properly configure kitty.conf
action_alias kitty_scrollback_nvim kitten /Users/mike/gitrepos/kitty-scrollback.nvim/python/kitty_scrollback_nvim.py

# Browse scrollback buffer in nvim
map ctrl+shift+h kitty_scrollback_nvim
map kitty_mod+h kitty_scrollback_nvim
# Browse output of the last shell command in nvim
map ctrl+shift+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
map kitty_mod+g kitty_scrollback_nvim --config ksb_builtin_last_cmd_output
# Show clicked command output in nvim
mouse_map ctrl+shift+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output
mouse_map kitty_mod+right press ungrabbed combine : mouse_select_command_output : kitty_scrollback_nvim --config ksb_builtin_last_visited_cmd_output
<


Expand Down

0 comments on commit 18c1142

Please sign in to comment.