Skip to content

Commit d9ad50f

Browse files
Add some more details to README
1 parent 03a7c00 commit d9ad50f

File tree

1 file changed

+15
-5
lines changed

1 file changed

+15
-5
lines changed

README.md

Lines changed: 15 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -2,15 +2,25 @@
22

33
Plugin to improve viewing Markdown files in Neovim
44

5-
Plugin is experimental at this time
6-
75
![Demo](demo/demo.gif)
86

7+
# Purpose
8+
9+
There are many existing markdown rendering plugins in the Neovim ecosystem. However,
10+
most of these rely on syncing a separate browser window with the buffer. This is the
11+
correct way to do things to get full feature support, however I wanted something that
12+
worked completely inside of Neovim and made things look slightly "nicer".
13+
14+
The closest one I found to this was [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim),
15+
which is an awesome plugin that I took several ideas from. However it just didn't have
16+
quite what I was looking for. In particular I wanted something that would disappear completely
17+
when editing a file and quickly render some style when viewing the file. Hence this plugin.
18+
919
# Features
1020

11-
- Changes between `rendered` view in normal mode (exact modes are configurable)
12-
and raw view in all other modes
13-
- Highlights headings with different groups depending on level
21+
- Functions entirely inside of Neovim with no external windows
22+
- Changes between `rendered` view in normal mode and raw view in all other modes
23+
- Highlights headings with different groups depending on level and replaces `#`
1424
- Highlights code blocks to better stand out
1525
- Replaces whichever style bullet point is being used with provided character
1626
- Updates table boarders with better boarder characters, does NOT automatically align

0 commit comments

Comments
 (0)