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

JSON Schema for configuration file #687

Open
michaeltlombardi opened this issue Jul 23, 2024 · 1 comment
Open

JSON Schema for configuration file #687

michaeltlombardi opened this issue Jul 23, 2024 · 1 comment
Labels
enhancement New feature or request

Comments

@michaeltlombardi
Copy link

Is your feature request related to a problem? Please describe.
When working through defining and editing configuration, I need to constantly reference the docs and don't get in-editor validation.

Describe the solution you'd like
With a JSON schema defined for the configuration, I could get author-and-edit-time feedback about the configuration with several different editors, and even in-document help-on-hover and auto-complete.

Describe alternatives you've considered
Write my own JSON schema for the configuration for local use.

Additional context
Add any other context or screenshots about the feature request here.

@michaeltlombardi michaeltlombardi added the enhancement New feature or request label Jul 23, 2024
@miniscruff
Copy link
Owner

I definitely think a generated json schema and / or yaml schema sounds good. Including these in the generated static site would be ideal we well. I have a prototype of a new config structure that I still need to finalize. Including schemas with that update would probably be the way forward.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants