Skip to content

Commit 0da97c0

Browse files
Update Related Projects section to general Markdown Ecosystem section with references to more available plugins
1 parent f5cc683 commit 0da97c0

File tree

2 files changed

+78
-14
lines changed

2 files changed

+78
-14
lines changed

README.md

+34-6
Original file line numberDiff line numberDiff line change
@@ -147,11 +147,39 @@ have quite what I was looking for. In particular I wanted something that would
147147
disappear completely when editing a file and quickly render some style when viewing
148148
the file. Hence this plugin.
149149

150-
# Related Projects
150+
# Markdown Ecosystem
151+
152+
There are many `markdown` plugins that specialize in different aspects of interacting
153+
with `markdown` files. This plugin specializes in rendering the buffer inside of
154+
Neovim, for instance. As a result some plugins will clash with this one, whereas
155+
other plugins handle orthogonal concerns and can be used in addition to this one.
156+
Below is a categorized (incomplete) list of available plugins.
157+
158+
## Render in Neovim
159+
160+
Using any of these plugins with this one will likely lead to undesired behavior as
161+
different functionality will clash.
151162

152163
- [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
164+
level idea and starting point of this plugin, but with different feature sets
165+
166+
## Render in Browser
167+
168+
These can be used as a second pass to get a real preview of the `markdown` file.
169+
Since they do not interact with the buffer directly there should be no issues.
170+
171+
- [markdown-preview.nvim](https://github.com/iamcco/markdown-preview.nvim)
172+
- [vim-markdown-composer](https://github.com/euclio/vim-markdown-composer)
173+
174+
## Orthogonal
175+
176+
These plugins handle functions completely separate from rendering and should also
177+
have no issues running alongside this plugin.
178+
179+
- Any LSP which provides standard LSP capabilities, such as:
180+
- [marksman](https://github.com/artempyanykh/marksman) - General completion,
181+
definition, and reference functionality
182+
- [markdown-oxide](https://github.com/Feel-ix-343/markdown-oxide) - Adds Obsidian
183+
PKM features to LSP
184+
- [markdown.nvim](https://github.com/tadmccorkle/markdown.nvim) - Adds `markdown`
185+
specific keybindings for interacting with `markdown` files

doc/render-markdown.txt

+44-8
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
*render-markdown.txt* For 0.9.5 Last change: 2024 March 27
1+
*render-markdown.txt* For 0.9.5 Last change: 2024 March 29
22

33
==============================================================================
44
Table of Contents *render-markdown-table-of-contents*
@@ -11,7 +11,10 @@ Table of Contents *render-markdown-table-of-contents*
1111
5. Setup |render-markdown-setup|
1212
6. Commands |render-markdown-commands|
1313
7. Purpose |render-markdown-purpose|
14-
8. Related Projects |render-markdown-related-projects|
14+
8. Markdown Ecosystem |render-markdown-markdown-ecosystem|
15+
- Render in Neovim |render-markdown-markdown-ecosystem-render-in-neovim|
16+
- Render in Browser |render-markdown-markdown-ecosystem-render-in-browser|
17+
- Orthogonal |render-markdown-markdown-ecosystem-orthogonal|
1518
9. Links |render-markdown-links|
1619

1720
==============================================================================
@@ -179,14 +182,47 @@ this plugin.
179182

180183

181184
==============================================================================
182-
8. Related Projects *render-markdown-related-projects*
185+
8. Markdown Ecosystem *render-markdown-markdown-ecosystem*
186+
187+
There are many `markdown` plugins that specialize in different aspects of
188+
interacting with `markdown` files. This plugin specializes in rendering the
189+
buffer inside of Neovim, for instance. As a result some plugins will clash with
190+
this one, whereas other plugins handle orthogonal concerns and can be used in
191+
addition to this one. Below is a categorized (incomplete) list of available
192+
plugins.
193+
194+
195+
RENDER IN NEOVIM *render-markdown-markdown-ecosystem-render-in-neovim*
196+
197+
Using any of these plugins with this one will likely lead to undesired behavior
198+
as different functionality will clash.
183199

184200
- headlines.nvim <https://github.com/lukas-reineke/headlines.nvim> - Same high
185-
level idea different features
186-
- markdown-preview.nvim <https://github.com/iamcco/markdown-preview.nvim> - Uses
187-
browser
188-
- vim-markdown-composer <https://github.com/euclio/vim-markdown-composer> - Uses
189-
browser
201+
level idea and starting point of this plugin, but with different feature sets
202+
203+
204+
RENDER IN BROWSER *render-markdown-markdown-ecosystem-render-in-browser*
205+
206+
These can be used as a second pass to get a real preview of the `markdown`
207+
file. Since they do not interact with the buffer directly there should be no
208+
issues.
209+
210+
- markdown-preview.nvim <https://github.com/iamcco/markdown-preview.nvim>
211+
- vim-markdown-composer <https://github.com/euclio/vim-markdown-composer>
212+
213+
214+
ORTHOGONAL *render-markdown-markdown-ecosystem-orthogonal*
215+
216+
These plugins handle functions completely separate from rendering and should
217+
also have no issues running alongside this plugin.
218+
219+
- Any LSP which provides standard LSP capabilities, such as:
220+
- marksman <https://github.com/artempyanykh/marksman> - General completion,
221+
definition, and reference functionality
222+
- markdown-oxide <https://github.com/Feel-ix-343/markdown-oxide> - Adds Obsidian
223+
PKM features to LSP
224+
- markdown.nvim <https://github.com/tadmccorkle/markdown.nvim> - Adds `markdown`
225+
specific keybindings for interacting with `markdown` files
190226

191227
==============================================================================
192228
9. Links *render-markdown-links*

0 commit comments

Comments
 (0)