mkdocs-static-i18n icon indicating copy to clipboard operation
mkdocs-static-i18n copied to clipboard

[Feature Request] Add JSON schema

Open Stanzilla opened this issue 3 years ago • 5 comments

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 https://github.com/squidfunk/mkdocs-material/pull/3571

Stanzilla avatar Feb 21 '22 14:02 Stanzilla

@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.

ultrabug avatar Feb 22 '22 20:02 ultrabug

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

Stanzilla avatar Feb 22 '22 20:02 Stanzilla

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

ultrabug avatar Mar 02 '22 20:03 ultrabug

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.

Stanzilla avatar Mar 02 '22 20:03 Stanzilla

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.

ultrabug avatar Mar 02 '22 20:03 ultrabug