Replace markdown_inline_graphviz with mkdocs-graphviz - Githubissues

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

Replace markdown_inline_graphviz with mkdocs-graphviz #113

Closed kunickiaj closed 10 months ago

kunickiaj commented 1 year ago

Resolves #102 -- Legacy markdown_inline_graphviz syntax conflicts with other languages used in code blocks due to regular expression matching on {%

The optional cdn hosted js for light/dark themes is not loaded by techdocs-core to avoid external dependencies.

Notable visible changes:

The current mkdocs-techdocs-core renders black on white background by default.
This PR renders #789ABC by default with no background. This works reasonably well for either light or dark themes in Backstage as seen in the screenshots attached.
Further customization can be done by the user either in the mkdocs configuration or in the graphviz itself.

To preserve the current defaults we can add the following extension options:

markdown_extensions:
  - mkdocs_graphviz:
      color: 000000
      bgcolor: FFFFFF

Current

before

Proposed

after-dark

after-light

github-actions[bot] commented 10 months ago

This PR has been automatically marked as stale because it has not had recent activity from the author. It will be closed if no further activity occurs. If the PR was closed and you want it re-opened, let us know and we'll re-open the PR so that you can continue the contribution!