nvim-cmp icon indicating copy to clipboard operation
nvim-cmp copied to clipboard
verified publisher icon hrsh7th

feat: Vim Docs

Open tjdevries opened this issue 4 years ago • 3 comments

I didn't actually do too much to make this work well, but just showing how it could be possible to generate builtin vim docs from the lua code.

There are some things that we don't yet support in https://github.com/tjdevries/tree-sitter-lua, but could be interesting to explore later.

Anyway, just thought I'd shoot this your way.

tjdevries avatar Oct 12 '21 16:10 tjdevries

Wow!!! It's really cool way. I have to look into it!

hrsh7th avatar Oct 13 '21 03:10 hrsh7th

We are working on a docker image to make it easy to run. I will let you know when we finish.

tjdevries avatar Oct 13 '21 13:10 tjdevries

As this PR seems stale, I cannot recommend enough mini.doc module: https://github.com/echasnovski/mini.nvim#minidoc

I use it to automatically generate vim help file from Lua comments in Neogen plugin, you can check out the GitHub action here:

  • https://github.com/danymat/neogen/blob/main/.github/workflows/docgen.yml
  • And the automatic generated doc here: https://github.com/danymat/neogen/blob/main/doc/neogen.txt

danymat avatar Feb 18 '22 12:02 danymat