@@ -51,13 +51,14 @@ information. I think preserving these features and characteristics of vimdoc
5151for documentation of vim plugins is important.
5252
5353Writing documentation in Markdown and converting it to vimdoc is not a novel
54- idea. | panvimdoc-`@mjlbach` | has already implemented a neovim treesitter based
55- markdown to vimdoc converter that works fairly well. See mjlbach/babelfish.nvim
56- <https://github.com/mjlbach/babelfish.nvim > for more information. This approach
57- is close to ideal. There are no dependencies ( except for the Markdown
58- treesitter parser ). While it appears that the markdown parser may cause
59- crashes, I have not experienced any issues in my use. It is neovim only but you
60- can use this on github actions even for a vim plugin documentation.
54+ idea. `@m jlbach` <https://github.com/mjlbach > has already implemented a neovim
55+ treesitter based markdown to vimdoc converter that works fairly well. See
56+ mjlbach/babelfish.nvim <https://github.com/mjlbach/babelfish.nvim > for more
57+ information. This approach is close to ideal. There are no dependencies (
58+ except for the Markdown treesitter parser ). While it appears that the markdown
59+ parser may cause crashes, I have not experienced any issues in my use. It is
60+ neovim only but you can use this on github actions even for a vim plugin
61+ documentation.
6162
6263I found two other projects that do something similar, wincent/docvim
6364<https://github.com/wincent/docvim > and FooSoft/md2vim
@@ -310,7 +311,7 @@ the target is an external link, the link is populated in a separate
310311autogenerated | panvimdoc-links | section.
311312
312313If the external link is to the neovim documentation, an internal vim link is
313- generated. See | ' cursorcolumn' | or | `completeopt` | as an example. This is
314+ generated. See | cursorcolumn | or | `completeopt` | as an example. This is
314315excluded from the links section.
315316
316317Lastly, if the markdown text is a url, the link is not added to the links
@@ -461,12 +462,23 @@ Content that needs to be presented only in Markdown can be inside
461462
462463
463464
465+
466+
467+
468+
469+
470+
471+
472+
473+
474+
475+
476+
464477
465478
466479
467480==============================================================================
46848111. Links *panvimdoc-links*
469482
470- 1. *panvimdoc-`@m jlbach` *: https://github.com/mjlbach
471483
472484vim:tw=78:ts=8:noet:ft=help:norl:
0 commit comments