search

nvim-lua / wishlist

A public catalogue of Lua plugins Neovim users would like to see exist
MIT License
235 stars 0 forks source link

Help via readme.md #34

Closed maxfl closed 1 year ago

maxfl commented 2 years ago

What? A command Helpmd <pluginname> that opens plugin's readme file. Completions provided.

It may find it oin rtpor use Packer to get list of paths/

Why? A lot of new plugins do not provide vim help. Nevertheless most of them do provide an informative readme. Currently I have to open the browser to get it. Actually the readme files are provided with plugins so they may be accessed from neovim with a help-like command.

Potential existing implementations: I have not found any.

Anrock commented 2 years ago

Hm, that should be easy to implement.

matu3ba commented 2 years ago

There is an open telescope-project PR open for this, but its unfinished (only permanent setting instead of user configurable/keytoggle). If anyone wants to reuse code from that.

maxfl commented 2 years ago

There is an open telescope-project PR open for this, but its unfinished (only permanent setting instead of user configurable/keytoggle). If anyone wants to reuse code from that.

I'm using the telescope - great plugin. Can't wait for this being implemented.

Thank you!

fmbarina commented 1 year ago

I ended up giving this idea a shot.

Mind you, it's likely kind of rough due to my lack of experience developing Neovim plugins, but it works.

Maybe check it out sometime, if it interests you.

maxfl commented 1 year ago

as the packer is no longer supported I've moved to lazy.nvim and found out it converts readme.md into vimdoc. Great plugin.

fmbarina commented 1 year ago

Oh wow, I use lazy too and didn't even know of this feature haha. That's awesome, thanks.

Edit: wait, maybe I'd be good to close this issue then? As I see it, lazy.nvim fulfills the request.

maxfl commented 1 year ago

Makes sense, as I do not see any other interested people.