search

dccsillag / magma-nvim

Interact with Jupyter from NeoVim.
GNU General Public License v3.0
988 stars 50 forks source link

[Feature Request] Add vimdocs #36

Open tbung opened 2 years ago

tbung commented 2 years ago

Is your feature request related to a problem? Please describe. Add documentation in vimdocs format so it can be accessed via :h magma.

Describe the solution you'd like Ideally there is a way to transpile markdown to vimdocs, so the README can be reused. I'd have to look into that.

Describe alternatives you've considered Always opening the README, this is non-ideal.

Additional context I found these two transpilers with a quick google search, but I'd have to look into the a bit more, if this feature is something you would like in the project. https://github.com/kdheepak/panvimdoc https://github.com/FooSoft/md2vim

dccsillag commented 2 years ago

Yeah, I agree, it would be good to have this.

I think that a Markdown to Vimdoc transpiler would be ideal -- I'd like to keep the documentation of the plugin in Markdown form as well (though maybe not in the README).

I have my plate a bit full right now, but feel free to tackle this.

dccsillag commented 2 years ago

Also, on Vimdoc -- I've tried to use it for docs on a past plugin of mine, and felt it was extremely frustrating to use and maintain. So it'd be really ideal if we could get Markdown (or similar) to transpile to it.

tbung commented 2 years ago

I got some time next week, so I'll see what I can do.

I do agree that having to write vimdocs sounds like a pain and markdown transpilation is probably the best solution. Would you want that to happen only manually or should I look into adding this as a github action or commit hook or something, that autotranspiles on changes?

dccsillag commented 2 years ago

Thanks!

Having this as a github action would be really nice, but I'm not opposed to running it manually. I do think that we should avoid having this as a commit hook, however, since it is very easy to forget to install it.