Skip to content
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鈥檒l occasionally send you account related emails.

Already on GitHub? Sign in to your account

ci: add workflow to convert README to vimdoc #59

Merged
merged 4 commits into from
Oct 4, 2023

Conversation

mikesmithgh
Copy link
Contributor

@mikesmithgh mikesmithgh commented Oct 4, 2023

馃憢 I created a Github workflow to run panvimdoc on every push that modifies README.md. I tweaked some formatting in the README to allow it to generate correctly.

You may have to enable read and write access to your github actions to allow the bot to commit changes. See setting-the-permissions-of-the-github_token-for-your-repository

Let me know what you think! #hacktoberfest 馃帀

It can also be ran locally via:

./panvimdoc.sh --project-name hardtime.nvim  --input-file "../hardtime.nvim/README.md" --vim-version "NVIM v0.7+" --toc true --demojify true --dedup-subheadings false

@m4xshen m4xshen merged commit e5b5f76 into m4xshen:main Oct 4, 2023
@m4xshen
Copy link
Owner

m4xshen commented Oct 4, 2023

Thanks a lot! I didn't even know that this tool exists.

@mikesmithgh
Copy link
Contributor Author

Glad to help 馃檪

@m4xshen m4xshen changed the title docs: add workflow to convert README to vimdoc readme to vimdoc ci: add workflow to convert README to vimdoc Jun 7, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants