search

ultrabug / mkdocs-static-i18n

MkDocs i18n plugin using static translation markdown files
https://ultrabug.github.io/mkdocs-static-i18n/
MIT License
236 stars 38 forks source link

[Feature Request] Add JSON schema #93

Open Stanzilla opened 2 years ago

Stanzilla commented 2 years ago

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

ultrabug commented 2 years ago

@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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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 commented 2 years ago

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.