Add hint on "flowchart" and "graph" #4096
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Graph has been replaced with Flowchart in mermaid-js/mermaid-live-editor#654 |
|
Updated 😅 From 4ed6ec1 I see that ```noteis converted to |
|
@koppor it converts based on the output format. Default output is github markdown, which uses the |
sidharthv96
requested changes
Apr 23, 2023
| @@ -687,11 +697,13 @@ Starting with Mermaid version 9.4, you can use an alternate renderer named elk. | |||
| The _elk_ renderer is an experimenal feature. | |||
| You can change the renderer to elk by adding this directive: | |||
|
|
|||
| ``` | |||
| ```elk | |||
There was a problem hiding this comment.
I know, just rendered more nicely. Hack removed.
|
@sidharthv96 I resolved the conflicts again. Should I change something more? |
|
@koppor we have
|
|
@sidharthv96 Fixed. |
|
@koppor, Thank you for the contribution! |
github-merge-queue bot
pushed a commit
to fuxingloh/contented
that referenced
this pull request
Jul 2, 2023
[](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`10.2.3` -> `10.2.4`](https://renovatebot.com/diffs/npm/mermaid/10.2.3/10.2.4) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | [](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid (mermaid)</summary> ### [`v10.2.4`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.2.4): 10.2.4 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.3...v10.2.4) #### Features - Add Plausible analytics to mermaid.js.org by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4473 - Support for development in Docker by [@​nirname](https://togithub.com/nirname) in [mermaid-js/mermaid#4478 - standardize info diagram definitions by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4486 - Change C4 stereotype braces from ASCII <\</>> to Unicode «/» by [@​jonathan-r-young](https://togithub.com/jonathan-r-young) in [mermaid-js/mermaid#4460 - Add coverage for E2E tests by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4498 - set normal mode for vitest coverage by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4505 - Use v8 coverage in vitest by [@​sidharthv96](https://togithub.com/sidharthv96) in [mermaid-js/mermaid#4560 - feat(flowchart): add classDef style group definition by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#3923 - add cypress coverage clean by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4556 - fix(class): keep members in namespace classes by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#4532 #### Bugfixes - Add hint on "flowchart" and "graph" by [@​koppor](https://togithub.com/koppor) in [mermaid-js/mermaid#4096 - fix(flowchart): apply style on doublecircle by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#4540 - fix not rendered style when style is optional by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4528 - fix(flowchart): allow multiple vertices with style by [@​tomperr](https://togithub.com/tomperr) in [mermaid-js/mermaid#4553 #### Documentation - change REAMDME.md coverage from coveralls into codecov by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4507 - Update latest news section by [@​huynhicode](https://togithub.com/huynhicode) in [mermaid-js/mermaid#4468 - Fix link to Tutorials from n00b-overview page by [@​Spiderpig86](https://togithub.com/Spiderpig86) in [mermaid-js/mermaid#4472 - Fix Directives Documentation by [@​adamazing](https://togithub.com/adamazing) in [mermaid-js/mermaid#4475 - Correct "Bronze" spelling in timeline docs by [@​adamazing](https://togithub.com/adamazing) in [mermaid-js/mermaid#4467 - Document recommended file extension and MIME type docs by [@​bollwyvl](https://togithub.com/bollwyvl) in [mermaid-js/mermaid#4485 - Fix typo in quadrant chart documentation by [@​tobie](https://togithub.com/tobie) in [mermaid-js/mermaid#4512 - fix cspell issues in \*.md files by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4531 - docs: Howto on foreground color on timelines by [@​mcbeelen](https://togithub.com/mcbeelen) in [mermaid-js/mermaid#4524 - Add citation.cff file by [@​schackartk](https://togithub.com/schackartk) in [mermaid-js/mermaid#4521 - Update Tutorials.md by [@​ellenealds](https://togithub.com/ellenealds) in [mermaid-js/mermaid#4539 - Add Standard Notes extension in integrations page by [@​nienow](https://togithub.com/nienow) in [mermaid-js/mermaid#4557 - Fix up Gantt Chart demo by [@​AlexMooney](https://togithub.com/AlexMooney) in [mermaid-js/mermaid#4561 #### Chore - Update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4482 - chore: revise Contributing documentation by [@​weedySeaDragon](https://togithub.com/weedySeaDragon) in [mermaid-js/mermaid#3814 - chore(deps): update all minor dependencies (minor) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4435 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4510 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4535 - chore(deps): update dependency eslint-plugin-jsdoc to v46 by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4544 - chore(deps): update dependency jsdom to v22 by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4546 - chore(deps): update dependency eslint-plugin-unicorn to v47 by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4545 - chore(deps): update dependency workbox-window to v7 by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4547 - chore(deps): update node.js to v20 by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4548 - fix(deps): update all patch dependencies (patch) by [@​renovate](https://togithub.com/renovate) in [mermaid-js/mermaid#4543 - add `Suggested Solutions` field in `bug_report.yml` by [@​Yokozuna59](https://togithub.com/Yokozuna59) in [mermaid-js/mermaid#4541 #### New Contributors - [@​Spiderpig86](https://togithub.com/Spiderpig86) made their first contribution in [mermaid-js/mermaid#4472 - [@​adamazing](https://togithub.com/adamazing) made their first contribution in [mermaid-js/mermaid#4475 - [@​koppor](https://togithub.com/koppor) made their first contribution in [mermaid-js/mermaid#4096 - [@​nirname](https://togithub.com/nirname) made their first contribution in [mermaid-js/mermaid#4478 - [@​Yokozuna59](https://togithub.com/Yokozuna59) made their first contribution in [mermaid-js/mermaid#4486 - [@​jonathan-r-young](https://togithub.com/jonathan-r-young) made their first contribution in [mermaid-js/mermaid#4460 - [@​tobie](https://togithub.com/tobie) made their first contribution in [mermaid-js/mermaid#4512 - [@​schackartk](https://togithub.com/schackartk) made their first contribution in [mermaid-js/mermaid#4521 - [@​mcbeelen](https://togithub.com/mcbeelen) made their first contribution in [mermaid-js/mermaid#4524 - [@​ellenealds](https://togithub.com/ellenealds) made their first contribution in [mermaid-js/mermaid#4539 - [@​nienow](https://togithub.com/nienow) made their first contribution in [mermaid-js/mermaid#4557 - [@​AlexMooney](https://togithub.com/AlexMooney) made their first contribution in [mermaid-js/mermaid#4561 **Full Changelog**: mermaid-js/mermaid@v10.2.3...v10.2.4 </details> --- ### Configuration 📅 **Schedule**: Branch creation - At any time (no schedule defined), Automerge - At any time (no schedule defined). 🚦 **Automerge**: Disabled by config. Please merge this manually once you are satisfied. ♻ **Rebasing**: Whenever PR becomes conflicted, or you tick the rebase/retry checkbox. 🔕 **Ignore**: Close this PR and you won't be reminded about this update again. --- - [ ] <!-- rebase-check -->If you want to rebase/retry this PR, check this box --- This PR has been generated by [Mend Renovate](https://www.mend.io/free-developer-tools/renovate/). View repository job log [here](https://developer.mend.io/github/levaintech/contented). <!--renovate-debug:eyJjcmVhdGVkSW5WZXIiOiIzNS4xNDQuMiIsInVwZGF0ZWRJblZlciI6IjM1LjE0NC4yIiwidGFyZ2V0QnJhbmNoIjoibWFpbiJ9--> Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
](https://renovatebot.com){kind=link}
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
📑 Summary
This PR changes two things:
Add hint on
graphThe documentation on flowcharts uses
flowchartWhen opening the live editor (https://mermaid.live/), it uses
graphfor a flow chartThe documentation contains the hint on
graphonly in "Other examples":Reformat notes
Currently, notes are formatted using
**Note:**. According to https://vitepress.vuejs.org/guide/markdown#custom-containers, it is possible to have other stylings:This PR uses that for the flowchart description.
📏 Design Decisions
📋 Tasks
Make sure you
developbranch