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
2
2
3
3
==============================================================================
4
4
Table of Contents *render-markdown-table-of-contents*
@@ -11,7 +11,10 @@ Table of Contents *render-markdown-table-of-contents*
11
11
5. Setup | render-markdown-setup |
12
12
6. Commands | render-markdown-commands |
13
13
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 |
15
18
9. Links | render-markdown-links |
16
19
17
20
==============================================================================
@@ -179,14 +182,47 @@ this plugin.
179
182
180
183
181
184
==============================================================================
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.
183
199
184
200
- 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
190
226
191
227
==============================================================================
192
228
9. Links *render-markdown-links*
0 commit comments