Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

add: support for in-Markdown Mermaid diagrams #525

Merged
merged 7 commits into from
Mar 28, 2023
Merged

add: support for in-Markdown Mermaid diagrams #525

merged 7 commits into from
Mar 28, 2023

Conversation

thearchitector
Copy link
Contributor

@thearchitector thearchitector commented Mar 26, 2023

Includes support and documentation for rendering Mermaid diagrams by default.

Bumps markdown2 to v2.4.8.

I'd also advocate for listing markdown2 as a dependency and pinning the version there instead of vendoring a copy. I think it keeps things neater and in their own wheelhouses; I don't see a reason to treat it differently than the other deps, unless there's a proven track record of incompatibilities with other tools people might use in tandem / I acknowledge it would probably add some dependency maintenance overhead (which might be a valid reason itself).

Closes #524.

@thearchitector thearchitector changed the title Add support for Mermaid diagrams add: support for in-Markdown Mermaid diagrams Mar 26, 2023
@mhils
Copy link
Member

mhils commented Mar 28, 2023

Thank you for the very nice PR! 🍰 I've liked this so much that I moved it into the core and added a --mermaid command line flag. 😃

I'd also advocate for listing markdown2 as a dependency and pinning the version there instead of vendoring a copy.

One thing that's special about pdoc is that it gets installed into lots of random virtualenvs with sometimes weird package version constraints. Vendoring makes things easier here. We've repeatedly shipped out-of-band hotfixes for markdown2 (e.g. 912c33d), which is why I'd like to retain that capability. 😃

@mhils mhils enabled auto-merge (squash) March 28, 2023 13:01
@mhils mhils merged commit 1c422df into mitmproxy:main Mar 28, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Add support for additional markdown extras / mermaid
2 participants