-
-
Notifications
You must be signed in to change notification settings - Fork 142
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Reformat docs #737
Reformat docs #737
Conversation
seflue
commented
May 28, 2024
- reformat markdown files
- replace md2vim with panvimdoc
Help tags get auto-generated bei Neovim.
@kristijanhusak On my fork the document action does not work because of wrong access token. To test the pipeline, it would be helpful if you could just push this branch to the nvim-orgmode repo (I don't have the permissions to do so). |
Thanks @seflue ! I'm merging this in to see if it works fine. What are you using for formatting markdown? |
Honestly, I'm not sure, which one kicks in, when I hit safe, but I guess it's prettier, which I am using via none-ls. |
TBH I'm not really liking the output of the new docs. Table of content is messed up, there are no tags on each heading. I'll see if I can do something to make it better. |
I reverted doc generating back to md2vim until the doc file is migrated to org format. |
I agree. To get it clean it would need some hand work on the Markdown. How the syntax is interpreted and tags are generated is documented, so there are good options but it would need work. Because you're aiming to migrate the Docs to Orgmode anyway, it makes absolute sense to defer the manual work to get the Orgmode right. If you won't mind to give me permissions to push feature branches in nvim-orgmode, I would be happy to experiment a little bit. I would actually do it on my fork, but there are issues with GitHub tokens and GH Actions on forked repositories. |
I'm not sure how to do that. You should be able to add your own GH token on your fork to make it work. |
* chore: reformat markdown files * chore: ignore vim helptags Help tags get auto-generated bei Neovim. * docs: replace md2vim with panvimdoc in ci pipeline * fixup! docs: replace md2vim with panvimdoc in ci pipeline --------- Co-authored-by: Sebastian Flügge <seflue@users.noreply.github.com>