Skip to content

Commit

Permalink
Add options in README
Browse files Browse the repository at this point in the history
  • Loading branch information
tuurep committed Jul 23, 2024
1 parent 7a5336c commit d2cea5e
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,6 +11,16 @@ NeoVim is supported.
- all open viewers automatically scroll to keep in sync with your cursor in Vim
- open the current buffer's contents in vivify with `:Vivify`

## Configuration

- `g:vivify_instant_refresh = 1`
- refresh page contents on `TextChanged` and `TextChangedI` (default)
- `g:vivify_instant_refresh = 0`
- refresh page contents on `CursorHold` and `CursorHoldI`
- `g:vivify_filetypes`
- additional filetypes to recognize as markdown
- for example `let g:vivify_filetypes = ['vimwiki']`

## Installation

With [vivify](https://github.com/jannis-baum/vivify) installed in your PATH, you
Expand Down

0 comments on commit d2cea5e

Please sign in to comment.