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

Add JSON schema for plugin options #98

Closed
mschoettle opened this issue May 15, 2024 · 2 comments
Closed

Add JSON schema for plugin options #98

mschoettle opened this issue May 15, 2024 · 2 comments

Comments

@mschoettle
Copy link

Hi @mikitex70,

Would you consider including an extension-schema.json in this repo that describes the valid configuration options (https://github.com/mikitex70/plantuml-markdown#plugin-options)?

mkdocs-material includes a schema for mkdocs.yml which allows the editor to validate the YAML file against this schema (see: https://squidfunk.github.io/mkdocs-material/creating-your-site/#minimal-configuration).

This schema could be referenced by mkdocs-material: squidfunk/mkdocs-material#7159

I started with a definition here for the options we use: https://github.com/mschoettle/mkdocs-material/blob/24212492df2fe995809f6a5bda8fdbed00fc7f64/docs/schema/extensions/plantuml_markdown.json

mikitex70 added a commit that referenced this issue May 28, 2024
Added a JsonSchema file which may be used with schemas in
[MkDocs-Material](https://squidfunk.github.io/mkdocs-material/) to
validate the `mkdocs.yml` configuration file.
@mikitex70
Copy link
Owner

Ho @mschoettle, sorry for the delay but I was a bit busy.
I've committed to the master branch a schema file based on your work, which has all the options.
If referenced by the MkDocs schema it allow you to validate all the options of this plugin.
Let me known if there is any issue.

@mschoettle
Copy link
Author

Thanks a lot @mikitex70!

Created a PR to have it referenced here: squidfunk/mkdocs-material#7260

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants