File tree Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Expand file tree Collapse file tree 1 file changed +15
-5
lines changed Original file line number Diff line number Diff line change 2
2
3
3
Plugin to improve viewing Markdown files in Neovim
4
4
5
- Plugin is experimental at this time
6
-
7
5
![ Demo] ( demo/demo.gif )
8
6
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
+
9
19
# Features
10
20
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 ` # `
14
24
- Highlights code blocks to better stand out
15
25
- Replaces whichever style bullet point is being used with provided character
16
26
- Updates table boarders with better boarder characters, does NOT automatically align
You can’t perform that action at this time.
0 commit comments