Skip to content

Commit d7f400b

Browse files
Update README to follow markdownlint conventions, aside from multiple H1s
1 parent cdc58f5 commit d7f400b

File tree

1 file changed

+15
-12
lines changed

1 file changed

+15
-12
lines changed

README.md

+15-12
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ Plugin to improve viewing Markdown files in Neovim
2020
# Dependencies
2121

2222
- [markdown & markdown_inline](https://github.com/tree-sitter-grammars/tree-sitter-markdown)
23-
parsers for [treesitter](https://github.com/nvim-treesitter/nvim-treesitter): Used to parse
24-
`markdown` files
23+
parsers for [treesitter](https://github.com/nvim-treesitter/nvim-treesitter):
24+
Used to parse `markdown` files
2525
- [pylatexenc](https://pypi.org/project/pylatexenc/): Used to transform `LaTeX` strings
2626
to appropriate unicode using `latex2text`, not a mandatory dependency
2727

@@ -137,18 +137,21 @@ require('render-markdown').setup({
137137
# Purpose
138138

139139
There are many existing markdown rendering plugins in the Neovim ecosystem. However,
140-
most of these rely on syncing a separate browser window with the buffer. This is the
141-
correct way to do things to get full feature support, however I wanted something that
142-
worked completely inside of Neovim and made things look slightly "nicer".
140+
most of these rely on syncing a separate browser window with the buffer. This is
141+
the correct way to do things to get full feature support, however I wanted something
142+
that worked completely inside of Neovim and made things look slightly "nicer".
143143

144144
The closest one I found to this was [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim),
145-
which is an awesome plugin that I took several ideas from. However it just didn't have
146-
quite what I was looking for. In particular I wanted something that would disappear completely
147-
when editing a file and quickly render some style when viewing the file. Hence this plugin.
145+
which is an awesome plugin that I took several ideas from. However it just didn't
146+
have quite what I was looking for. In particular I wanted something that would
147+
disappear completely when editing a file and quickly render some style when viewing
148+
the file. Hence this plugin.
148149

149150
# Related Projects
150151

151-
- [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim) - Same high level
152-
idea different features
153-
- [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) - Uses browser
154-
- [vim-markdown-composer](https://github.com/euclio/vim-markdown-composer) - Uses browser
152+
- [headlines.nvim](https://github.com/lukas-reineke/headlines.nvim) - Same high
153+
level idea different features
154+
- [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim) - Uses
155+
browser
156+
- [vim-markdown-composer](https://github.com/euclio/vim-markdown-composer) - Uses
157+
browser

0 commit comments

Comments
 (0)