Skip to content

Commit d227c32

Browse files
kdheepakactions-user
authored andcommitted
Auto generate docs
1 parent dd62586 commit d227c32

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

doc/panvimdoc.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -46,19 +46,18 @@ highlighting and features like tags and links when the text file is in `vimdoc`
4646
compatible format and when `filetype=help` in vim. Also, typically, while vim
4747
documentation are just plain text files, they are usually formatted well using
4848
whitespace. See https://vimhelp.org/helphelp.txt.html#help-writing or
49-
[@nanotree's project](https://github.com/nanotee/vimdoc-notes) for more
49+
`@nanotree`s project <https://github.com/nanotee/vimdoc-notes> for more
5050
information. I think preserving these features and characteristics of vimdoc
5151
for documentation of vim plugins is important.
5252

5353
Writing documentation in Markdown and converting it to vimdoc is not a novel
54-
idea. [@mjlbach](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.
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.
6261

6362
I found two other projects that do something similar, wincent/docvim
6463
<https://github.com/wincent/docvim> and FooSoft/md2vim
@@ -468,5 +467,6 @@ Content that needs to be presented only in Markdown can be inside
468467
==============================================================================
469468
11. Links *panvimdoc-links*
470469

470+
1. *panvimdoc-`@mjlbach`*: https://github.com/mjlbach
471471

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

0 commit comments

Comments
 (0)