ci(docs): add gh actions for generating vimdocs

[NStefan002]

Explain the purpose and scope of your contribution.

Changes

• add GitHub action for generating vim docs
• since your README is very detailed, and your code comments not so much, I figured this is the right action for this project (it transforms the contents of the README to vimdoc format, enabling users to access it via :help smear-cursor.nvim.txt)
• note: This is only a suggestion PR, if you don't like it or want me to add/change something let me know

Related GitHub issues and pull requests

• fix Add :h documentation #8

[sphamba]

Nice! I was procrastinating learning how to automatically generate a doc for lua/neovim...
Do you know if there would be a way to

• skip some of the Readme section (Demo, Contributing)
• somehow a reference to config.lua?

Also, it would be great to have the workflow only run when the README.md file has changed, perhaps also on the dev branch.
Many thanks :)

[NStefan002]

skip some of the Readme section (Demo, Contributing)

You can place the section inside panvimdoc-ignore-{start/end} block. See example [here].(https://github.com/kdheepak/panvimdoc/blob/main/doc/panvimdoc.md#markdown-only-content)

somehow a reference to config.lua

I don't know how to do this, but you can use <details> and <summary> and copy the config.lua file (or the important contents) to the readme.

Also, it would be great to have the workflow only run when the README.md file has changed

It only runs when the readme is changed, and if the date of the plugin's last update in the docs needs to be updated. For example, if your last commit was 3 days ago, and you push a new commit, the action will update the date in the vim docs (regardless of whether or or not you updated the readme)

... perhaps also on the dev branch

Do you want it to generate docs on both main and dev? I don't know your workflow but if you constantly merge dev into main then the action will update the docs once you merge the PR. Anyway, let me know if you want me to add docs gen on the dev branch.

[sphamba]

Okay, makes sense to only keep it executing on main if it gets updated there anyway then.
I'll still merge this to dev and temporarily enable the ci there to tests things on my side.
Thanks for your work!