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
87 stars 64 forks source link

Fix SVG parsing used by GraphViz #37

Closed camilaibs closed 3 years ago

camilaibs commented 3 years ago

Fixes: #36

Signed-off-by: Camila Loiola camilal@spotify.com

Markdown>=3.3 is parsing SVG tags incorrectly because it wraps the child SVG tags with <p></p> which breaks the rendering of these images.

image

To avoid it, we've fixed the Markdown version to 3.2.2 and now SVGs are being rendered correctly:

image

camilaibs commented 3 years ago

Thanks for looking into this @camilaibs, can you also include a changelog entry and a version upgrade of this package (instructions listed under release section) and then we can get this released immediately

@emmaindal Done 🙌🏻 , after it's merged, we need to bump the Techdocs container here too: https://github.com/backstage/techdocs-container/blob/main/Dockerfile#L23