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’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add all available configuration options in README #217

Open
mksonkar opened this issue Nov 26, 2024 · 1 comment
Open

Add all available configuration options in README #217

mksonkar opened this issue Nov 26, 2024 · 1 comment
Labels
documentation Improvements or additions to documentation

Comments

@mksonkar
Copy link

I know the options are mentioned in :help gruvbox-material.txt.
But it will be really useful if anyone new checks the page, and just being able to copy all available options to tweak theme options from the README page. If the user wants to read what they do then they can refer to the documentation. Many other themes provide the full configuration options on the README and it will help with making it more popular and accessible to new users.

@antoineco
Copy link
Collaborator

antoineco commented Feb 3, 2025

Besides the slightly improved rendering while navigating the docs in a web browser, I don't see a lot of value doing this. It's a lot of effort for essentially just duplicating information:

  • To make it viable, we need tooling for keeping both versions in sync. There are projects that generate Vim docs from markdown but not the other way around, so the initial conversion needs to be manual.
  • To avoid drifts in the future, we need to
    • enforce Git hooks.
    • set up GitHub Actions to verify that hooks were executed, or execute them on behalf of contributors after changes are merged.

To me, the root of the problem is a lack of web-based Vimdoc renderer. The Vim and Neovim projects generate and host their own HTML, which is relevant to them given the size of their documentation, but not to a colorscheme with very few exposed switches.

It is true that some colorschemes have their options enumerated in their README, but the majority are written in Lua and use a much more complex table-based configuration schema than Gruvbox Material.

If you have a end-to-end solution for this, PR welcome!

@antoineco antoineco added the documentation Improvements or additions to documentation label Feb 3, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants