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

[Feature Request] Add JSON schema #93

Open
Stanzilla opened this issue Feb 21, 2022 · 5 comments
Open

[Feature Request] Add JSON schema #93

Stanzilla opened this issue Feb 21, 2022 · 5 comments
Assignees

Comments

@Stanzilla
Copy link

The mkdocs-material project now has a JSON schema for mkdocs.yml files and it's possible to add external references so you can maintain it in your own repo like so squidfunk/mkdocs-material#3571

@ultrabug ultrabug self-assigned this Feb 22, 2022
@ultrabug
Copy link
Owner

@Stanzilla hi

You clearly are ahead of me here. I have no clue what you expect me to do to support this?

Please provide a clear example of what you'd like to be supported mate.

@Stanzilla
Copy link
Author

It's a way of documenting the options a plugin provides so the editor can autocomplete/suggest and warn on incorrect ones.

https://guts.github.io/mkdocs-rss-plugin/schema.json is an example of an extension one

@ultrabug
Copy link
Owner

ultrabug commented Mar 2, 2022

Ok I understand @Stanzilla but what's the added value here exactly? I must admit that with my limited time I want to be sure that the time I will spend on this is worth it...

Else, I'm open for a PR of course by anyone interested

@Stanzilla
Copy link
Author

Basically adding error checking for your plugin options inside of the editor. Should/could result in less people making tickets because they are using the wrong syntax/options for example.

@ultrabug
Copy link
Owner

ultrabug commented Mar 2, 2022

Ok but I'm unsure why it's been ported in mkdocs-material and not mkdocs itself then.

I'll leave that open here in case I have some time to spend on this someday.

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

No branches or pull requests

2 participants