Update markdown >3.2 and graphviz extension

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

Update markdown >3.2 and graphviz extension #74

Closed iswariyam closed 1 year ago

iswariyam commented 1 year ago

Summary:

Update markdown_inline_graphviz_extension to 1.1.1 as errors related to svg rendering is fixed in this PR
The latest version of markdown_inline_graphviz_extension is now compatible with markdown 3.3 and above

Related to #37 Fixes #36 and #45 (allows users to use markdown >=3.3)

iswariyam commented 1 year ago

@camilaibs @iamEAP Could you please review and approve this? Merging this PR would allow folks to use other mkdocs plugins (like mkdocstrings) which only work with markdown >3.3 in conjunction with techdocs.

camilaibs commented 1 year ago

@camilaibs @iamEAP Could you please review and approve this? Merging this PR would allow folks to use other mkdocs plugins (like mkdocstrings) which only work with markdown >3.3 in conjunction with techdocs.

Starting to review 🙂

iswariyam commented 1 year ago

If this PR is merged, then changes would have to be made to techdocs docs (notes section at the end) and techdocs-container

iswariyam commented 1 year ago

@iswariyam I talked to @iamEAP and we're a little concerned about the open-endedness of themarkdown_inline_graphviz_extension version constraint... How about combining what we did with the markdown constraint >=1.1.1,<2 or something?

Fine by me. I'll push the change.