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 Mermaid.js Diagrams #83

Closed
cbrgm opened this issue Feb 6, 2024 · 2 comments
Closed

Add Support for Mermaid.js Diagrams #83

cbrgm opened this issue Feb 6, 2024 · 2 comments
Labels
enhancement New feature or request general hugo question A question about usage of Hugo in general - May be better to discuss this on the »Hugo Community«

Comments

@cbrgm
Copy link

cbrgm commented Feb 6, 2024

Feature Request: Mermaid.js Support

Integrate Mermaid.js for enhanced diagramming capabilities within blog posts.

What + Why:

  • Mermaid.js is a JavaScript tool for creating and dynamically modifying diagrams and charts via Markdown-inspired text definitions.
  • It would enable users to embed complex diagrams directly into their Hugo Bearblog posts, enhancing the content's visual and instructional quality.
  • Adds a powerful tool for technical bloggers and educators who need to include flowcharts, sequence diagrams, class diagrams, etc., in their posts.
  • Keeps the blog visually engaging and informative without sacrificing speed or simplicity.
@janraasch
Copy link
Owner

janraasch commented Feb 7, 2024

Hi @cbrgm,

thank you for opening this (detailed & neatly organised!!!) issue🧤. Nice to meet you 😁.

I have not used Mermaid myself, but it does look cool. It definitely seems useful for technical bloggers & educators!

I did some quick duckduckgo-🦆-ing on using mermaid.js with hugo. Here's what I found. This post

https://robb.sh/posts/how-to-use-mermaid-diagrams-in-hugo/

has a quick & easy way to get you setup.

If you run into problems or have further questions there's also a discussion on the main Hugo discourse platform https://discourse.gohugo.io/t/correct-way-to-embed-mermaid-js/43491 about how to best embed Mermaid on Hugo.

I am not sure, if we'd want to add an integration to this particular theme. It seems like this is more of a general issue. In fact once you have a working shortcut, you could ship that as an (independent) Hugo module.

I hope that helps.

Kind regards 👋,
Jan

@janraasch janraasch added enhancement New feature or request general hugo question A question about usage of Hugo in general - May be better to discuss this on the »Hugo Community« labels Feb 7, 2024
@janraasch janraasch changed the title Feature Request: Add Support for Mermaid.js Diagrams Add Support for Mermaid.js Diagrams Feb 7, 2024
@cbrgm
Copy link
Author

cbrgm commented Feb 7, 2024

Hi @janraasch ,

Thanks for the swift and helpful response!

Mermaid integration looks straightforward with your guidance. I'll explore the links you provided, especially the setup guide and the Hugo forum discussion for any advanced embedding options.

Regarding theme integration, your point about creating a Hugo module makes a lot of sense. It could streamline the process for others facing the same issue.

And what a small world – I'm located in Hamburg! Great to connect with a "neighbor" in this context. 😁

Best,
@cbrgm

@cbrgm cbrgm closed this as completed Feb 7, 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 general hugo question A question about usage of Hugo in general - May be better to discuss this on the »Hugo Community«
Projects
None yet
Development

No branches or pull requests

2 participants