From 9e12706bbf542761064b4e1750f050e733634f04 Mon Sep 17 00:00:00 2001 From: "github-actions[bot]" Date: Sat, 25 Nov 2023 18:04:42 +0000 Subject: [PATCH] chore(build): auto-generate vimdoc --- doc/kitty-scrollback.nvim.txt | 12 ++++++++-- doc/kitty-scrollback.nvim_spec.txt | 36 +++++++++++++++++++----------- 2 files changed, 33 insertions(+), 15 deletions(-) diff --git a/doc/kitty-scrollback.nvim.txt b/doc/kitty-scrollback.nvim.txt index bd3974c3..0c57b93b 100644 --- a/doc/kitty-scrollback.nvim.txt +++ b/doc/kitty-scrollback.nvim.txt @@ -1,4 +1,4 @@ -*kitty-scrollback.nvim.txt* For NVIM v0.9+ Last change: 2023 November 24 +*kitty-scrollback.nvim.txt* For NVIM v0.9+ Last change: 2023 November 25 ============================================================================== Table of Contents *kitty-scrollback.nvim-table-of-contents* @@ -401,7 +401,15 @@ KITTY-SCROLLBACK.NVIM CONFIGURATION FILE ~ status_window.show_timer boolean If true, show a timer in the status window while kitty-scrollback.nvim is loading - paste_window KsbPasteWindowOpts? options for paste window that sends commands to Kitty + status_window.icons KsbStatusWindowIcons? Icons displayed in the status window, defaults to 󰄛 󰣐 + + status_window.icons.kitty string kittystatus window icon, defaults to 󰄛 + + status_window.icons.heart string heart string heart status window icon, defaults to 󰣐 + + status_window.icons.nvim string nvim status window icon, defaults to + + paste_window KsbPasteWindowOpts? optionsfor paste window that sends commands to Kitty paste_window.highlight_as_normal_win fun(): boolean? If function returns true, use Normal highlight group. If false, use NormalFloat diff --git a/doc/kitty-scrollback.nvim_spec.txt b/doc/kitty-scrollback.nvim_spec.txt index 42f35a20..e76f14e0 100644 --- a/doc/kitty-scrollback.nvim_spec.txt +++ b/doc/kitty-scrollback.nvim_spec.txt @@ -61,14 +61,24 @@ KsbKittyGetText *kitty-scrollback.launch.KsbKittyGetText* {extent} (string|"screen"|"all"|"selection"|"first_cmd_output_on_screen"|"last_cmd_output"|"last_visited_cmd_output"|"last_non_empty_output") What text to get. The default of screen means all text currently on the screen. all means all the screen+scrollback and selection means the currently selected text. first_cmd_output_on_screen means the output of the first command that was run in the window on screen. last_cmd_output means the output of the last command that was run in the window. last_visited_cmd_output means the first command output below the last scrolled position via scroll_to_prompt. last_non_empty_output is the output from the last command run in the window that had some non empty output. The last four require shell_integration to be enabled. Choices: screen, all, first_cmd_output_on_screen, last_cmd_output, last_non_empty_output, last_visited_cmd_output, selection + *kitty-scrollback.launch.KsbStatusWindowIcons* +KsbStatusWindowIcons + + Fields: ~ + {kitty} (string) kitty status window icon, defaults to 󰄛 + {heart} (string) heart status window icon, defaults to 󰣐 + {nvim} (string) nvim status window icon, defaults to  + + *kitty-scrollback.launch.KsbStatusWindowOpts* KsbStatusWindowOpts Fields: ~ - {enabled} (boolean) If true, show status window in upper right corner of the screen - {style_simple} (boolean) If true, use plaintext instead of nerd font icons - {autoclose} (boolean) If true, close the status window after kitty-scrollback.nvim is ready - {show_timer} (boolean) If true, show a timer in the status window while kitty-scrollback.nvim is loading + {enabled} (boolean) If true, show status window in upper right corner of the screen + {style_simple} (boolean) If true, use plaintext instead of nerd font icons + {autoclose} (boolean) If true, close the status window after kitty-scrollback.nvim is ready + {show_timer} (boolean) If true, show a timer in the status window while kitty-scrollback.nvim is loading + {icons} (KsbStatusWindowIcons) Icons displayed in the status window, defaults to 󰄛 󰣐  KsbWinOpts *kitty-scrollback.launch.KsbWinOpts* @@ -108,15 +118,15 @@ KsbPasteWindowOpts KsbOpts *kitty-scrollback.launch.KsbOpts* Fields: ~ - {callbacks} (KsbCallbacks|nil) fire and forget callback functions - {keymaps_enabled} (boolean|nil) if true, enabled all default keymaps - {restore_options} (boolean|nil) if true, restore options that were modified while processing the scrollback buffer - {highlight_overrides} (KsbHighlights|nil) kitty-scrollback.nvim highlight overrides - {status_window} (KsbStatusWindowOpts|nil) options for status window indicating that kitty-scrollback.nvim is ready - {paste_window} (KsbPasteWindowOpts|nil) options for paste window that sends commands to Kitty - {kitty_get_text} (KsbKittyGetText|nil) options passed to get-text when reading scrollback buffer, see `kitty @ get-text --help` - {checkhealth} (boolean|nil) if true execute :checkhealth kitty-scrollback and skip setup - {visual_selection_highlight_mode} (string|"darken"|"kitty"|"nvim"|"reverse") + {callbacks} (KsbCallbacks|nil) fire and forget callback functions + {keymaps_enabled} (boolean|nil) if true, enabled all default keymaps + {restore_options} (boolean|nil) if true, restore options that were modified while processing the scrollback buffer + {highlight_overrides} (KsbHighlights|nil) kitty-scrollback.nvim highlight overrides + {status_window} (KsbStatusWindowOpts|nil) options for status window indicating that kitty-scrollback.nvim is ready + {paste_window} (KsbPasteWindowOpts|nil) options for paste window that sends commands to Kitty + {kitty_get_text} (KsbKittyGetText|nil) options passed to get-text when reading scrollback buffer, see `kitty @ get-text --help` + {checkhealth} (boolean|nil) if true execute :checkhealth kitty-scrollback and skip setup + {visual_selection_highlight_mode} (string|"darken"|"kitty"|"nvim"|"reverse"|nil) M.setup({kitty_data_str}) *kitty-scrollback.launch.setup*