Skip to content

docs: Add VIM usage instructions for leaf #119

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

Closed
111110100 wants to merge 1 commit into from
Closed

docs: Add VIM usage instructions for leaf #119

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
9 changes: 9 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,6 +153,15 @@ find . -name '*.md' | fzf --preview 'leaf --inline ansi {}'
find . -name '*.md' | fzf --preview 'leaf --inline ansi:$FZF_PREVIEW_COLUMNS {}'
```

## Using with VIM

To configure keybindings with `vim` that opens a vertical split and run `leaf -w` to preview current markdown file. The shortcut **\md** (pressing `\` followed by `md`). Pressing `CTRL+w,h` moves the focus back to the main Markdown file for editing. Add the following to your `~/.vimrc` file:

```vim
" Pressing <Leader>m will open a vertical split on the right and run leaf
nnoremap <Leader>md :vertical botright terminal leaf -w %<CR>
```

## Configuration

Set default values for theme, editor, and watch mode via `config.toml`:
Expand Down
Loading