@@ -22,7 +22,10 @@ Table of Contents *render-markdown-table-of-contents*
22
22
- Links | render-markdown-setup-links |
23
23
- Signs | render-markdown-setup-signs |
24
24
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 |
26
29
27
30
==============================================================================
28
31
1. markdown.nvim *render-markdown-markdown.nvim*
@@ -762,20 +765,15 @@ The table below shows all the highlight groups with their default link
762
765
------------------------------------------------------------------------------------
763
766
764
767
==============================================================================
765
- 8. Additional Info *render-markdown-additional -info*
768
+ 8. Info *render-markdown-info*
766
769
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*
774
772
775
773
776
774
[!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.
779
777
- Add `vimwiki` to the `file_types` configuration of this plugin
780
778
>lua
781
779
require('render-markdown').setup({
@@ -787,6 +785,25 @@ The table below shows all the highlight groups with their default link
787
785
vim.treesitter.language.register('markdown' , 'vimwiki' )
788
786
<
789
787
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
+
790
807
Generated by panvimdoc <https://github.com/kdheepak/panvimdoc >
791
808
792
809
vim:tw=78:ts=8:noet:ft=help:norl:
0 commit comments