feat: add auto vimdoc generation workflow #76
Conversation
ram02z
changed the title
ram02z
force-pushed
the
auto_docs
branch
3 times, most recently
from
241e39b
to
712e966
Compare
|
Haven't looked into the files yet (will do soon) but I think it should ignore the How To Install section |
|
Why are the headers in "Tips and tricks" and "Common issues" changed to quotes |
|
I'm not experienced with Vim docs so I could be wrong here, but shouldn't I be able to do |
Run Also do yourself a favor add |
Ah alright, will keep that in mind |
|
I made some changes to README.md, you should probably rebase your changes against the latest commit |
The headings resulted in auto generated vimdoc headings like |
|
@famiu I changed the |
but that isn't a problem for the "Tips and tricks" section, is it? Keep the quotes for "Common issues" I guess but I think "Tips and tricks" should have headers |
Both "Common issues" and "Tips and tricks" have headings in the vimdoc. |
I mean the headings inside Tips and tricks (eg: "Reset highlights") should also be headings instead of quotes |
Oh, I understand now. But that would result in the heading for "Use thin line instead of the inactive statusline" to become |
How about rename it to "Thin line for horizontal splits" |
|
One last thing, you should probably rename "The setup function" to just "Setting up Feline" or maybe even just "Setup". Also remember to change all references to the setup function header in the README as well |
|
oops, accidentally clicked on "Close with comment" |
Yeah, to follow along with the theme, I will also change |
Yeah, feel free to change any other header you feel is necessary to change as well. |
I settled with |
|
Hmm, not sure why Line 669 in a15d0c9 |
|
The help tags are also not appearing by default when I use the minimal_init. Isn't Packer supposed to setup the help tags? |
| @@ -510,7 +521,7 @@ hl = {bg = 'oceanblue'}, | |||
| right_sep = 'slant_right' | |||
| ``` | |||
|
|
|||
| Not only that, you can add your own custom colors and separators through [the setup function](#the-setup-function) which allows you to just use the name of the color or separator to refer to it. | |||
| Not only that, you can add your own custom colors and separators through [the setup function](#setup-function) which allows you to just use the name of the color or separator to refer to it. | |||
There was a problem hiding this comment.
I think I should have changed this to become the [setup function](#setup-function)
There was a problem hiding this comment.
does changing it to that fix the issue?
My help tags generated after I compiled. |
| After that, you can just modify the components and call [the setup function](#the-setup-function) with the preset as you normally would. | ||
| After that, you can just modify the components and call [the setup function](#setup-function) with the preset as you normally would. |
There was a problem hiding this comment.
Maybe you should change this to the [setup function](#setup-function) too
What do you mean by "compiled" in this case? |
After I ran |
Ah. Alright, it seems to work fine now after running |
I saw a comment on the reddit post you made about the lack of a vimdoc file. I have written docs for people in the past but this README is massive (that's a good thing), so I took inspiration from shadmansaleh's lualine and tried out https://github.com/kdheepak/panvimdoc.
The github workflow is mostly borrowed from https://github.com/shadmansaleh/lualine.nvim/blob/master/.github/workflows/docs.yml.
Changes
Issues
HOW TO INSTALLsection should be ignored, but I think it should since users would have already installed it.*feline-The-setup-function*.The current generated vimdoc can be seen here: ram02z#11