docs: fix text overflow by huynhicode · Pull Request #3907 · mermaid-js/mermaid

huynhicode · 2022-12-12T05:15:32Z

📑 Summary

This PR fixes text overflow found on several pages of the documentation:

accessibility
directives
gantt
n00b-advanced
usage

An example:

There is also an issue of image overflows found in gitgraph.md, which can be a separate PR.

Resolves #

none

📏 Design Decisions

Describe the way your implementation works or what design decisions you made if applicable.

📋 Tasks

Make sure you

📖 have read the contribution guidelines
💻 have added unit/e2e tests (if appropriate)
🔖 targeted develop branch

sidharthv96

This is superb work! Just a tiny change.

Thank you @huynhicode :)

aloisklink

Thanks for the fix!

It might also be worth updating the table/list to an actual Markdown table/list as well (see suggestions).

aloisklink · 2022-12-17T23:59:10Z

+```markdown
 %a - abbreviated weekday name.
 %A - full weekday name.
 %b - abbreviated month name.
 %B - full month name.
 %c - date and time, as "%a %b %e %H:%M:%S %Y".
 %d - zero-padded day of the month as a decimal number [01,31].
-%e - space-padded day of the month as a decimal number [ 1,31]; equivalent to %_d.
+%e - space-padded day of the month as a decimal number [ 1,31]; equivalent to %\_d.


We could convert this to a plain Markdown list with something like:

- `%a` - abbreviated weekday name. - `%A` - full weekday name. - `%b` - abbreviated month name. - `%B` - full month name. - `%c` - date and time, as `"%a %b %e %H:%M:%S %Y"`. - `%d` - zero-padded day of the month as a decimal number [01,31]. - `%e` - space-padded day of the month as a decimal number [ 1,31]. Equivalent to `%_d`. - `%H` - hour (24-hour clock) as a decimal number [00,23]. - `%I` - hour (12-hour clock) as a decimal number [01,12]. - `%j` - day of the year as a decimal number [001,366]. - `%m` - month as a decimal number [01,12]. - `%M` - minute as a decimal number [00,59]. - `%L` - milliseconds as a decimal number [000, 999]. - `%p` - either AM or PM. - `%S` - second as a decimal number [00,61]. - `%U` - week number of the year (Sunday as the first day of the week) as a decimal number [00,53]. - `%w` - weekday as a decimal number [0(Sunday),6]. - `%W` - week number of the year (Monday as the first day of the week) as a decimal number [00,53]. - `%x` - date, as `"%m/%d/%Y"`. - `%X` - time, as `"%H:%M:%S"`. - `%y` - year without century as a decimal number [00,99]. - `%Y` - year with century as a decimal number. - `%Z` - time zone offset, such as `"-0700"`. - `%%` - a literal `"%"` character.

E.g.

%a - abbreviated weekday name.

%A - full weekday name.

%b - abbreviated month name.

%B - full month name.

%c - date and time, as "%a %b %e %H:%M:%S %Y".

%d - zero-padded day of the month as a decimal number [01,31].

%e - space-padded day of the month as a decimal number [ 1,31]. Equivalent to %_d.

%H - hour (24-hour clock) as a decimal number [00,23].

%I - hour (12-hour clock) as a decimal number [01,12].

%j - day of the year as a decimal number [001,366].

%m - month as a decimal number [01,12].

%M - minute as a decimal number [00,59].

%L - milliseconds as a decimal number [000, 999].

%p - either AM or PM.

%S - second as a decimal number [00,61].

%U - week number of the year (Sunday as the first day of the week) as a decimal number [00,53].

%w - weekday as a decimal number [0(Sunday),6].

%W - week number of the year (Monday as the first day of the week) as a decimal number [00,53].

%x - date, as "%m/%d/%Y".

%X - time, as "%H:%M:%S".

%y - year without century as a decimal number [00,99].

%Y - year with century as a decimal number.

%Z - time zone offset, such as "-0700".

%% - a literal "%" character.

Thank you @aloisklink !

I think a table format for this section makes the most sense visually. I played around with the content being in a markdown block and as bullet points (see screenshots).

Table:

Markdown:

Bullet points

huynhicode · 2022-12-20T17:37:03Z

@aloisklink Thank you!

Co-authored-by: Alois Klink <alois@aloisklink.com>

sidharthv96 · 2022-12-21T04:55:35Z

@huynhicode, if you can finish the last comment and run a pnpm lint:fix and push, we can get it in. :)

huynhicode · 2022-12-21T19:30:22Z

Thank you @sidharthv96 and @aloisklink for reviewing!

There are other formatting updates that I would like to make to the documentation and I will work on them in a separate PR.

aloisklink

Looks great to me!

I'll hold off on merging this, in case @sidharthv96 wants to make any comments, but from my side, it all looks great!

sidharthv96 · 2022-12-23T19:00:26Z

Thanks @huynhicode !

[![Mend Renovate](https://app.renovatebot.com/images/banner.svg)](https://renovatebot.com) This PR contains the following updates: | Package | Change | Age | Adoption | Passing | Confidence | |---|---|---|---|---|---| | [mermaid](https://togithub.com/mermaid-js/mermaid) | [`9.3.0` -> `10.2.3`](https://renovatebot.com/diffs/npm/mermaid/9.3.0/10.2.3) | [![age](https://badges.renovateapi.com/packages/npm/mermaid/10.2.3/age-slim)](https://docs.renovatebot.com/merge-confidence/) | [![adoption](https://badges.renovateapi.com/packages/npm/mermaid/10.2.3/adoption-slim)](https://docs.renovatebot.com/merge-confidence/) | [![passing](https://badges.renovateapi.com/packages/npm/mermaid/10.2.3/compatibility-slim/9.3.0)](https://docs.renovatebot.com/merge-confidence/) | [![confidence](https://badges.renovateapi.com/packages/npm/mermaid/10.2.3/confidence-slim/9.3.0)](https://docs.renovatebot.com/merge-confidence/) | --- ### Release Notes <details> <summary>mermaid-js/mermaid</summary> ### [`v10.2.3`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.2.3): 10.2.3 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.2...v10.2.3) ### Release Notes - Fix [#4408](https://togithub.com/mermaid-js/mermaid/issues/4408): Handle wrapping long words ([#4416](https://togithub.com/mermaid-js/mermaid/issues/4416)) [@MikeJeffers](https://togithub.com/MikeJeffers) - Fix exceptions for empty lines ([#4436](https://togithub.com/mermaid-js/mermaid/issues/4436)) [@luin](https://togithub.com/luin) - Restore classes on edges for elk ([#4452](https://togithub.com/mermaid-js/mermaid/issues/4452)) [@yoavst](https://togithub.com/yoavst) - Update docs: Added Nextra to Blogs category on integrations page ([#4463](https://togithub.com/mermaid-js/mermaid/issues/4463)) [@try-to-fly](https://togithub.com/try-to-fly) 🎉 **Thanks to all contributors helping with this release!** 🎉 #### What's Changed - Address mermaid-zenuml PR comments by [@dontry](https://togithub.com/dontry) in [https://github.com/mermaid-js/mermaid/pull/4405](https://togithub.com/mermaid-js/mermaid/pull/4405) - Fix broken `pnpm-lock.yaml` file to fix CI by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4425](https://togithub.com/mermaid-js/mermaid/pull/4425) - Quadrant chart unicode arrows by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4400](https://togithub.com/mermaid-js/mermaid/pull/4400) - chore(deps): update all patch dependencies (patch) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4434](https://togithub.com/mermaid-js/mermaid/pull/4434) - Add CKEditor and GitHub Writer to available integrations by [@AnnaTomanek](https://togithub.com/AnnaTomanek) in [https://github.com/mermaid-js/mermaid/pull/4440](https://togithub.com/mermaid-js/mermaid/pull/4440) - Update diagram proposal by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4448](https://togithub.com/mermaid-js/mermaid/pull/4448) - Add `@mermaid-js/mermaid-zenuml` package for zenuml Integration by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4334](https://togithub.com/mermaid-js/mermaid/pull/4334) - Restore classes on edges for elk by [@yoavst](https://togithub.com/yoavst) in [https://github.com/mermaid-js/mermaid/pull/4452](https://togithub.com/mermaid-js/mermaid/pull/4452) - Fix exceptions for empty lines by [@luin](https://togithub.com/luin) in [https://github.com/mermaid-js/mermaid/pull/4436](https://togithub.com/mermaid-js/mermaid/pull/4436) - Update docs: Added Nextra to Blogs category on integrations page by [@try-to-fly](https://togithub.com/try-to-fly) in [https://github.com/mermaid-js/mermaid/pull/4463](https://togithub.com/mermaid-js/mermaid/pull/4463) - Fix [#4408](https://togithub.com/mermaid-js/mermaid/issues/4408): Handle wrapping long words by [@MikeJeffers](https://togithub.com/MikeJeffers) in [https://github.com/mermaid-js/mermaid/pull/4416](https://togithub.com/mermaid-js/mermaid/pull/4416) #### New Contributors - [@AnnaTomanek](https://togithub.com/AnnaTomanek) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4440](https://togithub.com/mermaid-js/mermaid/pull/4440) - [@yoavst](https://togithub.com/yoavst) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4452](https://togithub.com/mermaid-js/mermaid/pull/4452) - [@try-to-fly](https://togithub.com/try-to-fly) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4463](https://togithub.com/mermaid-js/mermaid/pull/4463) - [@MikeJeffers](https://togithub.com/MikeJeffers) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4416](https://togithub.com/mermaid-js/mermaid/pull/4416) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.2.2...v10.2.3 ### [`v10.2.2`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.2.2): 10.2.2 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.1...v10.2.2) #### What's Changed - [#4446](https://togithub.com/mermaid-js/mermaid/issues/4446) Removing the ability to inject css using arrowMarkers by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4447](https://togithub.com/mermaid-js/mermaid/pull/4447) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.2.1...v10.2.2 ### [`v10.2.1`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.2.1): 10.2.1 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.2.0...v10.2.1) #### What's Changed #### Bugfixes - [#4438](https://togithub.com/mermaid-js/mermaid/issues/4438) Reverted to the changes from [#4285](https://togithub.com/mermaid-js/mermaid/issues/4285) by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4445](https://togithub.com/mermaid-js/mermaid/pull/4445) - Merge PR [#4425](https://togithub.com/mermaid-js/mermaid/issues/4425) to `master` to fix uploading v10.2.0 docs to `mermaid.js.org` website by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4426](https://togithub.com/mermaid-js/mermaid/pull/4426) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.2.0...v10.2.1 ### [`v10.2.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.2.0): 10.2.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.1.0...v10.2.0) #### What's Changed #### Features - Added support for quadrant chart by [@amsubhash](https://togithub.com/amsubhash) in [https://github.com/mermaid-js/mermaid/pull/4383](https://togithub.com/mermaid-js/mermaid/pull/4383) - Bar chart (using gantt chart) by [@karistom](https://togithub.com/karistom) in [https://github.com/mermaid-js/mermaid/pull/4261](https://togithub.com/mermaid-js/mermaid/pull/4261) - Support node16 module resolution by [@remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/mermaid-js/mermaid/pull/4213](https://togithub.com/mermaid-js/mermaid/pull/4213) - Add UMD build Back by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4281](https://togithub.com/mermaid-js/mermaid/pull/4281) #### Bugfixes - Fix [#4195](https://togithub.com/mermaid-js/mermaid/issues/4195) start and end arrow have different sizes by [@legonigel](https://togithub.com/legonigel) in [https://github.com/mermaid-js/mermaid/pull/4286](https://togithub.com/mermaid-js/mermaid/pull/4286) - fix: really import esm version of dayjs by [@emersonbottero](https://togithub.com/emersonbottero) in [https://github.com/mermaid-js/mermaid/pull/4285](https://togithub.com/mermaid-js/mermaid/pull/4285) - fix: image rendering in nodes by [@Valentine14th](https://togithub.com/Valentine14th) in [https://github.com/mermaid-js/mermaid/pull/4268](https://togithub.com/mermaid-js/mermaid/pull/4268) - Fix and test a bunch of invalid CSS issues by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4295](https://togithub.com/mermaid-js/mermaid/pull/4295) - Fix git graph css bracket leak by [@lishid](https://togithub.com/lishid) in [https://github.com/mermaid-js/mermaid/pull/4278](https://togithub.com/mermaid-js/mermaid/pull/4278) - pie diagram mermaid module import fix by [@agentraghav](https://togithub.com/agentraghav) in [https://github.com/mermaid-js/mermaid/pull/4316](https://togithub.com/mermaid-js/mermaid/pull/4316) - fix applitools by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4335](https://togithub.com/mermaid-js/mermaid/pull/4335) - Multiple updates to class diagram by [@jgreywolf](https://togithub.com/jgreywolf) in [https://github.com/mermaid-js/mermaid/pull/4303](https://togithub.com/mermaid-js/mermaid/pull/4303) - fix ClassGrammar by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4338](https://togithub.com/mermaid-js/mermaid/pull/4338) - updating es6 rules in flowchart diagram by [@agentraghav](https://togithub.com/agentraghav) in [https://github.com/mermaid-js/mermaid/pull/4357](https://togithub.com/mermaid-js/mermaid/pull/4357) - Reject ridiculous years in Gantt charts. by [@toolness](https://togithub.com/toolness) in [https://github.com/mermaid-js/mermaid/pull/4367](https://togithub.com/mermaid-js/mermaid/pull/4367) - Fix regression errors in sequenceDiagrams by [@knsv](https://togithub.com/knsv) - Refactor to consolidate shared svgDraw components by [@jgreywolf](https://togithub.com/jgreywolf) in [https://github.com/mermaid-js/mermaid/pull/4259](https://togithub.com/mermaid-js/mermaid/pull/4259) - Implement `package` on class diagram by [@ksilverwall](https://togithub.com/ksilverwall) in [https://github.com/mermaid-js/mermaid/pull/4206](https://togithub.com/mermaid-js/mermaid/pull/4206) - add master detail relationship support by [@tcbuzor](https://togithub.com/tcbuzor) in [https://github.com/mermaid-js/mermaid/pull/4361](https://togithub.com/mermaid-js/mermaid/pull/4361) - test: fix classDiagramGrammer unit test by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4378](https://togithub.com/mermaid-js/mermaid/pull/4378) - Allow overlapping notes by [@jgreywolf](https://togithub.com/jgreywolf) in [https://github.com/mermaid-js/mermaid/pull/4370](https://togithub.com/mermaid-js/mermaid/pull/4370) - remove SimpleMarkdown by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4350](https://togithub.com/mermaid-js/mermaid/pull/4350) - Show all contributors in homepage by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4356](https://togithub.com/mermaid-js/mermaid/pull/4356) ### Documentation - Update index.md by [@onayiga](https://togithub.com/onayiga) in [https://github.com/mermaid-js/mermaid/pull/4294](https://togithub.com/mermaid-js/mermaid/pull/4294) - Add Slab to the list of integrations by [@luin](https://togithub.com/luin) in [https://github.com/mermaid-js/mermaid/pull/4272](https://togithub.com/mermaid-js/mermaid/pull/4272) - docs(integrations): list quarto by [@eitsupi](https://togithub.com/eitsupi) in [https://github.com/mermaid-js/mermaid/pull/4299](https://togithub.com/mermaid-js/mermaid/pull/4299) - Updating documentation on notes for classes within class diagrams by [@Will-Low](https://togithub.com/Will-Low) in [https://github.com/mermaid-js/mermaid/pull/4296](https://togithub.com/mermaid-js/mermaid/pull/4296) - Add integrations by [@remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/mermaid-js/mermaid/pull/4374](https://togithub.com/mermaid-js/mermaid/pull/4374) - Docs: Flowchart - minor verbiage update by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/4315](https://togithub.com/mermaid-js/mermaid/pull/4315) - Latest News section: update content by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/4366](https://togithub.com/mermaid-js/mermaid/pull/4366) - Improve the wording of security level values by [@Gusted](https://togithub.com/Gusted) in [https://github.com/mermaid-js/mermaid/pull/4395](https://togithub.com/mermaid-js/mermaid/pull/4395) - Indent subgraph sections by [@danielcompton](https://togithub.com/danielcompton) in [https://github.com/mermaid-js/mermaid/pull/4349](https://togithub.com/mermaid-js/mermaid/pull/4349) - fix(doc): Link to Obsidian doc/integration by [@dix](https://togithub.com/dix) in [https://github.com/mermaid-js/mermaid/pull/4309](https://togithub.com/mermaid-js/mermaid/pull/4309) #### Chores - Update bug_report.yml by [@bish0polis](https://togithub.com/bish0polis) in [https://github.com/mermaid-js/mermaid/pull/4297](https://togithub.com/mermaid-js/mermaid/pull/4297) - docs(flowchart): wrap br tag by codeblock by [@Bogay](https://togithub.com/Bogay) in [https://github.com/mermaid-js/mermaid/pull/4310](https://togithub.com/mermaid-js/mermaid/pull/4310) - chore(deps): update pnpm to v7.30.5 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4304](https://togithub.com/mermaid-js/mermaid/pull/4304) - chore(deps): update dependency concurrently to v8 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4323](https://togithub.com/mermaid-js/mermaid/pull/4323) - fix(deps): update dependency dompurify to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4331](https://togithub.com/mermaid-js/mermaid/pull/4331) - chore(deps): update dependency eslint-plugin-jsdoc to v43 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4324](https://togithub.com/mermaid-js/mermaid/pull/4324) - chore(deps): update actions/deploy-pages action to v2 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4322](https://togithub.com/mermaid-js/mermaid/pull/4322) - chore(deps): update dependency rimraf to v5 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4326](https://togithub.com/mermaid-js/mermaid/pull/4326) - chore(deps): update dependency eslint-plugin-unicorn to v46 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4325](https://togithub.com/mermaid-js/mermaid/pull/4325) - chore(deps): update dependency start-server-and-test to v2 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4327](https://togithub.com/mermaid-js/mermaid/pull/4327) - chore(deps): update pnpm to v8 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4330](https://togithub.com/mermaid-js/mermaid/pull/4330) - chore(deps): update fregante/setup-git-user action to v2 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4329](https://togithub.com/mermaid-js/mermaid/pull/4329) - fix(deps): update all minor dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4321](https://togithub.com/mermaid-js/mermaid/pull/4321) - chore(deps): update dependency typescript to v5 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4328](https://togithub.com/mermaid-js/mermaid/pull/4328) - Clarify FontAwesome support by [@josh-bouganim-avant](https://togithub.com/josh-bouganim-avant) in [https://github.com/mermaid-js/mermaid/pull/4347](https://togithub.com/mermaid-js/mermaid/pull/4347) - Fix missing `await` in usage document by [@rhysd](https://togithub.com/rhysd) in [https://github.com/mermaid-js/mermaid/pull/4376](https://togithub.com/mermaid-js/mermaid/pull/4376) - chore(deps): update all patch dependencies (patch) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4379](https://togithub.com/mermaid-js/mermaid/pull/4379) - chore(deps): update all minor dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4380](https://togithub.com/mermaid-js/mermaid/pull/4380) 🎉 **Thanks to all contributors helping with this release!** 🎉 #### New Contributors - [@karistom](https://togithub.com/karistom) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4261](https://togithub.com/mermaid-js/mermaid/pull/4261) - [@Valentine14th](https://togithub.com/Valentine14th) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4268](https://togithub.com/mermaid-js/mermaid/pull/4268) - [@onayiga](https://togithub.com/onayiga) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4294](https://togithub.com/mermaid-js/mermaid/pull/4294) - [@legonigel](https://togithub.com/legonigel) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4286](https://togithub.com/mermaid-js/mermaid/pull/4286) - [@luin](https://togithub.com/luin) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4272](https://togithub.com/mermaid-js/mermaid/pull/4272) - [@eitsupi](https://togithub.com/eitsupi) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4299](https://togithub.com/mermaid-js/mermaid/pull/4299) - [@dix](https://togithub.com/dix) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4309](https://togithub.com/mermaid-js/mermaid/pull/4309) - [@Bogay](https://togithub.com/Bogay) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4310](https://togithub.com/mermaid-js/mermaid/pull/4310) - [@agentraghav](https://togithub.com/agentraghav) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4316](https://togithub.com/mermaid-js/mermaid/pull/4316) - [@Will-Low](https://togithub.com/Will-Low) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4296](https://togithub.com/mermaid-js/mermaid/pull/4296) - [@josh-bouganim-avant](https://togithub.com/josh-bouganim-avant) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4347](https://togithub.com/mermaid-js/mermaid/pull/4347) - [@toolness](https://togithub.com/toolness) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4367](https://togithub.com/mermaid-js/mermaid/pull/4367) - [@ksilverwall](https://togithub.com/ksilverwall) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4206](https://togithub.com/mermaid-js/mermaid/pull/4206) - [@tcbuzor](https://togithub.com/tcbuzor) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4361](https://togithub.com/mermaid-js/mermaid/pull/4361) - [@rhysd](https://togithub.com/rhysd) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4376](https://togithub.com/mermaid-js/mermaid/pull/4376) - [@Gusted](https://togithub.com/Gusted) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4395](https://togithub.com/mermaid-js/mermaid/pull/4395) - [@danielcompton](https://togithub.com/danielcompton) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4349](https://togithub.com/mermaid-js/mermaid/pull/4349) - [@amsubhash](https://togithub.com/amsubhash) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4383](https://togithub.com/mermaid-js/mermaid/pull/4383) *** **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.1.0...v10.2.0 Thanks to [Mermaid Chart](https://www.mermaidchart.com) for ongoing support ### [`v10.1.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.1.0): 10.1.0 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.0.2...v10.1.0) #### What's Changed ### Features - Markdown strings for simple formatting and automatic wrapping of text by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4271](https://togithub.com/mermaid-js/mermaid/pull/4271) [Read more ...](https://www.mermaidchart.com/blog/posts/automatic-text-wrapping-in-flowcharts-is-here) - Implement repeating tasks by [@JeremyFunk](https://togithub.com/JeremyFunk) in [https://github.com/mermaid-js/mermaid/pull/4238](https://togithub.com/mermaid-js/mermaid/pull/4238) ### Bugfixes - Pie: Adding outer border, text position options by [@Billiam](https://togithub.com/Billiam) in [https://github.com/mermaid-js/mermaid/pull/4145](https://togithub.com/mermaid-js/mermaid/pull/4145) - Fix: add require entry in package.json by [@lauraceconi](https://togithub.com/lauraceconi) in [https://github.com/mermaid-js/mermaid/pull/4164](https://togithub.com/mermaid-js/mermaid/pull/4164) - feat: expose the diagram api by [@ted-marozzi](https://togithub.com/ted-marozzi) in [https://github.com/mermaid-js/mermaid/pull/4174](https://togithub.com/mermaid-js/mermaid/pull/4174) - Expose detectType function by [@Pr0dt0s](https://togithub.com/Pr0dt0s) in [https://github.com/mermaid-js/mermaid/pull/4187](https://togithub.com/mermaid-js/mermaid/pull/4187) - Remove duplication in "A hexagon node" by [@andrew-clarkson](https://togithub.com/andrew-clarkson) in [https://github.com/mermaid-js/mermaid/pull/4211](https://togithub.com/mermaid-js/mermaid/pull/4211) - Updated render to remove comments from text by [@kshitijsaksena](https://togithub.com/kshitijsaksena) in [https://github.com/mermaid-js/mermaid/pull/4247](https://togithub.com/mermaid-js/mermaid/pull/4247) - Define and export the Mermaid type by [@remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/mermaid-js/mermaid/pull/4253](https://togithub.com/mermaid-js/mermaid/pull/4253) - fix([#4137](https://togithub.com/mermaid-js/mermaid/issues/4137)): Cleanup comments before parsing by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4257](https://togithub.com/mermaid-js/mermaid/pull/4257) - fix([#4256](https://togithub.com/mermaid-js/mermaid/issues/4256)): Keep error diagram on screen by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4258](https://togithub.com/mermaid-js/mermaid/pull/4258) - Fix broken Gantt `todayMarker` tests by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4207](https://togithub.com/mermaid-js/mermaid/pull/4207) - Docs: add Latest News section by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/4254](https://togithub.com/mermaid-js/mermaid/pull/4254) - Release/10.1.0 by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4276](https://togithub.com/mermaid-js/mermaid/pull/4276) ### Documentation - Update integrations.md to include Mermaid Flow Visual Editor by [@ted-marozzi](https://togithub.com/ted-marozzi) in [https://github.com/mermaid-js/mermaid/pull/4184](https://togithub.com/mermaid-js/mermaid/pull/4184) - docs: make contributing to docs a bit clearer by [@ted-marozzi](https://togithub.com/ted-marozzi) in [https://github.com/mermaid-js/mermaid/pull/4186](https://togithub.com/mermaid-js/mermaid/pull/4186) - Clean up list of ignored links by [@mre](https://togithub.com/mre) in [https://github.com/mermaid-js/mermaid/pull/4197](https://togithub.com/mermaid-js/mermaid/pull/4197) - v smol fixes while reading thru docs by [@andrew-clarkson](https://togithub.com/andrew-clarkson) in [https://github.com/mermaid-js/mermaid/pull/4210](https://togithub.com/mermaid-js/mermaid/pull/4210) - Updated DokuWiki plugin for Mermaid integration by [@RobertWeinmeister](https://togithub.com/RobertWeinmeister) in [https://github.com/mermaid-js/mermaid/pull/4209](https://togithub.com/mermaid-js/mermaid/pull/4209) - typo fix by [@Whoeza](https://togithub.com/Whoeza) in [https://github.com/mermaid-js/mermaid/pull/4221](https://togithub.com/mermaid-js/mermaid/pull/4221) - Updates to the Homepage by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/4226](https://togithub.com/mermaid-js/mermaid/pull/4226) - Fix typos in timeline docs by [@xuanxu](https://togithub.com/xuanxu) in [https://github.com/mermaid-js/mermaid/pull/4237](https://togithub.com/mermaid-js/mermaid/pull/4237) - docs: Remove repeated phrase by [@vorburger](https://togithub.com/vorburger) in [https://github.com/mermaid-js/mermaid/pull/4230](https://togithub.com/mermaid-js/mermaid/pull/4230) - Fix hexagon node flowchart code example in docs by [@piradata](https://togithub.com/piradata) in [https://github.com/mermaid-js/mermaid/pull/4246](https://togithub.com/mermaid-js/mermaid/pull/4246) ### Chores - chore(deps): update all non-major dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4191](https://togithub.com/mermaid-js/mermaid/pull/4191) - CI(e2e): Skip caching in `actions/setup-node`, as `cypress-io/github-action` already caches for us by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4194](https://togithub.com/mermaid-js/mermaid/pull/4194) - fix(deps): update all non-major dependencies (patch) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4190](https://togithub.com/mermaid-js/mermaid/pull/4190) - fix([#1066](https://togithub.com/mermaid-js/mermaid/issues/1066)): Return true if parse is success. by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4183](https://togithub.com/mermaid-js/mermaid/pull/4183) - fix(squence): getBBox() returns zero by [@ischanx](https://togithub.com/ischanx) in [https://github.com/mermaid-js/mermaid/pull/4181](https://togithub.com/mermaid-js/mermaid/pull/4181) - fix(deps): update all non-major dependencies (patch) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4218](https://togithub.com/mermaid-js/mermaid/pull/4218) - chore(deps): update node.js to v18.15.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4219](https://togithub.com/mermaid-js/mermaid/pull/4219) - Update [@types/lodash-es](https://togithub.com/types/lodash-es) by [@remcohaszing](https://togithub.com/remcohaszing) in [https://github.com/mermaid-js/mermaid/pull/4228](https://togithub.com/mermaid-js/mermaid/pull/4228) - chore(deps): update pnpm to v7.30.0 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4232](https://togithub.com/mermaid-js/mermaid/pull/4232) - chore(deps): update pnpm to v7.30.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4231](https://togithub.com/mermaid-js/mermaid/pull/4231) - Remove inline-specifiers pnpm option from `.npmrc` file to avoid merge conflicts by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4249](https://togithub.com/mermaid-js/mermaid/pull/4249) #### New Contributors - [@ted-marozzi](https://togithub.com/ted-marozzi) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4184](https://togithub.com/mermaid-js/mermaid/pull/4184) - [@lauraceconi](https://togithub.com/lauraceconi) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4164](https://togithub.com/mermaid-js/mermaid/pull/4164) - [@Pr0dt0s](https://togithub.com/Pr0dt0s) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4187](https://togithub.com/mermaid-js/mermaid/pull/4187) - [@ischanx](https://togithub.com/ischanx) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4181](https://togithub.com/mermaid-js/mermaid/pull/4181) - [@mre](https://togithub.com/mre) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4197](https://togithub.com/mermaid-js/mermaid/pull/4197) - [@andrew-clarkson](https://togithub.com/andrew-clarkson) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4211](https://togithub.com/mermaid-js/mermaid/pull/4211) - [@RobertWeinmeister](https://togithub.com/RobertWeinmeister) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4209](https://togithub.com/mermaid-js/mermaid/pull/4209) - [@Whoeza](https://togithub.com/Whoeza) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4221](https://togithub.com/mermaid-js/mermaid/pull/4221) - [@remcohaszing](https://togithub.com/remcohaszing) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4228](https://togithub.com/mermaid-js/mermaid/pull/4228) - [@vorburger](https://togithub.com/vorburger) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4230](https://togithub.com/mermaid-js/mermaid/pull/4230) - [@xuanxu](https://togithub.com/xuanxu) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4237](https://togithub.com/mermaid-js/mermaid/pull/4237) - [@piradata](https://togithub.com/piradata) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4246](https://togithub.com/mermaid-js/mermaid/pull/4246) - [@JeremyFunk](https://togithub.com/JeremyFunk) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4238](https://togithub.com/mermaid-js/mermaid/pull/4238) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.0.2...v10.1.0 ### [`v10.0.2`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.0.2): 10.0.2 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.0.1...v10.0.2) ### Release Notes #### Bugfixes - fix: dayjs import extension [@sidharthv96](https://togithub.com/sidharthv96) ### [`v10.0.1`](https://togithub.com/mermaid-js/mermaid/releases/tag/v10.0.1): 10.0.1 [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v10.0.0...v10.0.1) ### Release Notes ### Features - Added grammar to skip comment in attribute block ([#4128](https://togithub.com/mermaid-js/mermaid/issues/4128)) [@kshitijsaksena](https://togithub.com/kshitijsaksena) - feat: Add support for classDiagram labels ([#4086](https://togithub.com/mermaid-js/mermaid/issues/4086)) [@sidharthv96](https://togithub.com/sidharthv96) - 💄 section width now covers all tasks ([#4074](https://togithub.com/mermaid-js/mermaid/issues/4074)) [@l2fprod](https://togithub.com/l2fprod) - 💄 section width now covers all tasks - Timeline ([#4126](https://togithub.com/mermaid-js/mermaid/issues/4126)) [@sidharthv96](https://togithub.com/sidharthv96) ### Bugfixes - Fix([#4140](https://togithub.com/mermaid-js/mermaid/issues/4140)): Async bug in mermaid.run ([#4142](https://togithub.com/mermaid-js/mermaid/issues/4142)) [@sidharthv96](https://togithub.com/sidharthv96) - fix [#4157](https://togithub.com/mermaid-js/mermaid/issues/4157): Inject only fontFamily without replacing themeVariables ([#4160](https://togithub.com/mermaid-js/mermaid/issues/4160)) [@sidharthv96](https://togithub.com/sidharthv96) - fix: Detector order ([#4124](https://togithub.com/mermaid-js/mermaid/issues/4124)) [@sidharthv96](https://togithub.com/sidharthv96) - fix: fix exports ([#4135](https://togithub.com/mermaid-js/mermaid/issues/4135)) [@Mister-Hope](https://togithub.com/Mister-Hope) - fix [#4157](https://togithub.com/mermaid-js/mermaid/issues/4157): Inject only fontFamily without replacing themeVariables by [@sidharthv96](https://togithub.com/sidharthv96) - Elk layout for flowcharts: Incorrect placement of edges when using diamonds in subgraphs by [@knsv](https://togithub.com/knsv) ### Documentation - Adding app (Deepdwn) to integrations list ([#4127](https://togithub.com/mermaid-js/mermaid/issues/4127)) [@Billiam](https://togithub.com/Billiam) - Doc (typo): remove duplicate "be" ([#4133](https://togithub.com/mermaid-js/mermaid/issues/4133)) [@Julez404](https://togithub.com/Julez404)  - docs(flowchart): duplicated hexagon node example by [@Oliboy50](https://togithub.com/Oliboy50) - add links to NiceGUI integration by [@rodja](https://togithub.com/rodja) - Adding app (Deepdwn) to integrations list by [@Billiam](https://togithub.com/Billiam) #### Chores - chore: dagre-d3-es@7.0.9 ([#4147](https://togithub.com/mermaid-js/mermaid/issues/4147)) [@sidharthv96](https://togithub.com/sidharthv96) - Replace `moment-mini`/`moment` date library with `dayjs` ([#4153](https://togithub.com/mermaid-js/mermaid/issues/4153)) [@aloisklink](https://togithub.com/aloisklink) 🎉 **Thanks to all contributors helping with this release!** 🎉 #### New Contributors - [@Oliboy50](https://togithub.com/Oliboy50) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4105](https://togithub.com/mermaid-js/mermaid/pull/4105) - [@rodja](https://togithub.com/rodja) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4107](https://togithub.com/mermaid-js/mermaid/pull/4107) - [@Julez404](https://togithub.com/Julez404) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4133](https://togithub.com/mermaid-js/mermaid/pull/4133) - [@l2fprod](https://togithub.com/l2fprod) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4074](https://togithub.com/mermaid-js/mermaid/pull/4074) - [@kshitijsaksena](https://togithub.com/kshitijsaksena) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4128](https://togithub.com/mermaid-js/mermaid/pull/4128) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v10.0.0...v10.0.1 ### [`v10.0.0`](https://togithub.com/mermaid-js/mermaid/blob/HEAD/CHANGELOG.md#1000-httpsgithubcommermaid-jsmermaidreleasestagv1000) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v9.4.3...v10.0.0) ##### Mermaid is ESM only! We've dropped CJS support. So, you will have to update your import scripts as follows. ```html <script type="module"> import mermaid from 'https://cdn.jsdelivr.net/npm/mermaid@10/dist/mermaid.esm.min.mjs'; mermaid.initialize({ startOnLoad: true }); </script> ``` You can keep using v9 by adding the `@9` in the CDN URL. ```diff - <script src="https://cdn.jsdelivr.net/npm/mermaid/dist/mermaid.js"></script> + <script src="https://cdn.jsdelivr.net/npm/mermaid@9/dist/mermaid.js"></script> ``` ##### mermaid.render is async and doesn't accept callbacks ```js // < v10 mermaid.render('id', 'graph TD;\nA-->B', (svg, bindFunctions) => { element.innerHTML = svg; if (bindFunctions) { bindFunctions(element); } }); // Shorter syntax if (bindFunctions) { bindFunctions(element); } // can be replaced with the `?.` shorthand bindFunctions?.(element); // >= v10 with async/await const { svg, bindFunctions } = await mermaid.render('id', 'graph TD;\nA-->B'); element.innerHTML = svg; bindFunctions?.(element); // >= v10 with promise.then mermaid.render('id', 'graph TD;A-->B').then(({ svg, bindFunctions }) => { element.innerHTML = svg; bindFunctions?.(element); }); ``` ##### mermaid.parse is async and ParseError is removed ```js // < v10 mermaid.parse(text, parseError); //>= v10 await mermaid.parse(text).catch(parseError); // or try { await mermaid.parse(text); } catch (err) { parseError(err); } ``` ##### Init deprecated and InitThrowsErrors removed The config passed to `init` was not being used eariler. It will now be used. The `init` function is deprecated and will be removed in the next major release. init currently works as a wrapper to `initialize` and `run`. ```js // < v10 mermaid.init(config, selector, cb); //>= v10 mermaid.initialize(config); mermaid.run({ querySelector: selector, postRenderCallback: cb, suppressErrors: true, }); ``` ```js // < v10 mermaid.initThrowsErrors(config, selector, cb); //>= v10 mermaid.initialize(config); mermaid.run({ querySelector: selector, postRenderCallback: cb, suppressErrors: false, }); ``` // TODO: Populate changelog pre v10 - Config has a lot of changes - globalReset resets to `defaultConfig` instead of current config. Use `reset` instead. ### [`v9.4.3`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.4.3) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v9.4.2...v9.4.3) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v9.4.2...v9.4.3 Fixes imports for dayjs and cytoscape. ### [`v9.4.2`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.4.2) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v9.4.0...v9.4.2) #### What's Changed - chore(deps): update all non-major dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4044](https://togithub.com/mermaid-js/mermaid/pull/4044) - chore(deps): update dependency [@types/uuid](https://togithub.com/types/uuid) to v9 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4067](https://togithub.com/mermaid-js/mermaid/pull/4067) - build(lint:fix): cache eslint in pnpm run lint:fix by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4073](https://togithub.com/mermaid-js/mermaid/pull/4073) - chore(deps): update dependency rimraf to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4070](https://togithub.com/mermaid-js/mermaid/pull/4070) - chore(deps): update dependency jsdom to v21 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4069](https://togithub.com/mermaid-js/mermaid/pull/4069) - chore(deps): update timonvs/pr-labeler-action action to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4072](https://togithub.com/mermaid-js/mermaid/pull/4072) - chore(deps): update actions/configure-pages action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4065](https://togithub.com/mermaid-js/mermaid/pull/4065) - chore(deps): update actions/dependency-review-action action to v3 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4066](https://togithub.com/mermaid-js/mermaid/pull/4066) - docs: minor fix on markdown by [@Jeff-Tian](https://togithub.com/Jeff-Tian) in [https://github.com/mermaid-js/mermaid/pull/4015](https://togithub.com/mermaid-js/mermaid/pull/4015) - Add logo to readme by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4076](https://togithub.com/mermaid-js/mermaid/pull/4076) - Release 9.4.1 by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4095](https://togithub.com/mermaid-js/mermaid/pull/4095) - chore(deps): update dependency vite to v4 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4071](https://togithub.com/mermaid-js/mermaid/pull/4071) - chore(deps): update dependency cypress to v12 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4068](https://togithub.com/mermaid-js/mermaid/pull/4068) - fix(api): tree shaking package.json import by [@AielloChan](https://togithub.com/AielloChan) in [https://github.com/mermaid-js/mermaid/pull/4101](https://togithub.com/mermaid-js/mermaid/pull/4101) #### New Contributors - [@Jeff-Tian](https://togithub.com/Jeff-Tian) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4015](https://togithub.com/mermaid-js/mermaid/pull/4015) - [@AielloChan](https://togithub.com/AielloChan) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4101](https://togithub.com/mermaid-js/mermaid/pull/4101) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v9.4.0...v9.4.2 ### [`v9.4.0`](https://togithub.com/mermaid-js/mermaid/releases/tag/v9.4.0) [Compare Source](https://togithub.com/mermaid-js/mermaid/compare/v9.3.0...v9.4.0) #### What's Changed ##### Features - Timeline Diagram by [@ashishjain0512](https://togithub.com/ashishjain0512) in [https://github.com/mermaid-js/mermaid/pull/4014](https://togithub.com/mermaid-js/mermaid/pull/4014) - feat: Flowchart layout using elkjs by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/3984](https://togithub.com/mermaid-js/mermaid/pull/3984) - Layout v3 continued by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/3938](https://togithub.com/mermaid-js/mermaid/pull/3938) - feat(er): add unique key by [@tomperr](https://togithub.com/tomperr) in [https://github.com/mermaid-js/mermaid/pull/3917](https://togithub.com/mermaid-js/mermaid/pull/3917) - feat: Set svg role to 'graphics-document document' by [@weedySeaDragon](https://togithub.com/weedySeaDragon) in [https://github.com/mermaid-js/mermaid/pull/3897](https://togithub.com/mermaid-js/mermaid/pull/3897) - feat: Wait for rendering to finish before taking image snapshots by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/3995](https://togithub.com/mermaid-js/mermaid/pull/3995) - feat(er): add multiple key constraints by [@tomperr](https://togithub.com/tomperr) in [https://github.com/mermaid-js/mermaid/pull/4030](https://togithub.com/mermaid-js/mermaid/pull/4030) - Add support for YAML frontmatter in Markdown docs (used for Vitepress config) by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3962](https://togithub.com/mermaid-js/mermaid/pull/3962) - feat(er): allow leading underscore for attributes name by [@tomperr](https://togithub.com/tomperr) in [https://github.com/mermaid-js/mermaid/pull/4033](https://togithub.com/mermaid-js/mermaid/pull/4033) - Add links to theme listing by [@BD103](https://togithub.com/BD103) in [https://github.com/mermaid-js/mermaid/pull/3890](https://togithub.com/mermaid-js/mermaid/pull/3890) - Adding support for parenthesis in the er diagram attribute types. by [@mahomedalid](https://togithub.com/mahomedalid) in [https://github.com/mermaid-js/mermaid/pull/3892](https://togithub.com/mermaid-js/mermaid/pull/3892) - Support parsing indented mermaid/YAML only from HTML by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3859](https://togithub.com/mermaid-js/mermaid/pull/3859) - Parse style string and number font size values from configuration inputs by [@jonabc](https://togithub.com/jonabc) in [https://github.com/mermaid-js/mermaid/pull/3993](https://togithub.com/mermaid-js/mermaid/pull/3993) - Mindmaps: differentiate the colors between the root node and the first section [#4017](https://togithub.com/mermaid-js/mermaid/issues/4017) by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4018](https://togithub.com/mermaid-js/mermaid/pull/4018) - Add Box support in Sequence Diagrams by [@oleveau](https://togithub.com/oleveau) in [https://github.com/mermaid-js/mermaid/pull/3965](https://togithub.com/mermaid-js/mermaid/pull/3965) ##### Breaking changes - Mind map and timeline diagrams are lazy loaded by mermaid. In order to use these diagrams you need to use the renderAsync method of rendering. The [@mermaid-js/mermaid-mindmap](https://togithub.com/mermaid-js/mermaid-mindmap) package is deprecated by this. ##### Documentation - doc: remove links from atom.io; add note Atom has been archived by [@weedySeaDragon](https://togithub.com/weedySeaDragon) in [https://github.com/mermaid-js/mermaid/pull/3899](https://togithub.com/mermaid-js/mermaid/pull/3899) - docs(README.zh-CN): fix book image src by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3920](https://togithub.com/mermaid-js/mermaid/pull/3920) - docs: fix typo by [@Foo-x](https://togithub.com/Foo-x) in [https://github.com/mermaid-js/mermaid/pull/3925](https://togithub.com/mermaid-js/mermaid/pull/3925) - docs: update navbar by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/3906](https://togithub.com/mermaid-js/mermaid/pull/3906) - docs: fix text overflow by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/3907](https://togithub.com/mermaid-js/mermaid/pull/3907) - docs: Remove duplicate example in ER-diagram documentation by [@guilhermgonzaga](https://togithub.com/guilhermgonzaga) in [https://github.com/mermaid-js/mermaid/pull/3964](https://togithub.com/mermaid-js/mermaid/pull/3964) - Docs: Too many `primaryBorderColor` field by [@LiHowe](https://togithub.com/LiHowe) in [https://github.com/mermaid-js/mermaid/pull/3986](https://togithub.com/mermaid-js/mermaid/pull/3986) - docs(sequenceDiagram): subvert prettification of arrow types by [@cakemanny](https://togithub.com/cakemanny) in [https://github.com/mermaid-js/mermaid/pull/3988](https://togithub.com/mermaid-js/mermaid/pull/3988) - Add Swimm to the list of integrations by [@Omerr](https://togithub.com/Omerr) in [https://github.com/mermaid-js/mermaid/pull/3936](https://togithub.com/mermaid-js/mermaid/pull/3936) - Website/homepage updates by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/3945](https://togithub.com/mermaid-js/mermaid/pull/3945) - Update sequenceDiagram.md to include line break by [@Odogwudozilla](https://togithub.com/Odogwudozilla) in [https://github.com/mermaid-js/mermaid/pull/3960](https://togithub.com/mermaid-js/mermaid/pull/3960) - Support GitHub Flavored Markdown in markdown documentation by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3954](https://togithub.com/mermaid-js/mermaid/pull/3954) - Update integrations.md by [@Barry1](https://togithub.com/Barry1) in [https://github.com/mermaid-js/mermaid/pull/4011](https://togithub.com/mermaid-js/mermaid/pull/4011) - docs(readme): update broken twitter badge by [@LeoDog896](https://togithub.com/LeoDog896) in [https://github.com/mermaid-js/mermaid/pull/4032](https://togithub.com/mermaid-js/mermaid/pull/4032) - Update mindmap.md by [@GavinPen](https://togithub.com/GavinPen) in [https://github.com/mermaid-js/mermaid/pull/4042](https://togithub.com/mermaid-js/mermaid/pull/4042) - Showcase section to the docs - keepings docs up to date by [@Omerr](https://togithub.com/Omerr) in [https://github.com/mermaid-js/mermaid/pull/4055](https://togithub.com/mermaid-js/mermaid/pull/4055) ##### Bug Fixes - fix(docs): remove duplicate section by [@Joxtacy](https://togithub.com/Joxtacy) in [https://github.com/mermaid-js/mermaid/pull/3908](https://togithub.com/mermaid-js/mermaid/pull/3908) - fix: Typescript error in usage by [@tommoor](https://togithub.com/tommoor) in [https://github.com/mermaid-js/mermaid/pull/3914](https://togithub.com/mermaid-js/mermaid/pull/3914) - fix: dev server watch mode by [@huynhicode](https://togithub.com/huynhicode) in [https://github.com/mermaid-js/mermaid/pull/3904](https://togithub.com/mermaid-js/mermaid/pull/3904) - fix(er): switch to deterministic UUIDs in ER by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3916](https://togithub.com/mermaid-js/mermaid/pull/3916) - fixed Composition arrow by [@Frank-Mayer](https://togithub.com/Frank-Mayer) in [https://github.com/mermaid-js/mermaid/pull/3930](https://togithub.com/mermaid-js/mermaid/pull/3930) - fix(generic): fix generic type detection by [@tomperr](https://togithub.com/tomperr) in [https://github.com/mermaid-js/mermaid/pull/3921](https://togithub.com/mermaid-js/mermaid/pull/3921) - fix typos accessing techn property in drawC4Shape function by [@nekikara](https://togithub.com/nekikara) in [https://github.com/mermaid-js/mermaid/pull/3943](https://togithub.com/mermaid-js/mermaid/pull/3943) - fix(deps): update dependency dompurify to v2.4.3 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3977](https://togithub.com/mermaid-js/mermaid/pull/3977) - Fix nonstandard syntax by [@atmikeguo](https://togithub.com/atmikeguo) in [https://github.com/mermaid-js/mermaid/pull/3972](https://togithub.com/mermaid-js/mermaid/pull/3972) - Fix failing tests due to semantic merge conflict by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3985](https://togithub.com/mermaid-js/mermaid/pull/3985) - fix(deps): update dependency dagre-d3-es to v7.0.6 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3996](https://togithub.com/mermaid-js/mermaid/pull/3996) - fix([#4003](https://togithub.com/mermaid-js/mermaid/issues/4003)): Remove unhandled promises by [@sidharthv96](https://togithub.com/sidharthv96) in [https://github.com/mermaid-js/mermaid/pull/4004](https://togithub.com/mermaid-js/mermaid/pull/4004) - Bug/3858 \[state] trailing whitespace in ids for named state container by [@weedySeaDragon](https://togithub.com/weedySeaDragon) in [https://github.com/mermaid-js/mermaid/pull/3902](https://togithub.com/mermaid-js/mermaid/pull/3902) - fix: moment-mini default exporter by [@emersonbottero](https://togithub.com/emersonbottero) in [https://github.com/mermaid-js/mermaid/pull/4034](https://togithub.com/mermaid-js/mermaid/pull/4034) - fix(deps): update dependency dagre-d3-es to v7.0.8 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4058](https://togithub.com/mermaid-js/mermaid/pull/4058) - bugfix: add missing d3 curves to flowchart and docs by [@natasha-jarus](https://togithub.com/natasha-jarus) in [https://github.com/mermaid-js/mermaid/pull/4038](https://togithub.com/mermaid-js/mermaid/pull/4038) - Bug/3865 C4Context: $borderColor has no effect by [@nekikara](https://togithub.com/nekikara) in [https://github.com/mermaid-js/mermaid/pull/3947](https://togithub.com/mermaid-js/mermaid/pull/3947) - Mindmaps: Handling rows with only spaces in them ([#4012](https://togithub.com/mermaid-js/mermaid/issues/4012)) by [@knsv](https://togithub.com/knsv) in [https://github.com/mermaid-js/mermaid/pull/4013](https://togithub.com/mermaid-js/mermaid/pull/4013) ##### Chores - ci: disable checking twitter links by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/3973](https://togithub.com/mermaid-js/mermaid/pull/3973) - chore(deps): update all non-major dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3905](https://togithub.com/mermaid-js/mermaid/pull/3905) - chore(deps): update pnpm to v7.18.2 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3929](https://togithub.com/mermaid-js/mermaid/pull/3929) - chore(pr): add documentation task in PR template by [@tomperr](https://togithub.com/tomperr) in [https://github.com/mermaid-js/mermaid/pull/3935](https://togithub.com/mermaid-js/mermaid/pull/3935) - (chore) Docs: add tag to produce only a diagram, not code example by [@weedySeaDragon](https://togithub.com/weedySeaDragon) in [https://github.com/mermaid-js/mermaid/pull/3946](https://togithub.com/mermaid-js/mermaid/pull/3946) - chore(deps): update all non-major dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3944](https://togithub.com/mermaid-js/mermaid/pull/3944) - chore(deps): update all non-major dependencies (minor) by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/3997](https://togithub.com/mermaid-js/mermaid/pull/3997) - chore(deps): update pnpm to v7.25.1 by [@renovate](https://togithub.com/renovate) in [https://github.com/mermaid-js/mermaid/pull/4024](https://togithub.com/mermaid-js/mermaid/pull/4024) - build(lint): cache prettier on `pnpm run lint` by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4035](https://togithub.com/mermaid-js/mermaid/pull/4035) - Cache `eslint` in pre-commit script (makes `git commit` 5x faster) by [@aloisklink](https://togithub.com/aloisklink) in [https://github.com/mermaid-js/mermaid/pull/4057](https://togithub.com/mermaid-js/mermaid/pull/4057) #### New Contributors - [@Joxtacy](https://togithub.com/Joxtacy) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3908](https://togithub.com/mermaid-js/mermaid/pull/3908) - [@BD103](https://togithub.com/BD103) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3890](https://togithub.com/mermaid-js/mermaid/pull/3890) - [@mahomedalid](https://togithub.com/mahomedalid) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3892](https://togithub.com/mermaid-js/mermaid/pull/3892) - [@tomperr](https://togithub.com/tomperr) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3917](https://togithub.com/mermaid-js/mermaid/pull/3917) - [@Foo-x](https://togithub.com/Foo-x) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3925](https://togithub.com/mermaid-js/mermaid/pull/3925) - [@Frank-Mayer](https://togithub.com/Frank-Mayer) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3930](https://togithub.com/mermaid-js/mermaid/pull/3930) - [@Omerr](https://togithub.com/Omerr) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3936](https://togithub.com/mermaid-js/mermaid/pull/3936) - [@nekikara](https://togithub.com/nekikara) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3943](https://togithub.com/mermaid-js/mermaid/pull/3943) - [@guilhermgonzaga](https://togithub.com/guilhermgonzaga) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3964](https://togithub.com/mermaid-js/mermaid/pull/3964) - [@Odogwudozilla](https://togithub.com/Odogwudozilla) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3960](https://togithub.com/mermaid-js/mermaid/pull/3960) - [@atmikeguo](https://togithub.com/atmikeguo) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3972](https://togithub.com/mermaid-js/mermaid/pull/3972) - [@LiHowe](https://togithub.com/LiHowe) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3986](https://togithub.com/mermaid-js/mermaid/pull/3986) - [@cakemanny](https://togithub.com/cakemanny) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3988](https://togithub.com/mermaid-js/mermaid/pull/3988) - [@jonabc](https://togithub.com/jonabc) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3993](https://togithub.com/mermaid-js/mermaid/pull/3993) - [@MermaidChart](https://togithub.com/MermaidChart) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4013](https://togithub.com/mermaid-js/mermaid/pull/4013) - [@Barry1](https://togithub.com/Barry1) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4011](https://togithub.com/mermaid-js/mermaid/pull/4011) - [@LeoDog896](https://togithub.com/LeoDog896) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4032](https://togithub.com/mermaid-js/mermaid/pull/4032) - [@GavinPen](https://togithub.com/GavinPen) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4042](https://togithub.com/mermaid-js/mermaid/pull/4042) - [@oleveau](https://togithub.com/oleveau) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/3965](https://togithub.com/mermaid-js/mermaid/pull/3965) - [@natasha-jarus](https://togithub.com/natasha-jarus) made their first contribution in [https://github.com/mermaid-js/mermaid/pull/4038](https://togithub.com/mermaid-js/mermaid/pull/4038) **Full Changelog**: https://github.com/mermaid-js/mermaid/compare/v9.3.0...v9.4.0 </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. --- - [ ] 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://app.renovatebot.com/dashboard#github/BirthdayResearch/contented).  Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>

