Skip to content

docs(readme): add usage example for enabling text wrapping in scrollback buffer #339

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

Open
xeon826 wants to merge 1 commit into
base: main
Choose a base branch
from
Open

docs(readme): add usage example for enabling text wrapping in scrollback buffer #339

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
18 changes: 18 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -656,6 +656,24 @@ The configuration precedence is `default` > `global` > `builtin` > `user` where
}
```

#### Enabling Text Wrapping

To enable text wrapping in the scrollback buffer, you can use the `after_launch` callback to set the `wrap` option:

```lua
require('kitty-scrollback').setup({
{
callbacks = {
after_launch = function(kitty_data, opts)
vim.o.wrap = true
end,
},
},
})
```

This configuration enables text wrapping for the entire scrollback buffer, making long lines wrap to fit within the window width. The `after_launch` callback is executed after the scrollback buffer has been loaded but before the cursor is positioned, making it an ideal place to set buffer-specific options like text wrapping.

### Nerd Fonts

By default, `kitty-scrollback.nvim` uses [Nerd Fonts](https://www.nerdfonts.com) in the status window. If you would like to
Expand Down