Skip to content

Commit 979f36e

Browse files
Move purpose section towards bottom, keep top around usage
1 parent d9ad50f commit 979f36e

File tree

1 file changed

+12
-12
lines changed

1 file changed

+12
-12
lines changed

README.md

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -4,18 +4,6 @@ Plugin to improve viewing Markdown files in Neovim
44

55
![Demo](demo/demo.gif)
66

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-
197
# Features
208

219
- Functions entirely inside of Neovim with no external windows
@@ -110,6 +98,18 @@ require('markdown').setup({
11098
})
11199
```
112100

101+
# Purpose
102+
103+
There are many existing markdown rendering plugins in the Neovim ecosystem. However,
104+
most of these rely on syncing a separate browser window with the buffer. This is the
105+
correct way to do things to get full feature support, however I wanted something that
106+
worked completely inside of Neovim and made things look slightly "nicer".
107+
108+
The closest one I found to this was [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim),
109+
which is an awesome plugin that I took several ideas from. However it just didn't have
110+
quite what I was looking for. In particular I wanted something that would disappear completely
111+
when editing a file and quickly render some style when viewing the file. Hence this plugin.
112+
113113
# Related Projects
114114

115115
- [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim) - Same high level

0 commit comments

Comments
 (0)