Skip to content

Commit 634f003

Browse files
Add note on image support to docs
1 parent 0f32655 commit 634f003

File tree

2 files changed

+51
-21
lines changed

2 files changed

+51
-21
lines changed

README.md

Lines changed: 23 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -678,20 +678,14 @@ The table below shows all the highlight groups with their default link
678678
| RenderMarkdownWarn | DiagnosticWarn | Warning related callouts |
679679
| RenderMarkdownError | DiagnosticError | Error related callouts |
680680

681-
# Additional Info
681+
# Info
682682

683-
- [Limitations](doc/limitations.md): Known limitations of this plugin
684-
- [Custom Handlers](doc/custom-handlers.md): Allow users to integrate custom rendering
685-
for either unsupported languages or to override / extend builtin implementations
686-
- [Troubleshooting Guide](doc/troubleshooting.md)
687-
- [Purpose](doc/purpose.md): Why this plugin exists
688-
- [Markdown Ecosystem](doc/markdown-ecosystem.md): Information about other `markdown`
689-
related plugins and how they co-exist
683+
## vimwiki
690684

691685
> [!NOTE]
692686
>
693-
> If you use [vimwiki](https://github.com/vimwiki/vimwiki), because it overrides
694-
> the `filetype` of `markdown` files there are additional setup steps.
687+
> [vimwiki](https://github.com/vimwiki/vimwiki) overrides the `filetype` of
688+
> `markdown` files, as such there are additional setup steps.
695689
>
696690
> - Add `vimwiki` to the `file_types` configuration of this plugin
697691
>
@@ -706,3 +700,22 @@ The table below shows all the highlight groups with their default link
706700
> ```lua
707701
> vim.treesitter.language.register('markdown', 'vimwiki')
708702
> ```
703+
704+
## Images
705+
706+
> [!NOTE]
707+
>
708+
> Images are only supported so far as this plugin will not interfere with others
709+
> like [image.nvim](https://github.com/3rd/image.nvim), however nothing is done
710+
> natively by this plugin.
711+
> It is recommended to enable the `only_render_image_at_cursor` option.
712+
713+
## Additional
714+
715+
- [Limitations](doc/limitations.md): Known limitations of this plugin
716+
- [Custom Handlers](doc/custom-handlers.md): Allow users to integrate custom rendering
717+
for either unsupported languages or to override / extend builtin implementations
718+
- [Troubleshooting Guide](doc/troubleshooting.md)
719+
- [Purpose](doc/purpose.md): Why this plugin exists
720+
- [Markdown Ecosystem](doc/markdown-ecosystem.md): Information about other `markdown`
721+
related plugins and how they co-exist

doc/render-markdown.txt

Lines changed: 28 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,10 @@ Table of Contents *render-markdown-table-of-contents*
2222
- Links |render-markdown-setup-links|
2323
- Signs |render-markdown-setup-signs|
2424
7. Colors |render-markdown-colors|
25-
8. Additional Info |render-markdown-additional-info|
25+
8. Info |render-markdown-info|
26+
- vimwiki |render-markdown-info-vimwiki|
27+
- Images |render-markdown-info-images|
28+
- Additional |render-markdown-info-additional|
2629

2730
==============================================================================
2831
1. markdown.nvim *render-markdown-markdown.nvim*
@@ -762,20 +765,15 @@ The table below shows all the highlight groups with their default link
762765
------------------------------------------------------------------------------------
763766

764767
==============================================================================
765-
8. Additional Info *render-markdown-additional-info*
768+
8. Info *render-markdown-info*
766769

767-
- Limitations <doc/limitations.md>: Known limitations of this plugin
768-
- Custom Handlers <doc/custom-handlers.md>: Allow users to integrate custom rendering
769-
for either unsupported languages or to override / extend builtin implementations
770-
- Troubleshooting Guide <doc/troubleshooting.md>
771-
- Purpose <doc/purpose.md>: Why this plugin exists
772-
- Markdown Ecosystem <doc/markdown-ecosystem.md>: Information about other `markdown`
773-
related plugins and how they co-exist
770+
771+
VIMWIKI *render-markdown-info-vimwiki*
774772

775773

776774
[!NOTE]
777-
If you use vimwiki <https://github.com/vimwiki/vimwiki>, because it overrides
778-
the `filetype` of `markdown` files there are additional setup steps.
775+
vimwiki <https://github.com/vimwiki/vimwiki> overrides the `filetype` of
776+
`markdown` files, as such there are additional setup steps.
779777
- Add `vimwiki` to the `file_types` configuration of this plugin
780778
>lua
781779
require('render-markdown').setup({
@@ -787,6 +785,25 @@ The table below shows all the highlight groups with their default link
787785
vim.treesitter.language.register('markdown', 'vimwiki')
788786
<
789787

788+
IMAGES *render-markdown-info-images*
789+
790+
791+
[!NOTE]
792+
Images are only supported so far as this plugin will not interfere with others
793+
like image.nvim <https://github.com/3rd/image.nvim>, however nothing is done
794+
natively by this plugin. It is recommended to enable the
795+
`only_render_image_at_cursor` option.
796+
797+
ADDITIONAL *render-markdown-info-additional*
798+
799+
- Limitations <doc/limitations.md>: Known limitations of this plugin
800+
- Custom Handlers <doc/custom-handlers.md>: Allow users to integrate custom rendering
801+
for either unsupported languages or to override / extend builtin implementations
802+
- Troubleshooting Guide <doc/troubleshooting.md>
803+
- Purpose <doc/purpose.md>: Why this plugin exists
804+
- Markdown Ecosystem <doc/markdown-ecosystem.md>: Information about other `markdown`
805+
related plugins and how they co-exist
806+
790807
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc>
791808

792809
vim:tw=78:ts=8:noet:ft=help:norl:

0 commit comments

Comments
 (0)