template creates invalid JSON for multiline values at mkdocs.yml / config

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

83 stars 61 forks source link

template creates invalid JSON for multiline values at mkdocs.yml / config #57

Closed pjungermann closed 2 years ago

pjungermann commented 2 years ago

The issue is caused by the jinja templates used for techdocs_metadata.json which assumes single line strings only as input and breaks e.g. for multiline string values. Hereby, the template attempts to manual create JSON content.

This caused backstage/backstage issue #10277