fix text overflow

e4622ba

sidharthv96 requested changes Dec 15, 2022

View reviewed changes

Comment thread packages/mermaid/src/docs/config/directives.md Outdated

huynhicode requested a review from sidharthv96 December 15, 2022 20:37

minor syntax update

528facf

aloisklink reviewed Dec 18, 2022

View reviewed changes

add support for vitepress blocks

469bdce

huynhicode and others added 2 commits December 20, 2022 09:37

Update packages/mermaid/src/docs/syntax/gantt.md

0f337d6

Co-authored-by: Alois Klink <alois@aloisklink.com>

Update packages/mermaid/src/docs/syntax/gantt.md

b220718

Co-authored-by: Alois Klink <alois@aloisklink.com>

update outdate format info formatting

22b6619

huynhicode added 2 commits December 21, 2022 14:21

retrigger CI

69928e3

Merge branch 'develop' into docs/formatting

dbfb29d

aloisklink approved these changes Dec 22, 2022

View reviewed changes

sidharthv96 approved these changes Dec 23, 2022

View reviewed changes

sidharthv96 merged commit 8ed1ad5 into mermaid-js:develop Dec 23, 2022

Navigation Menu

Repository navigation

docs: fix text overflow - #3907

docs: fix text overflow#3907
sidharthv96 merged 8 commits into
mermaid-js:developfrom
huynhicode:docs/formatting

huynhicode commented Dec 12, 2022

Uh oh!

sidharthv96 left a comment

Uh oh!

Uh oh!

aloisklink left a comment

Uh oh!

Uh oh!

Uh oh!

aloisklink Dec 17, 2022

Uh oh!

huynhicode Dec 21, 2022

Uh oh!

huynhicode commented Dec 20, 2022

Uh oh!

sidharthv96 commented Dec 21, 2022

Uh oh!

huynhicode commented Dec 21, 2022

Uh oh!

aloisklink left a comment

Uh oh!

sidharthv96 commented Dec 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

Conversation

huynhicode commented Dec 12, 2022

📑 Summary

📏 Design Decisions

📋 Tasks

Uh oh!

sidharthv96 left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

aloisklink left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

aloisklink Dec 17, 2022

Choose a reason for hiding this comment

Uh oh!

huynhicode Dec 21, 2022

Choose a reason for hiding this comment

Uh oh!

huynhicode commented Dec 20, 2022

Uh oh!

sidharthv96 commented Dec 21, 2022

Uh oh!

huynhicode commented Dec 21, 2022

Uh oh!

aloisklink left a comment

Choose a reason for hiding this comment

Uh oh!

sidharthv96 commented Dec 23, 2022

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants