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

Switch to using DocumenterMermaid.jl than manual HTML-tag based Mermaid. #149

Closed
Fe-r-oz opened this issue Sep 9, 2024 · 1 comment
Closed
Labels
enhancement New feature or request

Comments

@Fe-r-oz
Copy link

Fe-r-oz commented Sep 9, 2024

Is your feature request related to a problem? Please describe.

DocumenterMermaid.jl seems much better option rather than using HTML-tag based Mermaid. For some folks, It can be hectic converting mermaid charts by 'manually' adding HTML tags to render them.

This saves time going through HTML documentation. I have checked out project.toml, but didn't found it's use yet.

Describe the solution you’d like
DocumenterMermaid.jl seems more natural extension of using Mermaid in julia. Maybe consider shifting to using DocumenterMermaid.jl/. With this, folks can easily add their Mermaid schematics to docstrings without wasting time. I have also noticed some minor changes using default schematics between Mermaid and Mermaid-HTML tags which is the Mermaid renders blocks with better fit, but HTML based method has slghtly larger boxes, even for default verion.

Thanks for your consideration.

@Fe-r-oz Fe-r-oz added the enhancement New feature or request label Sep 9, 2024
@Fe-r-oz
Copy link
Author

Fe-r-oz commented Sep 9, 2024

It appears that DocumenterMermaid is compatible only with Documenter and not with DocStringExtensions. As a result, I’ll be closing this issue. I apologize for any confusion -- I got a bit too excited and thought this functionality was available. Thank you for your understanding

@Fe-r-oz Fe-r-oz closed this as completed Sep 9, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

1 participant