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.

Sign up for GitHub

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

Jump to bottom

Title support for every diagram #1433

Closed
italomaia-bk opened this issue May 28, 2020 · 7 comments · Fixed by #3706
Closed

Title support for every diagram #1433

italomaia-bk opened this issue May 28, 2020 · 7 comments · Fixed by #3706
Labels
Area: Development Status: Approved Is ready to be worked on Type: Enhancement New feature or request

Comments

@italomaia-bk
Copy link

Is your feature request related to a problem? Please describe.
Titles are really important when sharing diagrams because they give a strong context about what the person is seeing.

Describe the solution you'd like
It would be amazing if all memaid diagrams supported a standard title or "name", so, when sharing just the diagram, it would always be clear what the diagram is about.

Describe alternatives you've considered
The same way we declare the diagram type as the first instruction, if we could declare the diagram name, it would be really cool. Something like this would also be interesting: graph LR (My Beautiful Graph)
@italomaia-bk italomaia-bk added Status: Triage Needs to be verified, categorized, etc Type: Enhancement New feature or request labels May 28, 2020
@GDFaber
Copy link
Member

GDFaber commented May 28, 2020

Hi @italomaia-bk, we should definitely add support for diagram titles. Issue #556 is also about this topic but only mentions flowcharts. We might as well add this as a common feature for all chart types while we're at it.

@GDFaber GDFaber self-assigned this May 28, 2020
@GDFaber GDFaber mentioned this issue May 28, 2020
Closed
@GDFaber GDFaber added Area: Development and removed Status: Triage Needs to be verified, categorized, etc labels May 28, 2020
@knsv
Copy link
Collaborator

knsv commented Jun 2, 2020

@GDFaber Maybe this could be added to the new rendering engine. Then it would only be in one place for all dagre based diagrams.

@jgreywolf jgreywolf added the Status: Approved Is ready to be worked on label Feb 2, 2021
@chris2fr
Copy link

chris2fr commented Feb 2, 2021

Workaround using subgraph Title end
#556 (comment)

@chrismetz09 chrismetz09 mentioned this issue Mar 5, 2022
Merged
@zalsader
Copy link

zalsader commented Apr 8, 2022

Are there any updates on this issue? plantuml allows adding a title and header to any graph.

@GDFaber GDFaber removed their assignment Apr 8, 2022
@MasonM MasonM mentioned this issue Oct 21, 2022
Merged
3 tasks
@GianlucaVeschi
Copy link

Any Update? This feature has been requested for 5 years

@besh
Copy link

besh commented Jun 8, 2023

@GianlucaVeschi unless I'm misunderstanding something, the PR associated with this issue was merged in late 2022: #3706

You can now specify Title for all diagrams.

@meleu-cw
Copy link

If someone reached here by googling: you just need to add a "yaml frontmatter" to your diagram code with a title property.

Here's a super basic example:

---
title: My Super Cool Title
---
flowchart LR
    id

---
title: My Super Cool Title
---
flowchart LR
    id
Loading

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
Area: Development Status: Approved Is ready to be worked on Type: Enhancement New feature or request
Projects
None yet
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

feat: Title support via front matter for ER, state, class, git, and graph diagrams MasonM/mermaid
10 participants
@chris2fr @jgreywolf @GDFaber @zalsader @besh @knsv @sidharthv96 @GianlucaVeschi @italomaia-bk @meleu-cw