Problem Description
For someone who regularly has to switch between different markup languages / environments, it is sometimes hard to remember what the relevant syntax is for enabling Mermaid support in a particular Markdown flavour.
Proposed Solution
Ideally, the following tweaks would be made to the UI to make this easier:
- Add a toolbar entry (like one of the "format" options) that will insert a "```mermaid" block into the text at the cursor
- In the Help popup, have a section showing hints for supported types and/or syntax examples - This can be as simple as just displaying the contents of one of the "docs/*.md" files
Alternative Solutions
Simple Extension:
The toolbar entry could be like the "Headings" dropdown, showing a list of the available / supported diagram types, and clicking on one of those would insert the sample graph code into the doc to act as a template to start from.
More Effort Solution:
Have some kind of guided wizard for setting these up.
Use Cases
- Helping new users learn that the feature is available, and/or how to use it
- Helping people who use multiple markup languages across different platforms know how they can invoke these diagrams in this environment
Priority
How important is this feature to your workflow?
Problem Description
For someone who regularly has to switch between different markup languages / environments, it is sometimes hard to remember what the relevant syntax is for enabling Mermaid support in a particular Markdown flavour.
Proposed Solution
Ideally, the following tweaks would be made to the UI to make this easier:
Alternative Solutions
Simple Extension:
The toolbar entry could be like the "Headings" dropdown, showing a list of the available / supported diagram types, and clicking on one of those would insert the sample graph code into the doc to act as a template to start from.
More Effort Solution:
Have some kind of guided wizard for setting these up.
Use Cases
Priority
How important is this feature to your workflow?