backstage / mkdocs-techdocs-core

The core MkDocs plugin used by Backstage's TechDocs as a wrapper around multiple MkDocs plugins and Python Markdown extensions
Apache License 2.0
85 stars 61 forks source link

Document PlantUML limitation #28

Closed Crevil closed 3 years ago

Crevil commented 3 years ago

Currently it is not possible to use the PlantUML format 'svg_object' as this makes it possible for bad actors to inject malicious content into documentation.

This change adds a link to the plantuml_markdown extension bullet with a link to the TechDocs troubleshooting section explaining this limitation.

Related to issue backstage/backstage#6232 and docs PR backstage/backstage#6332.

I'm a bit unsure whether the link is correct, so we should wait with merging this until the docs PR is merged to main.