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

Provide Config Schema #700

Open
Nerixyz opened this issue Oct 11, 2024 · 1 comment · May be fixed by #701
Open

Provide Config Schema #700

Nerixyz opened this issue Oct 11, 2024 · 1 comment · May be fixed by #701

Comments

@Nerixyz
Copy link

Nerixyz commented Oct 11, 2024

RedHat's YAML language server provides the option to associate a file with some schema by adding a special top level comment (or through the settings). It would be really helpful is MrDocs would provide a schema for the config. This makes editing a much nicer experience, in my opinion. Mkdocs-material provides such a schema for example.

Given that MrDocs has the configuration in a machine-readable format already, this seems easy to add. I modified generate-config-info.py a bit to generate a JSON (and thus YAML) schema:

If this something you'd like to add? If so, I'd open a PR.

@vinniefalco
Copy link
Member

Very good idea! This would be nicer as a pull request though ;)

@Nerixyz Nerixyz linked a pull request Oct 11, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants