squidfunk / mkdocs-material

Documentation that simply works
https://squidfunk.github.io/mkdocs-material/
MIT License
18.65k stars 3.35k forks source link

Add PlantUML Markdown extension schema #7159

Closed mschoettle closed 3 weeks ago

mschoettle commented 3 weeks ago

Context

No response

Description

We use PlantUML diagrams and include them with the PlantUML Markdown extension into our documentation site. It works nicely with mkdocs-material as well.

It would be nice to have the schema included so that that part of the configuration in mkdocs.yaml is validated as well.

Related links

Use Cases

As mentioned in the description, being able to fully validate the MkDocs file.

I started making the change (at least for a subset of the configuration options) and then wondered whether there is interest in adding this schema to this repo or whether it would be better to try to get it added to the extension's repo instead.

Visuals

No response

Before submitting

squidfunk commented 3 weeks ago

Thanks for suggesting! We're happy to link to third party integrations, so feel free to create a PR with a link to your schema, if you'd like to maintain it. We're not directly integrating with PlantUML, so it makes no sense for us to maintain a schema, as we're not using it ourselves. Closing as out of scope, but as said, happy to integrate an external schema!