Compare commits

..

866 Commits

Author SHA1 Message Date
Sidharth Vinod
0b4f129220 Merge branch 'master' into add-flowchart-blog-post
* master:
  Changes to intro.md 1. Removed the Slack link 2. Updated the Discord invite link
  Changes to intro.md 1. Removed the Slack invite and left only the Discord invite
  Changes to intro.md 1. Added a link to the Discord server
2024-02-09 13:45:14 +05:30
Sidharth Vinod
1406de5a6c Merge pull request #5268 from FutzMonitor/updateContribute
Update contribute
2024-02-09 13:44:26 +05:30
futzmonitor
ec7591bfa8 Changes to intro.md
1. Removed the Slack link
2. Updated the Discord invite link
2024-02-09 13:41:55 +05:30
futzmonitor
c45f39e819 Changes to intro.md
1. Removed the Slack invite and left only the Discord invite
2024-02-09 13:41:55 +05:30
futzmonitor
6682988403 Changes to intro.md
1. Added a link to the Discord server
2024-02-09 13:41:54 +05:30
steph
5f8749418e add latest blog post 2024-02-04 23:08:43 -08:00
Knut Sveidqvist
1c61ccabad Merge branch 'release/10.8.0' 2024-02-02 11:33:33 +01:00
Knut Sveidqvist
3fe7e2dfe8 Updated contributions file 2024-02-02 11:30:29 +01:00
Knut Sveidqvist
51e7444b94 #3358 Layoutfix for growing parent when children spans new rows due to updated columns widths 2024-02-02 11:10:42 +01:00
knsv
2fa9219353 Update docs 2024-02-02 07:56:48 +00:00
Knut Sveidqvist
f5555245f9 Mermaid version 10.8.0 2024-02-02 08:53:29 +01:00
Knut Sveidqvist
5c9857c4eb Merge pull request #5247 from mermaid-js/sidv/mindmapToTs
Convert Mindmap to TS
2024-02-01 13:23:13 +00:00
Christian
494ba45c5e Fixed Typo in ErrorRenderer.ts (#5256)
* Changes to flow.jison
1. Added support for the plus symbol.

* Changes to errorRenderer.ts
1. Fixed a typo where 'renering' instead 'rendering'

* Revert "Changes to flow.jison"

This reverts commit 28b9dc897f.
2024-02-01 17:32:52 +05:30
Ashish Jain
b38def6866 Merge pull request #5221 from mermaid-js/3358-blocks-diagram
Adding new diagram type - Block Diagram
2024-02-01 11:22:18 +00:00
Knut Sveidqvist
a7afc11079 #3358 Removing redundant file 2024-02-01 10:49:59 +01:00
Knut Sveidqvist
d3c5b02008 Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358-blocks-diagram 2024-02-01 10:41:11 +01:00
Knut Sveidqvist
16149abcc0 #3358 Fix after review 2024-02-01 10:40:39 +01:00
Ashish Jain
13d0b61757 Merge branch 'develop' into 3358-blocks-diagram 2024-01-31 15:08:09 +01:00
Sidharth Vinod
45f4d3d443 Merge branch 'develop' into sidv/mindmapToTs 2024-01-31 15:20:16 +05:30
Sidharth Vinod
33d45f639c Merge pull request #5254 from mermaid-js/chore/InterfaceNaming
chore: Add interface naming Convention
2024-01-31 09:49:59 +00:00
Sidharth Vinod
7503694453 Merge pull request #5241 from Ronid1/feature/4653-add_actor-top_class_to_sequence_diagram
Feature/4653 add actor-top class to sequence diagram
2024-01-31 09:15:18 +00:00
Sidharth Vinod
e9680e086e Fix selector 2024-01-31 14:27:46 +05:30
Knut Sveidqvist
cd7003e9c1 Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358-blocks-diagram 2024-01-31 09:55:13 +01:00
Sidharth Vinod
941d9d13d5 Merge branch 'develop' into feature/4653-add_actor-top_class_to_sequence_diagram 2024-01-31 14:22:26 +05:30
Knut Sveidqvist
4786cfb6aa #3358 Renaming of IOperation to ActionFun 2024-01-31 09:50:11 +01:00
Sidharth Vinod
7aa4466b69 chore: Add interface naming 2024-01-31 14:19:01 +05:30
Sidharth Vinod
2bfd5a9e2a Merge branch 'develop' into 3358-blocks-diagram
* develop:
  Update container
  Update container
  Remove pnpm cache
  Use `.node-version` file in workflows
  Remove node version from matrix
  Update to Node v20
  Update to Node v20
2024-01-31 14:11:53 +05:30
Sidharth Vinod
56da881ed4 Merge branch 'develop' into sidv/mindmapToTs
* develop:
  Update container
  Update container
  Remove pnpm cache
  Use `.node-version` file in workflows
  fix: Redirect of old URLs
  Remove node version from matrix
  Update to Node v20
  Update to Node v20
  fix lint
  add latest blog post
  update discord invite link
  remove holiday promo text
2024-01-31 14:10:51 +05:30
Sidharth Vinod
aa50db8bf5 Merge pull request #5248 from mermaid-js/sidv/node20
Use node v20
2024-01-31 08:10:41 +00:00
Sidharth Vinod
e8db7a71e2 Update container 2024-01-31 11:35:07 +05:30
Sidharth Vinod
f00e7676b9 Update container 2024-01-31 11:32:55 +05:30
Sidharth Vinod
63ef228ed0 Remove pnpm cache 2024-01-31 09:42:33 +05:30
Knut Sveidqvist
6fce617284 3358 Adding types for blockArrowHelper 2024-01-30 17:48:46 +01:00
Sidharth Vinod
2a64834ecc Merge branch 'develop' into sidv/node20
* develop:
  fix: Redirect of old URLs
  fix lint
  add latest blog post
  update discord invite link
  remove holiday promo text
2024-01-30 22:10:23 +05:30
Knut Sveidqvist
7bcdea9bd1 #3358n Updated lockfile 2024-01-30 16:55:01 +01:00
Knut Sveidqvist
8fdf512b4c Merge branch 'develop' into 3358-blocks-diagram 2024-01-30 16:53:46 +01:00
knsv
dbcb80087c Update docs 2024-01-30 15:29:43 +00:00
Knut Sveidqvist
b99b1bfd0c #3358 Another set of review changes 2024-01-30 16:26:10 +01:00
Sidharth Vinod
fcffa6ca4e Merge branch 'develop' into feature/4653-add_actor-top_class_to_sequence_diagram 2024-01-30 20:51:52 +05:30
Sidharth Vinod
6fd69090ed Merge branch 'master' into develop
* master:
  fix: Redirect of old URLs
  fix lint
  add latest blog post
  update discord invite link
  remove holiday promo text
2024-01-30 20:50:30 +05:30
Sidharth Vinod
051ef598f6 Use .node-version file in workflows
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 20:44:39 +05:30
Knut Sveidqvist
907006ff3d #3358 Some fixes 2024-01-30 16:07:19 +01:00
Knut Sveidqvist
df9b801b0e #3358 Some fixes 2024-01-30 16:05:16 +01:00
Sidharth Vinod
726d633dd3 Use config from defaultConfig
Co-authored-by: Reda Al Sulais <u.yokozuna@gmail.com>
2024-01-30 20:00:54 +05:30
Knut Sveidqvist
4a04ce6bf8 Update cypress/integration/rendering/block.spec.ts
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2024-01-30 14:49:14 +01:00
Knut Sveidqvist
010fc703eb Update packages/mermaid/src/diagrams/block/blockTypes.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 14:46:14 +01:00
Knut Sveidqvist
8f8ce2f142 Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358-blocks-diagram 2024-01-30 14:37:53 +01:00
Knut Sveidqvist
452cb83ad7 #3358 Review changes 2024-01-30 14:37:35 +01:00
Knut Sveidqvist
2f8f9dd341 Update packages/mermaid/src/diagrams/block/blockDB.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 14:36:38 +01:00
Knut Sveidqvist
4a14d997d1 Update packages/mermaid/src/diagrams/block/blockRenderer.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 14:18:58 +01:00
Knut Sveidqvist
10237976f3 Merge branch 'develop' into 3358-blocks-diagram 2024-01-30 13:21:47 +01:00
Sidharth Vinod
92e7c7b894 Merge pull request #5250 from mermaid-js/fix/DocsRedirect
fix: Redirect of old URLs
2024-01-30 14:59:48 +05:30
Sidharth Vinod
80c20a72b2 Remove MermaidConfigWithDefaults 2024-01-30 14:25:44 +05:30
Sidharth Vinod
2d92ffb085 fix: Redirect of old URLs 2024-01-30 13:41:47 +05:30
Knut Sveidqvist
4823cf5df4 Update packages/mermaid/src/diagrams/block/blockDB.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 08:52:59 +01:00
Knut Sveidqvist
dae8a13e8a Update packages/mermaid/src/defaultConfig.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-30 08:51:47 +01:00
Sidharth Vinod
78f1631c8f Organize imports 2024-01-30 10:04:42 +05:30
Sidharth Vinod
ff6988e875 chore: Address review comments
Co-authored-by: Reda Al Sulais <u.yokozuna@gmail.com>
2024-01-30 09:51:40 +05:30
Ronid1
cddca04885 add actor-bottom to docs 2024-01-29 12:39:39 -08:00
Ronid1
f737c9f6f9 add actor-bottom class 2024-01-29 11:42:23 -08:00
Ronid1
7e86d03dc9 Merge branch 'develop' of https://github.com/mermaid-js/mermaid into feature/4653-add_actor-top_class_to_sequence_diagram 2024-01-29 11:28:01 -08:00
Knut Sveidqvist
bfa8111e14 #3358 Third set of changes after review 2024-01-29 17:32:27 +01:00
Knut Sveidqvist
5aab2ba1dd Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358-blocks-diagram 2024-01-29 16:25:02 +01:00
Knut Sveidqvist
37d7c7e2dd #3358 Second set of changes after review 2024-01-29 16:22:48 +01:00
Knut Sveidqvist
1965f69a10 Update packages/mermaid/src/schemas/config.schema.yaml
Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-29 15:29:26 +01:00
Sidharth Vinod
95dcd30324 Merge branch 'develop' into sidv/mindmapToTs 2024-01-29 16:53:21 +05:30
Sidharth Vinod
65bb82962f Merge branch 'develop' into sidv/node20
* develop:
  Remove node version from matrix
2024-01-29 16:47:45 +05:30
Sidharth Vinod
c84c7f52f9 Remove node version from matrix 2024-01-29 16:46:48 +05:30
Sidharth Vinod
cd04c430af Merge branch 'sidv/node20' of github.com:mermaid-js/mermaid into sidv/node20
* 'sidv/node20' of github.com:mermaid-js/mermaid:
  chore: Update docs
  Update demos/pie.html
  Update pie.html demo
  Fix typos in timeline syntax samples
2024-01-29 16:44:52 +05:30
Sidharth Vinod
dd553cb28f Remove node version from matrix 2024-01-29 16:44:44 +05:30
Sidharth Vinod
25d0de13a5 Merge branch 'develop' into sidv/node20 2024-01-29 16:38:27 +05:30
Sidharth Vinod
52bb31b98a Update to Node v20 2024-01-29 13:56:03 +05:30
Sidharth Vinod
a4a94fd6e2 Update to Node v20 2024-01-29 13:55:51 +05:30
Sidharth Vinod
cd8e354234 Merge pull request #5139 from sblom/patch-2
Fix typos in timeline syntax samples
2024-01-29 08:20:53 +00:00
Sidharth Vinod
d797365802 Merge pull request #5141 from JenningsWilliam/feature_update_pie_labeling
Accurate pie chart labeling for text alignment
2024-01-29 08:19:21 +00:00
Sidharth Vinod
73293efcf3 Merge branch 'develop' into patch-2 2024-01-29 13:29:04 +05:30
Sidharth Vinod
91ae282808 Merge branch 'develop' into feature_update_pie_labeling 2024-01-29 13:28:18 +05:30
Sidharth Vinod
4c551b2aca Lint 2024-01-29 12:35:39 +05:30
Sidharth Vinod
d21461fba0 Lint 2024-01-29 12:27:17 +05:30
Sidharth Vinod
b51d8ff7ba Convert svgDraw.ts 2024-01-29 12:16:21 +05:30
Sidharth Vinod
75ec719257 Rename svgDraw.js 2024-01-29 11:31:22 +05:30
Sidharth Vinod
13e052ff81 Fix styles.ts 2024-01-29 11:26:10 +05:30
Sidharth Vinod
bde6a9ff4f Rename styles.js 2024-01-29 11:21:42 +05:30
Sidharth Vinod
23d843b6d3 refactor: Remove db import from svgDraw 2024-01-29 11:21:12 +05:30
Sidharth Vinod
cffac848ea chore: Fix mindmapDb exports 2024-01-29 10:52:58 +05:30
Sidharth Vinod
9651d0c2da refactor: Fix types and imports 2024-01-29 10:45:47 +05:30
Sidharth Vinod
e1a23f10df chore: Fix config type 2024-01-28 21:43:03 +05:30
Sidharth Vinod
d346a77e3c Convert MindmapRenderer.ts 2024-01-28 16:04:42 +05:30
Sidharth Vinod
f069de5487 Convert MindmapDB.ts 2024-01-28 16:04:42 +05:30
Sidharth Vinod
ba0bddf417 Add MermaidConfigWithDefaults 2024-01-28 16:04:42 +05:30
Sidharth Vinod
f30c26485e Cleanup svgDraw.js 2024-01-28 16:04:41 +05:30
Sidharth Vinod
b71f4c7e54 Add MindmapDB type 2024-01-28 16:04:41 +05:30
Sidharth Vinod
e046da10c2 Convert mindmap.spec.js 2024-01-28 16:04:40 +05:30
Sidharth Vinod
12dc3d8373 Rename files to TS 2024-01-28 16:04:40 +05:30
Sidharth Vinod
c5272d5279 Merge pull request #5236 from mermaid-js/fix/DompurifyHooks
fix: Dompurify Hooks
2024-01-27 15:11:54 +00:00
Ronid1
9ee5667580 Merge branch 'develop' of https://github.com/mermaid-js/mermaid into feature/4653-add_actor-top_class_to_sequence_diagram 2024-01-26 14:08:13 -08:00
Ronid1
36c196e80b add test 2024-01-26 14:07:12 -08:00
Sidharth Vinod
7ca990d762 Merge branch 'develop' into fix/DompurifyHooks 2024-01-27 00:25:15 +05:30
Sidharth Vinod
91907fe0eb Merge pull request #5095 from FutzMonitor/issue1981
Changes to Gantt Parsers to allow hashes and semicolons to titles, sections, and task data.
2024-01-26 17:21:58 +00:00
Sidharth Vinod
6bf5571f96 chore: Update docs 2024-01-26 22:50:17 +05:30
Sidharth Vinod
8619a53a9c Update demos/pie.html 2024-01-26 22:48:12 +05:30
Sidharth Vinod
9bedfa2033 Merge pull request #5160 from vitorsss/fix/4212_actor_menus_sequence_diagram_popup
[Fix] Sequence diagram actor menu popup
2024-01-26 17:16:27 +00:00
FutzMonitor
59264a33d7 Changes to gantt.html
1. Added a Gantt diagram that demonstrates to users that hashtages and semicolons can be added to titles, sections, and task data.
Changes to gantt.spec.js
1. Added unit tests to ensure that semicolons and hashtags didn't break the functionality of the gantt diagram when used in titles, sections or task data.
Changes to /parser/gantt.spec.js
1. Added rendering tests to ensure that semicolons and hashtags in titles, sections, and task data didn't break the rendering of Gantt diagrams.
2024-01-26 11:48:48 -05:00
Ronid1
70d9f50fc9 add const for class name 2024-01-25 17:59:46 -08:00
Ronid1
b253cd65d4 update docs 2024-01-25 17:19:00 -08:00
Ronid1
f2f8d89a28 add actor-top class to rectangle actor and man actor 2024-01-25 17:16:09 -08:00
FutzMonitor
0b0f988180 Merge branch 'develop' into issue1981 2024-01-25 17:03:16 -05:00
Sidharth Vinod
1c200ee5bc perf: prevent adding multiple DOMPurify hooks
Currently, everytime `removeScript()` is called, the same DOMPurify
hooks are getting added again and again.

Co-authored-by: Alois Klink <alois@aloisklink.com>
2024-01-25 23:28:42 +05:30
Sidharth Vinod
98c578da02 Merge pull request #5232 from mermaid-js/mermaid-chart-updates
Docs: Mermaid chart updates
2024-01-24 12:43:54 +05:30
steph
cbf7e6a880 fix lint 2024-01-23 22:17:55 -08:00
steph
8982e2f78c add latest blog post 2024-01-23 22:02:24 -08:00
steph
62ae072918 update discord invite link 2024-01-23 21:59:54 -08:00
steph
04f92e5b1c remove holiday promo text 2024-01-23 21:58:37 -08:00
Sidharth Vinod
6939cf52e6 Merge pull request #5228 from mermaid-js/updateCypress
UpdateCypress
2024-01-24 00:31:20 +05:30
Sidharth Vinod
ec79ac200c Lint 2024-01-23 23:53:48 +05:30
Sidharth Vinod
de03a017db Remove echo 2024-01-23 23:51:48 +05:30
Sidharth Vinod
42ad1f4fe4 RefTest 2024-01-23 23:49:52 +05:30
Sidharth Vinod
a01be16d27 Echo event 2024-01-23 23:38:21 +05:30
Sidharth Vinod
5c6c8d1135 Update cypress 2024-01-23 20:36:29 +05:30
Sidharth Vinod
493f238319 Fix applitools 2024-01-23 20:32:58 +05:30
Sidharth Vinod
17066aab97 Merge branch 'master' of github.com:mermaid-js/mermaid into develop
* 'master' of github.com:mermaid-js/mermaid:
  docs: fix lint
  docs: move community to Discord
  Delete docs/syntax/gantt.html
  Add more detailed docs for Gantt tasks
  Update docs
  Update packages/mermaid/src/docs/syntax/flowchart.md
  Update flowchart.md #5195
2024-01-23 19:55:53 +05:30
Sidharth Vinod
21c9397ec1 Merge pull request #5225 from Olegt0rr/discord
Update Slack community links to Discord
2024-01-23 19:54:53 +05:30
Oleg A
427bcaa3f6 docs: fix lint 2024-01-23 19:53:42 +05:30
Oleg A
8fad1f55e2 docs: move community to Discord 2024-01-23 19:53:41 +05:30
Sidharth Vinod
05e17c0bf0 Merge pull request #5161 from mathbraga/feature/5114_add_parallel_commit_config
Feature/5114 add parallel commit config
2024-01-23 04:40:24 +00:00
Sidharth Vinod
1612d3fabd Merge pull request #5127 from mathbraga/bug/5059_fix_external_connection_after_updating_edges
Bug/5059 fix external connection after updating edges
2024-01-23 02:35:01 +00:00
Matheus Braga
679f77dea5 Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2024-01-22 20:22:50 -03:00
Matheus Braga
1bad612c51 Merge branch 'develop' into feature/5114_add_parallel_commit_config 2024-01-22 20:19:52 -03:00
Matheus B
81825f22f5 Swap condition blocks to avoid using negation 2024-01-22 20:09:20 -03:00
Matheus B
e668698b5c Reposition const declaration to ideal place 2024-01-22 19:56:25 -03:00
Knut Sveidqvist
1629a91a25 Updated lockfile 2024-01-22 14:52:02 +01:00
Knut Sveidqvist
c85b24862d Merge branch 'develop' into 3358-blocks-diagram 2024-01-22 14:19:30 +01:00
Knut Sveidqvist
fe89b9510d #3358 Adjusting docs and a bug fix for nested blocks 2024-01-22 14:14:54 +01:00
Sidharth Vinod
7b624667fa Merge pull request #5219 from Yokozuna59/yokozuna/fix-broken-link
docs: fix swimm link
2024-01-22 08:03:56 +00:00
Matheus Braga
e7c52bbf59 Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2024-01-21 13:20:24 -03:00
Matheus B
3e87412e97 Merge branch 'feature/5114_add_parallel_commit_config' of https://github.com/mathbraga/mermaid into feature/5114_add_parallel_commit_config 2024-01-20 21:13:44 -03:00
Matheus B
2401f334ec Merge branch 'develop' of https://github.com/mathbraga/mermaid into feature/5114_add_parallel_commit_config 2024-01-20 21:07:53 -03:00
Matheus B
4f60a27472 Change repetitive values into consts 2024-01-20 20:57:58 -03:00
Reda Al Sulais
2bbdd15031 docs: fix swimm link 2024-01-20 13:30:49 +03:00
Vitor Soares Silva
c226358f65 Merge branch 'develop' into fix/4212_actor_menus_sequence_diagram_popup 2024-01-19 16:24:54 -03:00
Vitor Soares Silva
8fd268d59b add sequenceDiagram link e2e test 2024-01-19 16:10:23 -03:00
Sidharth Vinod
b91624cb63 Merge pull request #5066 from Ronid1/docs/4974_reorder_integration_links
Docs/4974 reorder integration links
2024-01-19 18:10:58 +00:00
Sidharth Vinod
54f2452406 Merge branch 'develop' of github.com:mermaid-js/mermaid into develop
* 'develop' of github.com:mermaid-js/mermaid:
  Use pnpm/action-setup@v2
  Fix pnpm-lock by resetting it, sorry!
  chore: update browsers list
  Update update-browserlist.yml
  Update update-browserlist.yml to install pnpm
  Update update-browserlist.yml to fix deprecation and action fails
2024-01-19 23:47:14 +05:30
Sidharth Vinod
84a18a1858 Fix Update Browserslist 2024-01-19 23:47:07 +05:30
Sidharth Vinod
5b2a10e592 Merge pull request #5151 from Abrifq/patch-4
Update update-browserlist.yml to fix deprecation and action fails
2024-01-19 23:42:20 +05:30
Sidharth Vinod
8820c7baf1 Merge branch 'develop' into patch-4 2024-01-19 23:39:27 +05:30
Sidharth Vinod
1e70b3817e Use pnpm/action-setup@v2 2024-01-19 23:38:27 +05:30
Sidharth Vinod
1f37b6c91b Fix lint 2024-01-19 23:28:43 +05:30
Sidharth Vinod
c080522102 Merge branch 'develop' into issue1981 2024-01-19 23:18:53 +05:30
Sidharth Vinod
d95fdfee94 Merge branch 'develop' into pr/Ronid1/5066
* develop: (122 commits)
  Cleanup e2e.yml
  Ignore push events on merge queue
  Remove ::
  Remove ::
  Remove ::
  Debug
  Debug
  Remove spec selector
  Handle edge cases in E2E
  Always run combineArtifacts
  Fix error message
  Fix cache save
  Update cache key
  Notify users
  Flatten uploaded images
  Flatten uploaded images
  Use pixelmatch for image comparison
  Run all tests
  Fix lint
  Update lockfile
  ...
2024-01-19 23:15:52 +05:30
Vitor Soares Silva
d74025bd80 Merge branch 'develop' into fix/4212_actor_menus_sequence_diagram_popup 2024-01-19 13:40:30 -03:00
Sidharth Vinod
d0224b23b0 Cleanup e2e.yml 2024-01-19 19:47:42 +05:30
Sidharth Vinod
6334516639 Merge branch 'combineImages' into develop
* combineImages:
  Ignore push events on merge queue
2024-01-19 19:47:12 +05:30
Sidharth Vinod
aadf32ab3e Ignore push events on merge queue 2024-01-19 19:45:55 +05:30
Sidharth Vinod
6424f823b2 Merge pull request #5213 from mermaid-js/combineImages
Optimise caching of test results
2024-01-19 14:09:03 +00:00
Sidharth Vinod
8bfb269b37 Remove :: 2024-01-19 19:33:59 +05:30
Sidharth Vinod
3935f6b389 Remove :: 2024-01-19 19:31:25 +05:30
Sidharth Vinod
f5dd24bce4 Remove :: 2024-01-19 19:29:45 +05:30
Knut Sveidqvist
d96425d19e #3358 Reviving arrow heads after merging develop 2024-01-19 14:57:45 +01:00
Sidharth Vinod
279e31bc55 Debug 2024-01-19 19:23:13 +05:30
Sidharth Vinod
f1fc874da8 Debug 2024-01-19 19:20:39 +05:30
Sidharth Vinod
a871a68f3c Remove spec selector 2024-01-19 19:05:06 +05:30
Sidharth Vinod
a964af67ec Handle edge cases in E2E 2024-01-19 19:04:25 +05:30
Sidharth Vinod
6f205f89b2 Always run combineArtifacts 2024-01-19 16:58:19 +05:30
Sidharth Vinod
35b3192c2b Fix error message 2024-01-19 16:58:19 +05:30
Sidharth Vinod
be4721b24d Fix cache save 2024-01-19 16:58:19 +05:30
Sidharth Vinod
a9a8a208a6 Update cache key 2024-01-19 16:58:19 +05:30
Sidharth Vinod
f58a86d747 Notify users 2024-01-19 16:58:19 +05:30
Sidharth Vinod
4ce5d07125 Flatten uploaded images 2024-01-19 16:58:18 +05:30
Sidharth Vinod
658af081ee Flatten uploaded images 2024-01-19 14:42:51 +05:30
Sidharth Vinod
fdfa917cdb Merge branch 'develop' into feature/5114_add_parallel_commit_config 2024-01-19 14:12:08 +05:30
Sidharth Vinod
46552faa2e Merge branch 'develop' into fix/4212_actor_menus_sequence_diagram_popup 2024-01-19 14:10:30 +05:30
Sidharth Vinod
1285e59080 Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2024-01-19 13:18:45 +05:30
Sidharth Vinod
cb0ee5aa41 Use pixelmatch for image comparison 2024-01-19 13:17:14 +05:30
Sidharth Vinod
95ebb4aaec Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2024-01-19 12:46:17 +05:30
Sidharth Vinod
97f9919250 Merge pull request #5210 from sidharthv96/sidv/e2e
E2E test
2024-01-19 12:24:41 +05:30
Sidharth Vinod
d6e738ac4c Run all tests 2024-01-19 12:21:51 +05:30
Sidharth Vinod
91a63933ec Merge branch 'develop' into sidv/e2e
* develop:
  Fix lint
2024-01-19 12:17:45 +05:30
Sidharth Vinod
448756ab54 Fix lint 2024-01-19 12:17:20 +05:30
Sidharth Vinod
7805e05495 Update lockfile 2024-01-19 12:15:01 +05:30
Sidharth Vinod
98782d3a1f Merge branch 'develop' into sidv/e2e 2024-01-19 12:11:45 +05:30
Sidharth Vinod
76dacf8e90 E2E test 2024-01-19 12:10:39 +05:30
Sidharth Vinod
681d3c3ed8 Merge pull request #5208 from sidharthv96/sidv/e2e
E2E Image comparison
2024-01-19 12:10:14 +05:30
Sidharth Vinod
d2c82c1802 Use cache to store snapshots 2024-01-19 12:06:53 +05:30
Sidharth Vinod
3852117581 Merge pull request #5194 from sorenisanerd/gantt-docs
Add more detailed docs for Gantt tasks
2024-01-19 09:35:33 +05:30
Sidharth Vinod
bf55d940b6 Delete docs/syntax/gantt.html 2024-01-19 09:34:21 +05:30
Soren L. Hansen
e0ee9b1bc0 Add more detailed docs for Gantt tasks 2024-01-19 09:34:20 +05:30
Sidharth Vinod
51aea90e9a Merge pull request #5196 from arukiidou/patch-1
Update flowchart.md - how to use font-awesome #5195
2024-01-19 09:24:32 +05:30
Sidharth Vinod
7918f96f94 Update docs 2024-01-19 09:22:38 +05:30
arukiidou
be8faae68c Update packages/mermaid/src/docs/syntax/flowchart.md
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2024-01-19 09:22:38 +05:30
arukiidou
04ebf0ddc9 Update flowchart.md #5195 2024-01-19 09:22:38 +05:30
Matheus Braga
223c8c92cb Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2024-01-18 20:59:24 -03:00
Knut Sveidqvist
b4dece88e9 Merge branch '3358-blocks-diagram' of github.com:mermaid-js/mermaid into 3358-blocks-diagram 2024-01-18 18:03:58 +01:00
Knut Sveidqvist
d075766760 #3358 Doc updates after viewing the page 2024-01-18 18:03:37 +01:00
Sidharth Vinod
8754b9dd5d Merge pull request #5150 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2024-01-18 17:03:11 +00:00
renovate[bot]
fb7cd9ca40 chore(deps): update all patch dependencies 2024-01-18 16:17:34 +00:00
knsv
5553cbbb22 Update docs 2024-01-18 16:10:57 +00:00
Sidharth Vinod
858d512766 Merge pull request #5200 from mermaid-js/dependabot/npm_and_yarn/follow-redirects-1.15.5
build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5
2024-01-18 16:10:27 +00:00
Sidharth Vinod
781065dee4 Merge pull request #5205 from mathbraga/revert-5197-revert-5041-feature/4935_subgraph-title-margin-config-option
Revert "Revert 5041 feature/4935 subgraph title margin config option"
2024-01-18 16:10:05 +00:00
Knut Sveidqvist
bf64509216 Merge branch 'develop' into 3358-blocks-diagram 2024-01-18 17:07:34 +01:00
Sidharth Vinod
2525966853 Merge pull request #5132 from nirname/docs/2910_update-contributing-guidelines
Contribution documentation improvements
2024-01-18 15:59:47 +00:00
Knut Sveidqvist
173ba2ecf5 Final console.log removed 2024-01-18 15:48:40 +01:00
Knut Sveidqvist
8e147206d8 #3358 Removed logging som type fixes 2024-01-18 15:44:16 +01:00
Knut Sveidqvist
1230da7fc7 #3358 Some cleanup 2024-01-18 15:31:14 +01:00
Knut Sveidqvist
a0d328d734 #3358 Removed logging, fixed som tests 2024-01-18 14:28:14 +01:00
Knut Sveidqvist
bbc7fe6163 #3358 Fix for width of composite blocks 2024-01-18 10:22:09 +01:00
Alois Klink
8788b49351 Merge pull request #5192 from murdoa/bug/5191_fix_gantt_chart_padding_docs
Updated gantt chart docs to show all config options
2024-01-17 18:55:03 +00:00
Matheus Braga
7a8a1315c0 Merge branch 'develop' into feature/5114_add_parallel_commit_config 2024-01-16 21:14:17 -03:00
Matheus B
9213afbacd Add tests for gitgraphs with unconnected branches 2024-01-16 20:55:42 -03:00
Matheus B
c77a6e156c Include logic for gitgraph with unconnected branches 2024-01-16 20:54:26 -03:00
Matheus B
02246f64d2 Include undefined on findClosestParent return types and update the function 2024-01-16 20:01:03 -03:00
Matheus B
bf1edd99f9 Remove unnecessary argument on findClosestParent call 2024-01-16 19:37:52 -03:00
Matheus B
6f09bc7dc7 Use already defined const instead of method call 2024-01-16 19:34:16 -03:00
Matheus B
96ac2369b6 Change string concatenation to template literal 2024-01-16 15:36:31 -03:00
Matheus Braga
8c7edebe93 Revert "Revert 5041 feature/4935 subgraph title margin config option" 2024-01-16 13:21:31 -03:00
Nikolay Rozhkov
36fdff8378 Merge branch 'develop' into docs/2910_update-contributing-guidelines 2024-01-15 13:17:47 +03:00
dependabot[bot]
0e7e597384 build(deps-dev): bump follow-redirects from 1.15.2 to 1.15.5
Bumps [follow-redirects](https://github.com/follow-redirects/follow-redirects) from 1.15.2 to 1.15.5.
- [Release notes](https://github.com/follow-redirects/follow-redirects/releases)
- [Commits](https://github.com/follow-redirects/follow-redirects/compare/v1.15.2...v1.15.5)

---
updated-dependencies:
- dependency-name: follow-redirects
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2024-01-15 09:18:38 +00:00
Sidharth Vinod
dc857f804e Draft release on master 2024-01-15 14:47:03 +05:30
Sidharth Vinod
0bd2340a33 Merge pull request #5188 from mermaid-js/release/10.7.0
Release/10.7.0
2024-01-15 14:34:14 +05:30
Sidharth Vinod
d972ddd932 docs: Add release version 2024-01-15 14:27:48 +05:30
Sidharth Vinod
54307bb0f4 Merge branch 'develop' of github.com:mermaid-js/mermaid into release/10.7.0
* 'develop' of github.com:mermaid-js/mermaid:
  Revert "fix: render the participants in same order as they are created"
  Revert "Feature/4935 subgraph title margin config option"
  Update integrations-community.md (Add Codemia to the list of productivity tools using Mermaid.)
2024-01-15 13:55:04 +05:30
Sidharth Vinod
b3fa9167a0 Merge branches 'master' and 'release/10.7.0' of github.com:mermaid-js/mermaid into release/10.7.0
* 'master' of github.com:mermaid-js/mermaid:
  add inadvertent tracking removal
  update announcement bar

* 'release/10.7.0' of github.com:mermaid-js/mermaid:
2024-01-15 13:39:25 +05:30
Sidharth Vinod
7508d9adc5 Merge pull request #5198 from mermaid-js/revert-5017-bug/4946-fix-svg-order-sequence-participant
Revert "fix: render the participants in same order as they are created"
2024-01-15 07:56:39 +00:00
Sidharth Vinod
d91b3ce857 Merge pull request #5197 from mermaid-js/revert-5041-feature/4935_subgraph-title-margin-config-option
Revert 5041 feature/4935 subgraph title margin config option
2024-01-15 07:52:49 +00:00
Sidharth Vinod
11542b3b5d Revert "fix: render the participants in same order as they are created" 2024-01-15 13:22:00 +05:30
Sidharth Vinod
b46da49f85 Revert "Feature/4935 subgraph title margin config option" 2024-01-15 13:08:58 +05:30
Sidharth Vinod
0e105afbf9 Fix typo 2024-01-15 12:55:28 +05:30
Nikolay Rozhkov
bafb991a35 Run dev docs without npx 2024-01-14 01:07:37 +03:00
Nikolay Rozhkov
385bf328c2 Remove npx completely from run script 2024-01-14 01:05:47 +03:00
nirname
3290c38260 Update docs 2024-01-13 20:41:27 +00:00
Nikolay Rozhkov
621d6cbda1 Fix linters 2024-01-13 23:38:11 +03:00
Nikolay Rozhkov
f6b321d769 Removed volta requirement, leave pnpm only 2024-01-13 15:19:36 +03:00
Abrifq
3fb6acbf8f Fix pnpm-lock by resetting it, sorry! 2024-01-12 23:50:35 +03:00
Abrifq
cbeee51108 Merge branch 'develop' into patch-4 2024-01-12 23:42:18 +03:00
Alois Klink
5e61867c89 Merge pull request #5193 from mermaid-js/v3-announcement-bar
DOCS: update announcement bar
2024-01-12 16:20:32 +00:00
Steph
d6d465d207 add inadvertent tracking removal 2024-01-12 07:54:19 -08:00
steph
c96cc21692 update announcement bar 2024-01-11 22:42:09 -08:00
Nikolay Rozhkov
a3092fc174 Fixed dead link 2024-01-12 02:00:30 +03:00
Nikolay Rozhkov
26f6aec442 build 2024-01-12 01:57:13 +03:00
Nikolay Rozhkov
21ecc28b40 Merge branch 'develop' into docs/2910_update-contributing-guidelines 2024-01-12 01:41:00 +03:00
nirname
374e788e81 Update docs 2024-01-11 22:35:39 +00:00
Nikolay Rozhkov
7219d604a9 Updated contributing docs after review, minor fixes 2024-01-12 01:32:07 +03:00
murdoa
e52fcd0bdd Updated gantt chart docs to show all config options 2024-01-11 22:24:50 +00:00
Steph
1c43e8e15c Merge pull request #5189 from markqian/develop
Update integrations-community.md (Add Codemia to the list of productivity tools using Mermaid)
2024-01-11 18:10:58 +00:00
Mark Qian
e7d239b579 Update integrations-community.md (Add Codemia to the list of productivity tools using Mermaid.) 2024-01-11 12:09:53 -05:00
Sidharth Vinod
904a200620 Merge branch 'develop' into release/10.7.0
* develop:
  update verbiage
  update verbiage
2024-01-11 14:32:16 +05:30
Sidharth Vinod
3e5b395792 v10.7.0 2024-01-11 14:31:57 +05:30
Sidharth Vinod
6ac8523f78 Merge pull request #5169 from mermaid-js/open-arrows
DOCS: update Flowchart page
2024-01-11 05:41:16 +00:00
Sidharth Vinod
6d1a38d2ff 10.6.2-rc.3 2024-01-11 10:27:26 +05:30
Sidharth Vinod
85e7010689 Merge branch 'develop' into release/10.6.2
* develop:
  docs: Remove broken integration
2024-01-11 10:25:42 +05:30
Sidharth Vinod
505689de39 docs: Remove broken integration 2024-01-11 10:25:17 +05:30
Sidharth Vinod
26bab802c7 Merge branch 'develop' into release/10.6.2
* develop: (24 commits)
  chore: Minor cleanup of imperativeState
  add jetbrains blog post
  additional updates
  update latest news pages
  fix addl broken link
  fix link
  build: use `tsx` instead of `ts-node-esm`
  verbiage updates
  fix: replace functional approaches with oop
  feat: Track outbound links in plausible
  update getting started page
  add blog post
  chore: Update promo link
  docs: Holiday promo v2
  Update packages/mermaid/src/docs/.vitepress/components/TopBar.vue
  update announcements page
  update announcement bar verbiage
  chore: fix autogen docs
  chore(sequence): Update packages/mermaid/src/docs/syntax/sequenceDiagram.md
  chore(sequence): update doc for actors/participant creation/deletion fix
  ...
2024-01-11 10:23:24 +05:30
Sidharth Vinod
1d4bb50b32 Merge branch 'develop' of github.com:mermaid-js/mermaid into develop
* 'develop' of github.com:mermaid-js/mermaid:
  chore: Minor cleanup of imperativeState
  fix: replace functional approaches with oop
  chore: fix autogen docs
  chore(sequence): Update packages/mermaid/src/docs/syntax/sequenceDiagram.md
  chore(sequence): update doc for actors/participant creation/deletion fix
  chore: remove unused e2e tests file
  chore: add e2e test that shows db cleanup problem
  chore: add e2e test that shows db cleanup problem
  fix: add imperativeState and replace sequenceDb global variables with it
2024-01-11 10:23:04 +05:30
Sidharth Vinod
2516b20efc Merge branch 'master' into develop
* master:
  add jetbrains blog post
  additional updates
  update latest news pages
  fix addl broken link
  fix link
  build: use `tsx` instead of `ts-node-esm`
  verbiage updates
  feat: Track outbound links in plausible
  update getting started page
  add blog post
  chore: Update promo link
  docs: Holiday promo v2
  Update packages/mermaid/src/docs/.vitepress/components/TopBar.vue
  update announcements page
  update announcement bar verbiage
2024-01-11 10:22:25 +05:30
Sidharth Vinod
977a3f2246 Merge branch 'develop' into release/10.6.2
* develop: (22 commits)
  chore(deps): update all minor dependencies
  adds corresponding change in docs/ecosystem
  Adds Unison programming language to community integrations list
  Fixed parser/tests
  Update docs
  Update classDiagram.md
  Update classDiagram.md
  Update docs
  Update packages/mermaid/src/diagrams/class/classDb.ts
  Update packages/mermaid/src/docs/syntax/classDiagram.md
  Update packages/mermaid/src/diagrams/class/classDb.ts
  chore(deps): update all minor dependencies
  Update generics docs
  Update docs
  Address potential undefined
  refactor: Move maxEdges out of flowchart config.
  refactor: Move maxEdges out of flowchart config.
  chore: Add maxEdges to secure list
  Update packages/mermaid/src/diagrams/class/classDb.ts
  Update docs
  ...
2024-01-11 10:19:00 +05:30
Sidharth Vinod
54446f1ec5 Merge pull request #4941 from rflban/fix/1294_exhaustive-clear-sequenceDb-variables
fix/1294_exhaustive-clear-sequenceDb-variables
2024-01-11 04:48:36 +00:00
Sidharth Vinod
1b20fe9723 Merge branch 'develop' into pr/rflban/4941
* develop: (200 commits)
  chore(deps): update all minor dependencies
  adds corresponding change in docs/ecosystem
  Adds Unison programming language to community integrations list
  Fixed parser/tests
  Update docs
  Update classDiagram.md
  Update classDiagram.md
  Update docs
  Update packages/mermaid/src/diagrams/class/classDb.ts
  Update packages/mermaid/src/docs/syntax/classDiagram.md
  Update packages/mermaid/src/diagrams/class/classDb.ts
  chore(deps): update all minor dependencies
  Update generics docs
  Update docs
  Address potential undefined
  refactor: Move maxEdges out of flowchart config.
  refactor: Move maxEdges out of flowchart config.
  chore: Add maxEdges to secure list
  Update docs
  Update NiceGuy.io links in integrations-community.md
  ...
2024-01-11 09:44:40 +05:30
Sidharth Vinod
0ac339494f chore: Minor cleanup of imperativeState 2024-01-11 09:42:56 +05:30
Sidharth Vinod
34e0942fa2 Merge pull request #5172 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2024-01-10 17:10:14 +00:00
Sidharth Vinod
2b3dee6e45 Merge pull request #5180 from rlmark/develop
Adds Unison programming language to community integrations list
2024-01-10 17:09:24 +00:00
renovate[bot]
8383b1b9bc chore(deps): update all minor dependencies 2024-01-10 15:44:22 +00:00
Rebecca Mark
303e5be16c adds corresponding change in docs/ecosystem 2024-01-09 12:31:35 -08:00
Knut Sveidqvist
1d1875718d #3358 Sieblinmg height alignment 2024-01-08 15:48:59 +01:00
Knut Sveidqvist
7043892e87 #3358 Fix for layout where a siebling has wider siize 2024-01-08 14:03:42 +01:00
Knut Sveidqvist
809c450164 #3358 Support for adding tests and fixed issues for some shapes 2024-01-08 11:49:34 +01:00
Knut Sveidqvist
818cb2fd76 #3358 Adding support for style statements 2024-01-05 20:56:57 +01:00
Nikolay Rozhkov
e628f64a93 Empty 2024-01-05 21:22:56 +03:00
nirname
be7c6377ca Update docs 2024-01-05 18:08:31 +00:00
Nikolay Rozhkov
5f9b965be3 Linters 2024-01-05 21:05:10 +03:00
Nikolay Rozhkov
6d5f33856c Fixed redirects 2024-01-05 19:33:15 +03:00
Nikolay Rozhkov
e0bd684248 Removed duplicated docs, keep community folder name 2024-01-05 18:02:13 +03:00
Nikolay Rozhkov
17312a0232 Cleanup 2024-01-05 17:37:34 +03:00
nirname
a05aba4cc9 Update docs 2024-01-05 14:19:54 +00:00
Nikolay Rozhkov
3c27f46c57 Fixed dead links 2024-01-05 17:16:07 +03:00
Knut Sveidqvist
275e01acba #3358 Adding support for classDef and class statements 2024-01-05 15:13:15 +01:00
nirname
9ccb340d63 Update docs 2024-01-05 13:56:36 +00:00
Nikolay Rozhkov
9aaf63139a Removed unused files 2024-01-05 16:53:31 +03:00
Nikolay Rozhkov
67dde70bec Fixes 2024-01-05 16:36:12 +03:00
Rebecca Mark
54db85bfea Adds Unison programming language to community integrations list 2024-01-04 13:27:02 -08:00
Knut Sveidqvist
72135c294e #3358 Edge labels 2024-01-04 16:28:13 +01:00
Knut Sveidqvist
d0eca268ad #3358 Multiple arrows 2024-01-04 16:05:19 +01:00
Knut Sveidqvist
2ed4469029 #3358 Adding arrows to rendering 2024-01-04 14:15:30 +01:00
Nikolay Rozhkov
98cf63ebb2 Merge branch 'develop' into docs/2910_update-contributing-guidelines 2024-01-04 04:14:18 +03:00
nirname
a32e72b660 Update docs 2024-01-04 01:12:59 +00:00
Nikolay Rozhkov
e7824f05cb Fixes for tutorials link 2024-01-04 04:07:56 +03:00
nirname
e2fd5ecd02 Update docs 2024-01-04 01:00:15 +00:00
Nikolay Rozhkov
a7d0d414b2 Small reorganizing 2024-01-04 03:56:45 +03:00
nirname
8edf96fe1c Update docs 2024-01-04 00:41:07 +00:00
Nikolay Rozhkov
807a5bfab4 Batch of small improvements for the documentation 2024-01-04 03:37:47 +03:00
Steph
5cec92ceb3 update verbiage 2023-12-28 11:53:04 -08:00
Steph
44dcac7501 update verbiage 2023-12-28 11:34:46 -08:00
Matheus B
c50a82a60e Build config types 2023-12-22 21:52:19 -03:00
Matheus Braga
f5ef0b600e Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2023-12-22 21:49:21 -03:00
Matheus B
41f3f9fb32 Fix linter issues 2023-12-22 21:48:19 -03:00
Matheus B
46583cf4eb Merge branch 'develop' into feature/5114_add_parallel_commit_config 2023-12-22 21:32:20 -03:00
Matheus B
eb3e924c44 Add tests for gitGraph with parallel commits 2023-12-22 21:11:50 -03:00
Matheus B
222c46e7f0 Implement support for parallel commits config 2023-12-22 21:08:15 -03:00
Matheus B
00ac6ccb37 Add parallelCommits config option for gitGraphs 2023-12-22 20:42:24 -03:00
Vitor Soares Silva
e6bd1ae9dc fix sequence diagram popup 2023-12-22 11:30:24 -03:00
Steph
5073cfaea2 Merge pull request #5158 from mermaid-js/latest-blog
Docs: add latest blog post - JetBrains extension
2023-12-21 08:08:48 -08:00
Steph
749db745d0 add jetbrains blog post 2023-12-20 16:47:43 -08:00
nirname
d54d13ef28 Update docs 2023-12-21 00:44:22 +00:00
Nikolay Rozhkov
dfa0ad5b7a Refined contribution guide again 2023-12-21 03:41:21 +03:00
Justin Greywolf
60280361b0 Merge pull request #5111 from mermaid-js/2408-support-style-for-class
Added functionality to support style keyword
2023-12-20 15:10:14 +00:00
Ronid1
8e6f5bbdb1 Merge branch 'docs/4974_reorder_integration_links' of https://github.com/Ronid1/mermaid into docs/4974_reorder_integration_links 2023-12-19 18:30:20 -08:00
Ronid1
8002d9e2eb Merge branch 'develop' of https://github.com/mermaid-js/mermaid into docs/4974_reorder_integration_links 2023-12-19 18:17:58 -08:00
Steph
f02114eaab Merge pull request #5112 from mermaid-js/update-getting-started
Docs: update Getting Started page
2023-12-19 12:56:03 -08:00
Steph
2469419070 additional updates 2023-12-19 12:16:01 -08:00
nirname
97ee5a8488 Update docs 2023-12-19 01:36:43 +00:00
Nikolay Rozhkov
d2b9240a22 Simplify things 2023-12-19 04:33:38 +03:00
nirname
37829696d8 Update docs 2023-12-19 00:59:26 +00:00
Nikolay Rozhkov
2705c0de03 Different fixes 2023-12-19 03:56:16 +03:00
nirname
5b58883db8 Update docs 2023-12-18 23:58:33 +00:00
Nikolay Rozhkov
3bc39409e5 Formatting 2023-12-19 02:55:20 +03:00
Nikolay Rozhkov
2f3f76fa24 Contribution guidelines rework 2023-12-19 02:48:22 +03:00
Nikolay Rozhkov
7b6764da20 Merge branch 'develop' into docs/2910_update-contributing-guidelines 2023-12-19 00:55:46 +03:00
Nikolay Rozhkov
f66f4f438f Use deep outline for the whole documentation website 2023-12-19 00:54:33 +03:00
Matheus Braga
ddd6e9ac73 Merge branch 'develop' into bug/5059_fix_external_connection_after_updating_edges 2023-12-18 17:12:44 -03:00
Abrifq
31578ae72d chore: update browsers list 2023-12-18 18:28:37 +00:00
Arda Aydın
5d70b8922d Update update-browserlist.yml 2023-12-18 21:27:19 +03:00
Arda Aydın
26956bf128 Update update-browserlist.yml to install pnpm
this feels like a disgusting fix, not gonna lie
2023-12-18 21:22:52 +03:00
Arda Aydın
11aa7a7052 Update update-browserlist.yml to fix deprecation and action fails 2023-12-18 20:59:02 +03:00
Justin Greywolf
2b4940d67d Merge branch '2408-support-style-for-class' of https://github.com/mermaid-js/mermaid into 2408-support-style-for-class 2023-12-18 06:27:30 -08:00
Justin Greywolf
c5220bd92d Fixed parser/tests 2023-12-18 06:27:10 -08:00
Nikolay Rozhkov
0506ba872a Fixed linters 2023-12-17 13:35:49 +03:00
Steph
4a6f8a62c5 Merge pull request #5147 from mermaid-js/update-latest-news
Docs: Update latest news
2023-12-14 12:12:41 -08:00
Steph
35224e5fe2 update latest news pages 2023-12-14 10:14:46 -08:00
jgreywolf
7ec5bdcca4 Update docs 2023-12-14 14:52:40 +00:00
Justin Greywolf
1babceb63c Update classDiagram.md 2023-12-14 06:48:13 -08:00
Justin Greywolf
237518ba3b Update classDiagram.md 2023-12-14 06:47:37 -08:00
William Jennings
7e6fd1ebe2 Update pie.html demo 2023-12-12 13:53:25 -08:00
Scott Blomquist
5e1f0c620a Fix typos in timeline syntax samples 2023-12-12 12:48:07 -08:00
Steph
d8e26dcb17 Merge pull request #5124 from mermaid-js/verbiage-updates
Docs: Ecosystem section pages - verbiage updates
2023-12-11 13:08:46 -08:00
Steph
aaea8cf45e fix addl broken link 2023-12-11 13:02:02 -08:00
Steph
97e07f8473 fix link 2023-12-11 12:31:22 -08:00
Alois Klink
3a816e7298 Merge branch 'chore/use-tsx-instead-of-ts-node-esm' into verbiage-updates 2023-12-11 16:55:24 +00:00
Alois Klink
41a9ac953a build: use tsx instead of ts-node-esm
`ts-node-esm` v10.9.1 is not compatible with Node.JS v18.19.0.

(cherry picked from commit 4a7e4a3bcb)
2023-12-11 16:55:06 +00:00
Justin Greywolf
a71bdbd2bb Merge branch 'develop' into 2408-support-style-for-class 2023-12-11 04:56:11 -08:00
jgreywolf
70b4a374cd Update docs 2023-12-11 12:48:49 +00:00
Justin Greywolf
668bf327d5 Update packages/mermaid/src/diagrams/class/classDb.ts
Co-authored-by: Alois Klink <alois@mermaidchart.com>
2023-12-11 04:45:48 -08:00
Justin Greywolf
3dce04e0a9 Update packages/mermaid/src/docs/syntax/classDiagram.md
Co-authored-by: Alois Klink <alois@mermaidchart.com>
2023-12-11 04:45:16 -08:00
Justin Greywolf
24957f44df Update packages/mermaid/src/diagrams/class/classDb.ts
Co-authored-by: Alois Klink <alois@mermaidchart.com>
2023-12-11 04:44:53 -08:00
Sidharth Vinod
6e64556326 Merge pull request #5130 from mermaid-js/update-generics-documentation
Update generics docs
2023-12-11 04:55:43 +00:00
Sidharth Vinod
b7fa22d80c Merge pull request #5131 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-12-11 04:54:48 +00:00
Nikolay Rozhkov
01908b1278 Development Into planning 2023-12-11 05:22:58 +03:00
Nikolay Rozhkov
57f0a3aa8e Contribution documentation improvements 2023-12-11 05:08:42 +03:00
renovate[bot]
f1a10d11c3 chore(deps): update all minor dependencies 2023-12-11 01:09:36 +00:00
Justin Greywolf
5a26edf6c0 Update generics docs 2023-12-10 17:01:36 -08:00
jgreywolf
b92b344844 Update docs 2023-12-10 21:28:26 +00:00
Justin Greywolf
b51ca4fb15 Address potential undefined 2023-12-10 13:25:16 -08:00
Justin Greywolf
3bb005b973 Merge branch 'develop' into 2408-support-style-for-class 2023-12-10 13:18:58 -08:00
Sidharth Vinod
9f061c5eba Merge pull request #5086 from mermaid-js/sidv/5042_maxEdges
feat #5042: Add `flowchart.maxEdges` config.
2023-12-10 16:39:57 +00:00
Matheus B
c8f0b39075 Add e2e test for edge case 2023-12-08 13:39:53 -03:00
Matheus Braga
7e1cc27c76 Merge branch 'mermaid-js:develop' into bug/5059_fix_external_connection_after_updating_edges 2023-12-08 13:15:09 -03:00
Matheus B
8bff32adab Modify algorithm to re-check for external connections after defining anchor nodes 2023-12-08 13:08:13 -03:00
Steph
f363af482e verbiage updates 2023-12-07 10:14:33 -08:00
Faris Nabiev
b60fc1b056 fix: replace functional approaches with oop 2023-12-07 11:32:49 +03:00
Sidharth Vinod
7c3bd9abd2 Merge branch 'develop' into release/10.6.2
* develop:
  Update docs
  Update NiceGuy.io links in integrations-community.md
  build(deps-dev): bump vite from 4.4.9 to 4.4.12
  Changes to .prettierignore 1. Added 'demos/dev/**' to be ignored by Prettier. 2. Added '!/demos/dev/example.html' so that Prettier ensures no one changes the example.html in a way that doesn't obey the Prettier code formatting rules.
  build: use `tsx` instead of `ts-node-esm`
  fix: #5100 Add viewbox to sankey
  fix: Check if parentCommit is provided
  Condition of Parent Id Without Merge Commit Added
  Error Hash Removed
  Linting Issue Fixed
  Updated gitgraph.md
  Linting Issue Fixed
  Documentation Modified New Ex Added
  e2e test case added
  Merge Conflict Resolved
  Suggested Changes FOR PR DONE
  documentation added, Tests Fixed
  All Unit Tests Passing
  Unit Test Cases Added
  Parser and Logic For Parent Commit Added
2023-12-07 11:02:52 +05:30
Sidharth Vinod
d3257cef80 Merge branch 'develop' into sidv/5042_maxEdges 2023-12-07 11:01:19 +05:30
Sidharth Vinod
69f31097e7 refactor: Move maxEdges out of flowchart config. 2023-12-07 10:55:12 +05:30
Sidharth Vinod
9b34adf2c9 refactor: Move maxEdges out of flowchart config. 2023-12-07 10:49:20 +05:30
Sidharth Vinod
3b7cabee4b chore: Add maxEdges to secure list 2023-12-07 10:39:10 +05:30
Sidharth Vinod
4f9988a799 Merge pull request #5120 from Abrifq/patch-3
Update NiceGuy.io links in integrations-community.md
2023-12-07 10:22:30 +05:30
Abrifq
f476c25c6d Update docs 2023-12-06 23:33:21 +00:00
Arda Aydın
1d08155fb1 Update NiceGuy.io links in integrations-community.md 2023-12-07 02:30:21 +03:00
Alois Klink
c7b38b824b Merge pull request #5116 from mermaid-js/sidv/bannerClick
feat: Track outbound links in docs site.
2023-12-06 08:29:30 +00:00
Sidharth Vinod
770fc412ca feat: Track outbound links in plausible
Unlike mermaid.live, there is no user provided links in mermaid.js.org.
So we can track the outbound link clicks without leaking any user data.
2023-12-06 11:47:15 +05:30
Sidharth Vinod
cc4af0cafa Merge pull request #5115 from mermaid-js/dependabot/npm_and_yarn/vite-4.4.12
build(deps-dev): bump vite from 4.4.9 to 4.4.12
2023-12-06 06:08:46 +00:00
futzmonitor
03b5c00f03 Merge branch 'develop' into issue1981 2023-12-05 21:56:08 -05:00
dependabot[bot]
faf282b45b build(deps-dev): bump vite from 4.4.9 to 4.4.12
Bumps [vite](https://github.com/vitejs/vite/tree/HEAD/packages/vite) from 4.4.9 to 4.4.12.
- [Release notes](https://github.com/vitejs/vite/releases)
- [Changelog](https://github.com/vitejs/vite/blob/v4.4.12/packages/vite/CHANGELOG.md)
- [Commits](https://github.com/vitejs/vite/commits/v4.4.12/packages/vite)

---
updated-dependencies:
- dependency-name: vite
  dependency-type: direct:development
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-12-05 23:52:12 +00:00
Justin Greywolf
02b2d71eb3 Update packages/mermaid/src/diagrams/class/classDb.ts
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-12-05 07:57:39 -08:00
Justin Greywolf
e25515a960 Merge branch 'develop' into 2408-support-style-for-class 2023-12-05 07:11:08 -08:00
Justin Greywolf
ca386ab597 Update docs 2023-12-05 07:10:45 -08:00
Nikolay Rozhkov
fe07e9da46 Merge pull request #5102 from mermaid-js/5100_SankeyViewbox
fix: #5100 Add viewbox to sankey
2023-12-05 10:14:55 +00:00
Sidharth Vinod
a9610d3ba0 Merge pull request #5109 from FutzMonitor/issue5108
Changes to .prettierignore
2023-12-05 04:05:23 +00:00
Steph
276b5c748a update getting started page 2023-12-04 13:47:20 -08:00
Justin Greywolf
1ecae7dc93 Merge branch 'develop' into 2408-support-style-for-class 2023-12-04 13:29:00 -08:00
Justin Greywolf
239fad94ee Grammar/rendering for setting style on class node 2023-12-04 13:28:31 -08:00
futzmonitor
11affc32ee Changes to .prettierignore
1. Added 'demos/dev/**' to be ignored by Prettier.
2. Added '!/demos/dev/example.html' so that Prettier ensures no one changes the example.html in a way that doesn't obey the Prettier code formatting rules.
2023-12-04 15:47:58 -05:00
futzmonitor
aa3a19b63c Merge branch 'develop' into issue1981 2023-12-04 15:25:09 -05:00
Alois Klink
542fc19862 Merge pull request #5107 from mermaid-js/add-blog
Docs: update Latest News section
2023-12-04 19:18:11 +00:00
Steph
78c44bf793 add blog post 2023-12-04 11:07:55 -08:00
Sidharth Vinod
5d56835c31 Merge pull request #5104 from aloisklink/chore/use-tsx-instead-of-ts-node-esm
build: use `tsx` instead of `ts-node-esm`
2023-12-04 14:48:43 +00:00
Alois Klink
4a7e4a3bcb build: use tsx instead of ts-node-esm
`ts-node-esm` v10.9.1 is not compatible with Node.JS v18.19.0.
2023-12-04 11:25:58 +00:00
Alois Klink
6a31ae6b4f Merge pull request #4944 from RounakJoshi09/bug/#4497_unable-to-cherrypick-merge-commit
Bug/#4497 Unable to Cherry Pick Merge Commit Solved
2023-12-04 09:15:03 +00:00
Sidharth Vinod
a24f96ed60 Merge branch 'develop' into release/10.6.2
* develop:
  chore: Downgrade node to 18.18.2
2023-12-04 12:47:22 +05:30
Sidharth Vinod
798f9f8b78 chore: Downgrade node to 18.18.2 2023-12-04 12:46:56 +05:30
Sidharth Vinod
80fa3e9597 update docs 2023-12-04 12:28:05 +05:30
Sidharth Vinod
60ea9a2972 v10.6.2-rc.2 2023-12-04 12:20:40 +05:30
Sidharth Vinod
1165fb163d Merge branch 'develop' into release/10.6.2
* develop: (47 commits)
  chore(deps): update all minor dependencies
  chore: Rename test
  test: Add unit test for generic classname and namespace
  Split type from generic class name
  Referenced the PmWiki's Cookbook recipe enabling MermaidJs schematics in wiki pages
  test(e2e): fix pie chart E2E tests for PR #4288
  Add dummy commit to trigger GH checks
  chore: Revert unnecessary export
  refactor: Remove unnecessary calculations
  chore: Fix computeWidth function
  chore: Cleanup setupGraphViewbox
  Update docs
  update mermaidAPI to cleanup the text before passing to getDiagramFromText
  Add test for subgraphs with title margins and edge labels
  Modify margin logic to avoid creating unnecessary space in subgraph
  review fixes
  add test
  remove unused variable
  fix: clean comments in text in getDiagramFromText API so flowchart works well
  chore(deps): update all minor dependencies
  ...
2023-12-04 12:20:17 +05:30
Sidharth Vinod
87a0ab3438 Merge pull request #5099 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-12-04 06:32:54 +00:00
Sidharth Vinod
160c7d399a fix: #5100 Add viewbox to sankey 2023-12-04 11:36:07 +05:30
renovate[bot]
e87243c135 chore(deps): update all minor dependencies 2023-12-04 06:04:52 +00:00
Sidharth Vinod
886405b65f Merge pull request #5098 from mermaid-js/4578-generic-class-in-namespace
Fix issue with generic class not rendering
2023-12-04 05:59:48 +00:00
Sidharth Vinod
761fa27eea chore: Rename test 2023-12-04 11:22:09 +05:30
Sidharth Vinod
93a920cdfe test: Add unit test for generic classname and namespace 2023-12-04 11:21:27 +05:30
Sidharth Vinod
d22ee8d1d5 fix: Check if parentCommit is provided 2023-12-04 11:13:52 +05:30
Sidharth Vinod
f806de3a1d Merge branch 'develop' into sidv/5042_maxEdges 2023-12-04 09:57:26 +05:30
Justin Greywolf
8de1bde8f4 Split type from generic class name 2023-12-03 18:01:00 -08:00
RounakJoshi09
31a1de1566 Condition of Parent Id Without Merge Commit Added 2023-12-04 00:28:01 +05:30
RounakJoshi09
c6bf9083c8 Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-12-04 00:19:28 +05:30
futzmonitor
8e95cdb883 Changes to gantt.jison
1. Consistent spacing on line 30
2023-12-02 12:56:58 -05:00
futzmonitor
68ff352f2d Changes to gantt.jison
1. Removed typo
2023-12-02 10:26:46 -05:00
futzmonitor
f02dfe60af Changes to gnatt.jison
1. Removed the hash and semicolon symbols from the title regex to allow for their use.
2. Removed the hash and semicolon symbols from the section regex to allow for their use.
3. Removed the hash and semicolon symbols for the taskTxt regex to allow for their use. I did not remove the colon because the parser fails to recognize when the actual taskData begins if that distinctions isn't kept.
4. Removed the regex \#[^\n]* which skipped comments to fix some bugs with hash symbols in the taskTxt. I tested this changed by putting it back and using the comment  to see if it was recognized as a comment, but I would receive a syntax error and the diagram would not be rendered. So, I think we can safely remove that line, BUT it would be best practice if someone else tested this change to ensure that this will not break anyone's Gantt diagrams.
2023-12-02 10:23:44 -05:00
Sidharth Vinod
9be9601927 chore: Update promo link 2023-12-01 12:04:30 +05:30
Sidharth Vinod
f81e4d4361 Merge pull request #5085 from d-faure/PmWiki-integration
Referenced the PmWiki's Cookbook recipe enabling MermaidJs schematics…
2023-11-29 03:57:11 +00:00
Sidharth Vinod
fdf9988af1 feat #5042: Add flowchart.maxEdges config. 2023-11-28 19:07:10 +05:30
d-faure
ae7003aa39 Merge remote-tracking branch 'origin/develop' into PmWiki-integration 2023-11-28 14:01:30 +01:00
d-faure
f35fb3955d Referenced the PmWiki's Cookbook recipe enabling MermaidJs schematics in wiki pages 2023-11-28 13:50:31 +01:00
Sidharth Vinod
4499926453 Merge pull request #5076 from ad1992/aakansha/bug/5075-fix-getDiagramFromText-api
fix: clean comments in text in getDiagramFromText API so flowchart works well
2023-11-28 12:02:57 +00:00
Sidharth Vinod
252a8a73b1 Merge pull request #5041 from mathbraga/feature/4935_subgraph-title-margin-config-option
Feature/4935 subgraph title margin config option
2023-11-28 12:02:03 +00:00
Sidharth Vinod
1564358421 Merge pull request #4288 from iwestlin/fix/pie-chart-viewbox
fix: Adjust piechart viewbox for mobile devices with small width
2023-11-28 12:01:28 +00:00
Alois Klink
72d2d04dcc Merge pull request #5006 from lchenay/patch-1
fix case that generate broken link on docs
2023-11-28 11:55:57 +00:00
Alois Klink
005c998438 test(e2e): fix pie chart E2E tests for PR #4288 2023-11-28 11:37:12 +00:00
Sidharth Vinod
e0bf7faf78 Merge pull request #5080 from mermaid-js/holiday-promo
Holiday 2023 promo
2023-11-28 13:43:03 +05:30
Sidharth Vinod
a1563c9f7d docs: Holiday promo v2 2023-11-28 13:39:46 +05:30
Aakansha Doshi
4ed7b2be02 Add dummy commit to trigger GH checks 2023-11-28 12:05:52 +05:30
Sidharth Vinod
af9566df75 Update packages/mermaid/src/docs/.vitepress/components/TopBar.vue 2023-11-28 11:42:04 +05:30
Sidharth Vinod
89b392327a chore: Revert unnecessary export 2023-11-28 11:34:58 +05:30
Sidharth Vinod
9c2dae92f8 refactor: Remove unnecessary calculations 2023-11-28 11:30:41 +05:30
Sidharth Vinod
403ac4b76b chore: Fix computeWidth function 2023-11-28 10:39:34 +05:30
Sidharth Vinod
0620c6daf2 chore: Cleanup setupGraphViewbox 2023-11-28 10:34:58 +05:30
Sidharth Vinod
1f4e335f8d Merge branch 'develop' into pr/iwestlin/4288
* develop: (596 commits)
  chore(deps): update all minor dependencies
  chore(deps): update all patch dependencies
  fix: flowchart image without text
  fix Types
  chore: Update pnpm-lock
  chore: Add tests for calculateDeltaAndAngle
  fix: #5064 Handle case when line has only one point
  reset the testTimeout to 5 seconds and change it directly in the test
  update testTimeout from 5 seconds to 10 seconds
  Update all patch dependencies
  fix broken link
  add latest blog post
  Update all minor dependencies
  Update all patch dependencies
  Fix docs
  Update packages/mermaid/src/docs/community/questions-and-suggestions.md
  Update packages/mermaid/src/diagrams/class/classRenderer-v2.ts
  update edge ids
  draw top actors with lines  first followed by messages
  Bump GitHub workflow actions to latest versions
  ...
2023-11-28 10:34:18 +05:30
ad1992
18bc2af570 Update docs 2023-11-28 03:38:09 +00:00
Aakansha Doshi
fe4485c55f update mermaidAPI to cleanup the text before passing to getDiagramFromText 2023-11-28 09:05:00 +05:30
Matheus Braga
5718be50ee Merge branch 'develop' into feature/4935_subgraph-title-margin-config-option 2023-11-27 22:17:32 -03:00
Matheus B
8e794e3af9 Merge branch 'feature/4935_subgraph-title-margin-config-option' of https://github.com/mathbraga/mermaid into feature/4935_subgraph-title-margin-config-option 2023-11-27 22:13:00 -03:00
Matheus B
7979b2830f Add test for subgraphs with title margins and edge labels 2023-11-27 22:12:41 -03:00
Matheus B
a807a58a29 Modify margin logic to avoid creating unnecessary space in subgraph 2023-11-27 22:10:05 -03:00
Steph
8d53fa17da update announcements page 2023-11-27 11:44:47 -08:00
Steph
c0b80df1cb update announcement bar verbiage 2023-11-27 11:36:56 -08:00
Aakansha Doshi
d3d4948b3a Merge branch 'develop' into aakansha/bug/5075-fix-getDiagramFromText-api 2023-11-27 19:51:33 +09:00
Aakansha Doshi
4dbfa2f0d3 review fixes 2023-11-27 16:11:25 +05:30
Alois Klink
25e9bb354e Merge pull request #4837 from mermaid-js/refactor/unifyEdgeMarkers
refactor: Unify the edgeMarker adding logic
2023-11-27 10:07:42 +00:00
Sidharth Vinod
7ca76b02e1 Merge pull request #5063 from bonyuta0204/bug/4736_zero_size_image_flowchart
fix: flowchart image without text
2023-11-27 08:28:48 +00:00
Aakansha Doshi
282da45d0e Merge branch 'develop' into aakansha/bug/5075-fix-getDiagramFromText-api 2023-11-27 17:04:39 +09:00
Aakansha Doshi
7e119381e8 add test 2023-11-27 13:33:01 +05:30
Aakansha Doshi
4a4d715270 remove unused variable 2023-11-27 13:25:13 +05:30
Aakansha Doshi
1d5378a4f2 fix: clean comments in text in getDiagramFromText API so flowchart works well 2023-11-27 13:19:31 +05:30
Sidharth Vinod
62b991b6f7 Merge pull request #5071 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-11-27 06:38:25 +00:00
renovate[bot]
952f2fb92c chore(deps): update all minor dependencies 2023-11-27 06:26:12 +00:00
Sidharth Vinod
84065838e0 Merge pull request #5070 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-11-27 06:20:12 +00:00
renovate[bot]
2cc4f23856 chore(deps): update all patch dependencies 2023-11-27 01:36:48 +00:00
Matheus B
ce875c9a33 Move getConfig() call out of recursiveRender to its parent caller 2023-11-26 18:18:31 -03:00
Matheus Braga
904be162a8 Merge branch 'develop' into feature/4935_subgraph-title-margin-config-option 2023-11-25 14:40:56 -03:00
Matheus B
3489fc49b9 Replace multiple calls of getConfig() for a single at top of the scope 2023-11-25 13:51:49 -03:00
Sidharth Vinod
65ee65b3ec Merge pull request #4915 from Patronud/develop
prevent-inherited-lineheights-on-edgeterminal-4083
2023-11-25 10:33:46 +05:30
Yuta Nakamura
1ff7218558 fix: flowchart image without text 2023-11-24 21:35:50 +09:00
Sidharth Vinod
5b705cf94f v10.6.2-rc.1 2023-11-24 14:11:49 +05:30
Sidharth Vinod
53b4f584db Merge branch 'develop' into docs/4974_reorder_integration_links 2023-11-24 11:33:41 +05:30
Sidharth Vinod
61747b67a3 Merge pull request #5065 from mermaid-js/5064_EdgeOffsetEdgeCase
fix: #5064 Handle case when line has only one point
2023-11-24 05:49:52 +00:00
Sidharth Vinod
b5ba09500f Merge branch 'develop' into refactor/unifyEdgeMarkers 2023-11-24 11:14:00 +05:30
Sidharth Vinod
7b0f6c1c74 fix Types 2023-11-24 10:44:18 +05:30
Sidharth Vinod
26df81816e chore: Update pnpm-lock 2023-11-24 10:41:26 +05:30
Ronid1
201016ccc5 update build docs 2023-11-23 20:57:43 -08:00
Sidharth Vinod
c0fcf4f3b1 Merge branch 'develop' into 5064_EdgeOffsetEdgeCase
* develop:
  fix broken link
  add latest blog post
  fix linting
  fix: set proper shiki theme for light and dark modes
  fix: change shiki theme to github-light
  add latest blog post
  add latest blog post
2023-11-24 10:26:32 +05:30
Sidharth Vinod
55ce05fc75 chore: Add tests for calculateDeltaAndAngle 2023-11-24 10:25:50 +05:30
Ronid1
aaf9fd5f03 update and verify links 2023-11-23 20:44:35 -08:00
Ronid1
783becebf6 alphabetically order sub categories 2023-11-23 20:38:44 -08:00
Ronid1
3e098ab73b sort links alphabetically 2023-11-23 20:38:44 -08:00
Sidharth Vinod
8f733c6b01 Merge branch 'master' into develop
* master:
  fix broken link
  add latest blog post
  fix linting
  fix: set proper shiki theme for light and dark modes
  fix: change shiki theme to github-light
  add latest blog post
  add latest blog post
2023-11-24 09:46:21 +05:30
Sidharth Vinod
78e118c876 fix: #5064 Handle case when line has only one point 2023-11-24 09:42:21 +05:30
Alois Klink
f604017f93 Merge pull request #5055 from omer-priel/bug/5053_tests-failed-because-test-timeout
update testTimeout from 5 seconds to 10 seconds
2023-11-23 16:30:55 +00:00
Omer Priel
9ae00ebcdb reset the testTimeout to 5 seconds and change it directly in the test 2023-11-23 14:55:09 +02:00
Omer Priel
fd208ddcaf update testTimeout from 5 seconds to 10 seconds 2023-11-21 13:53:05 +02:00
Matheus Braga
997a3771f1 Merge branch 'develop' into feature/4935_subgraph-title-margin-config-option 2023-11-20 21:28:09 -03:00
Matheus B
d79671e04a Resolve lint issue 2023-11-20 21:16:10 -03:00
Matheus B
a935380713 Merge branch 'feature/4935_subgraph-title-margin-config-option' of https://github.com/mathbraga/mermaid into feature/4935_subgraph-title-margin-config-option 2023-11-20 21:07:24 -03:00
Matheus B
d61bfde167 Replace string concat with string templates 2023-11-20 21:06:38 -03:00
Matheus B
fc3018e977 Move subgraph title margin tests to independent file 2023-11-20 20:55:43 -03:00
Matheus B
63c2d36232 Rename file and update imports 2023-11-20 20:49:00 -03:00
Matheus B
c0a43f5d5a Change getSubGraphTitleMargins to accept config object as parameter 2023-11-20 20:40:30 -03:00
Matheus B
ad6c76116d Modify getSubGraphTitleMargins to use null coalescing operator 2023-11-20 19:13:34 -03:00
Knut Sveidqvist
df858dc7b6 #3358 Adding arrows to syntax 2023-11-20 14:00:25 +01:00
Sidharth Vinod
4a4e614b64 Merge pull request #5046 from mermaid-js/renovate/patch-all-patch
Update all patch dependencies (patch)
2023-11-20 10:51:47 +00:00
renovate[bot]
3ba0fee406 Update all patch dependencies 2023-11-20 09:56:45 +00:00
Sidharth Vinod
36247bc5af Merge pull request #5047 from mermaid-js/renovate/all-minor
Update all minor dependencies (minor)
2023-11-20 09:50:18 +00:00
Knut Sveidqvist
0643c71523 Merge pull request #5048 from mermaid-js/update-blog
Docs: update Latest News section
2023-11-20 08:30:53 +01:00
Steph
cbc97dacdf fix broken link 2023-11-19 20:39:18 -08:00
Steph
8405454a1a add latest blog post 2023-11-19 20:32:20 -08:00
renovate[bot]
a1c0761ef9 Update all minor dependencies 2023-11-20 01:43:47 +00:00
Matheus Braga
42ac630304 Merge branch 'develop' into feature/4935_subgraph-title-margin-config-option 2023-11-17 21:41:27 -03:00
Matheus B
7e77433ef7 Add tests for subgraph title margin 2023-11-17 20:49:54 -03:00
Matheus B
453c16d08e Remove unnecessary code 2023-11-17 20:20:13 -03:00
RounakJoshi09
c19fa122af Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-11-17 11:28:20 +05:30
RounakJoshi09
aadf5339a4 Error Hash Removed 2023-11-17 09:51:03 +05:30
Sidharth Vinod
a47a9e400b Merge branch 'develop' into refactor/unifyEdgeMarkers 2023-11-16 11:00:33 +05:30
Nikolay Rozhkov
d7f59c1091 Merge pull request #4927 from guypursey/bug/4912_gitgraph-merge-routing-colouring
Bug/4912 GitGraph routing and colouring for merges and cherry-picks
2023-11-15 21:02:54 +00:00
Nikolay Rozhkov
3df7cf2266 Merge branch 'develop' into bug/4912_gitgraph-merge-routing-colouring 2023-11-15 23:44:08 +03:00
Sidharth Vinod
e8ee5f548f Merge pull request #4868 from mermaid-js/other/remove-pr-labeler-action
Use `release-drafter/release-drafter` GitHub Action to label our PRs
2023-11-15 08:00:51 +05:30
Sidharth Vinod
862d20ce9d Merge branch 'develop' into other/remove-pr-labeler-action
* develop: (164 commits)
  Update all patch dependencies
  Fix docs
  Update packages/mermaid/src/docs/community/questions-and-suggestions.md
  Update packages/mermaid/src/diagrams/class/classRenderer-v2.ts
  update edge ids
  draw top actors with lines  first followed by messages
  Bump GitHub workflow actions to latest versions
  Update docs
  Documentation: clarify sentence
  Fix lint
  Fix typo
  fix typo
  Add new Atlassian integrations
  chore(deps): update all patch dependencies
  Update demos/sequence.html
  chore: release v10.6.1
  fix
  fix
  fix: render the participants in same order as they are created
  fix(flow): fix invalid ellipseText regex
  ...
2023-11-15 07:58:48 +05:30
Nikolay Rozhkov
52603d7acd Merge branch 'develop' into bug/4912_gitgraph-merge-routing-colouring 2023-11-14 16:26:19 +03:00
Alois Klink
c56025ec3b Merge pull request #5013 from SteffenLm/bug/5009_static_class_attribute_not_rendered
Fix - static class attributes are not rendered underlined
2023-11-14 09:44:35 +00:00
Sidharth Vinod
0c0f7a739e Merge pull request #4934 from RounakJoshi09/bug/#3251_linkStyle-can't-specify-ids
bug/#3251_linkStyle-can't-specify-ids Fixed
2023-11-14 05:38:20 +00:00
Sidharth Vinod
33e94d3f35 Merge pull request #4961 from claesgill/upd_readme_toc
Updated README with expandable table of content.
2023-11-14 05:36:06 +00:00
Sidharth Vinod
5fdbf5d891 Merge pull request #5017 from ad1992/bug/4946-fix-svg-order-sequence-participant
fix: render the participants in same order as they are created
2023-11-14 05:29:35 +00:00
Sidharth Vinod
6d0d8ac8e6 Merge pull request #5033 from mermaid-js/renovate/patch-all-patch
Update all patch dependencies (patch)
2023-11-14 05:29:17 +00:00
Nikolay Rozhkov
fb031ee11a Merge branch 'develop' into bug/4912_gitgraph-merge-routing-colouring 2023-11-13 23:14:42 +03:00
renovate[bot]
adff22c1e2 Update all patch dependencies 2023-11-13 17:15:43 +00:00
Matheus B
56c3809b57 Add logic to add subgraph title margin on layout 2023-11-12 17:32:58 -03:00
Matheus B
8b0a5be6d9 Include subgraph margin into label positioning 2023-11-11 18:18:51 -03:00
Matheus B
52ed38719f Fix nesting of getSubGraphTitleMargins test. 2023-11-10 21:35:58 -03:00
Matheus B
0bcd5d28e8 Create helper function for subgraph title margin fetching. 2023-11-10 21:30:09 -03:00
Matheus B
b134766647 Add subgraph title margin config options to schema. 2023-11-10 21:22:31 -03:00
Sidharth Vinod
aa5d586bd6 Fix docs 2023-11-09 23:51:12 +05:30
Sidharth Vinod
b12b8a9278 Merge pull request #4952 from ajdamico/patch-1
add links to make it easier
2023-11-09 23:46:24 +05:30
Sidharth Vinod
3c13386e5d Update packages/mermaid/src/docs/community/questions-and-suggestions.md 2023-11-09 23:44:35 +05:30
Sidharth Vinod
a177141962 Merge pull request #5028 from mermaid-js/3952-lexical-ids
3952 lexical ids
2023-11-09 18:04:38 +00:00
Sidharth Vinod
92f1644550 Merge pull request #5025 from deining/clarify-docu
Documentation: clarify sentence
2023-11-09 23:35:06 +05:30
Justin Greywolf
07dcb64b22 Merge branch 'develop' into 3952-lexical-ids 2023-11-09 08:05:25 -08:00
Justin Greywolf
0f2b941e2d Update packages/mermaid/src/diagrams/class/classRenderer-v2.ts
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-11-09 08:05:09 -08:00
Sidharth Vinod
c89557d85c Merge pull request #5026 from deining/bump-gitHub-workflows
Bump GitHub workflow actions to latest versions
2023-11-09 15:36:54 +00:00
Justin Greywolf
e8ad72a980 Merge branch 'develop' into 3952-lexical-ids 2023-11-09 07:03:40 -08:00
Justin Greywolf
a8fe640546 update edge ids 2023-11-09 06:57:51 -08:00
Aakansha Doshi
01bbcc597a draw top actors with lines first followed by messages 2023-11-09 17:52:00 +05:30
Andreas Deininger
6fb5641afc Bump GitHub workflow actions to latest versions 2023-11-09 12:56:57 +01:00
deining
fe32bcbf7c Update docs 2023-11-09 11:55:19 +00:00
Andreas Deininger
f47e920a97 Documentation: clarify sentence 2023-11-09 12:50:01 +01:00
Sidharth Vinod
1571b25d29 Merge pull request #4958 from csholmq/fix/tooltip
fix(tooltip): remove redundant scroll offset
2023-11-09 09:01:19 +00:00
Sidharth Vinod
4a92fc5c92 Fix lint 2023-11-09 14:20:06 +05:30
Sidharth Vinod
8d6317b49a Merge branch 'develop' into pr/csholmq/4958
* develop: (21 commits)
  Fix typo
  fix typo
  Add new Atlassian integrations
  chore(deps): update all patch dependencies
  chore: release v10.6.1
  fix(flow): fix invalid ellipseText regex
  review fixes
  Update XYChart's nav link in the docs template
  Update index.md
  add comment for ts ignore
  move decodeEntities to utils
  review fixes
  chore(deps): update all minor dependencies
  chore: Point to correct changelog
  add spec
  fix: getMessageAPI so it considers entity codes
  Update classDiagram.md
  Chore: Typo fixed in multiple files
  feat(gantt): update styles
  docs(integrations): add Mermaid for Slack
  ...
2023-11-09 14:19:28 +05:30
Sidharth Vinod
ee49c4b660 Merge pull request #4933 from REVERB283/bug/4716_fix_target_blank_getting_sanitized
fix: target blank removed from anchor tag
2023-11-09 08:46:33 +00:00
Sidharth Vinod
72038a68a9 Fix typo 2023-11-09 14:06:58 +05:30
Sidharth Vinod
051260e9a8 Merge branch 'develop' of https://github.com/mermaid-js/mermaid into develop
* 'develop' of https://github.com/mermaid-js/mermaid:
  docs: fixed typo
2023-11-09 14:04:33 +05:30
Sidharth Vinod
3cf0a2b290 Merge pull request #4893 from 0xflotus/patch-1
docs: fixed typo
2023-11-09 14:04:17 +05:30
Sidharth Vinod
adfb60e045 fix typo 2023-11-09 14:03:38 +05:30
Sidharth Vinod
ac595eb96c Merge pull request #4947 from SusheelThapa/patch
Chore: Typo fixed in multiple files
2023-11-09 14:03:05 +05:30
Sidharth Vinod
79bae62ce0 Merge pull request #4973 from SahilNagpure07/patch-1
docs: Update classDiagram.md
2023-11-09 13:57:36 +05:30
Sidharth Vinod
3038ce5864 Merge pull request #5021 from nashtechlabs/docs/patch-1
Add new Atlassian integrations
2023-11-09 13:56:19 +05:30
Sidharth Vinod
c8a826dfce Merge pull request #5012 from StefonSimmons/patch-1
Update index.md
2023-11-09 13:51:27 +05:30
Sidharth Vinod
4286372a9c Merge pull request #4924 from raiman264/bug/4905_fix_code_block_unreadable_text
bug: #4905 change shiki theme to github-light
2023-11-09 13:50:45 +05:30
Sidharth Vinod
0075538431 fix linting 2023-11-09 13:49:42 +05:30
Braulio Ruiz
8db9700807 fix: set proper shiki theme for light and dark modes 2023-11-09 13:36:44 +05:30
Braulio Ruiz
1fa8de2771 fix: change shiki theme to github-light 2023-11-09 13:36:44 +05:30
Sidharth Vinod
09d9c31d53 chore: Reset mock in edgeMarker test 2023-11-09 11:36:45 +05:30
nashtechlabs
fadae38bec Merge branch 'develop' into docs/patch-1 2023-11-09 05:34:57 +07:00
Sidharth Vinod
e46626d3ed Merge branch 'develop' into refactor/unifyEdgeMarkers
* develop: (155 commits)
  chore(deps): update all patch dependencies
  chore: release v10.6.1
  fix(flow): fix invalid ellipseText regex
  review fixes
  Update XYChart's nav link in the docs template
  add comment for ts ignore
  move decodeEntities to utils
  review fixes
  chore(deps): update all minor dependencies
  chore: Point to correct changelog
  add spec
  fix: getMessageAPI so it considers entity codes
  chore(deps): update all patch dependencies
  Update integrations-community.md
  docs: upate the list of tools with native support of mermaid
  Fix typo in build-docs.yml
  Updated mermaid version
  Limiting the number of edges that are allowed in the flowchart
  Update README.md
  Update README.md
  ...
2023-11-09 02:39:54 +05:30
Sidharth Vinod
8f572021af chore: Add test for invalid marker 2023-11-09 02:38:48 +05:30
Sidharth Vinod
4952b13ad0 fix: Ignore unknown arrow type values
Co-authored-by: Alois Klink <alois@aloisklink.com>
2023-11-09 02:37:38 +05:30
Sidharth Vinod
d1fba9c567 Merge pull request #4824 from JackuB/patch-1
Docs: add Mermaid for Slack integration
2023-11-08 20:58:40 +00:00
Sidharth Vinod
c2e26baf4d Merge pull request #4930 from Mister-Hope/patch-2
feat(gantt): update styles
2023-11-08 20:42:53 +00:00
nashtechlabs
f6b1e049f1 Merge branch 'develop' into docs/patch-1 2023-11-08 15:56:22 +07:00
Alois Klink
f487dcd57b Merge commit 'b61ea4b8aa2f5d38ad6af828ed0620a589ec5786'
This fixes the link to xyChart in the docs on the `master` branch.
2023-11-08 08:42:05 +00:00
Alois Klink
71478f5a64 Merge pull request #5014 from Abrifq/patch-2
Update XYChart's nav link in the docs template
2023-11-08 08:22:30 +00:00
dev1
c9ace33cf1 Add new Atlassian integrations 2023-11-08 14:39:06 +07:00
Alois Klink
4ecf7806cd Merge pull request #4959 from mermaid-js/update-latest-news
Docs: update latest news
2023-11-07 16:10:07 +00:00
Steph
c117447bb3 add latest blog post 2023-11-07 00:54:32 -08:00
Steph
1f7aec7405 Merge branch 'master' into update-latest-news 2023-11-07 00:50:51 -08:00
Sidharth Vinod
30646d80f1 Merge pull request #5015 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-11-07 07:23:10 +00:00
renovate[bot]
6e74e91b5d chore(deps): update all patch dependencies 2023-11-07 05:11:34 +00:00
Sidharth Vinod
eb4bd314b6 Merge pull request #5002 from ad1992/bug/4983-fix-getMessageAPI
fix: getMessageAPI so it considers entity codes
2023-11-07 05:04:53 +00:00
Alois Klink
7a3ce3e337 Merge pull request #5018 from mermaid-js/master
Sync `master` branch to `develop`
2023-11-06 14:48:55 +00:00
Alois Klink
d1045ed644 Merge remote-tracking branch 'origin/release/10.6.1' 2023-11-06 14:29:58 +00:00
Aakansha Doshi
396ea3cec2 Update demos/sequence.html 2023-11-06 19:55:53 +05:30
Aakansha Doshi
51d076a83b Merge branch 'develop' into bug/4946-fix-svg-order-sequence-participant 2023-11-06 19:54:32 +05:30
Alois Klink
65daab2aaf chore: release v10.6.1
Fixes
=====

- Flowchart: Fix a freeze when using a `(` character in an ellipse node
2023-11-06 13:57:01 +00:00
Aakansha Doshi
dff8b783b8 fix 2023-11-06 19:02:10 +05:30
Aakansha Doshi
78c1a3d980 fix 2023-11-06 18:57:47 +05:30
Aakansha Doshi
23cbf50413 fix: render the participants in same order as they are created 2023-11-06 18:47:38 +05:30
Knut Sveidqvist
7c7f3dd8be Merge pull request #5016 from aloisklink/fix/4964-fix-invalid-ellipseText-regex
fix(flow): fix invalid ellipseText regex
2023-11-06 11:16:44 +00:00
Alois Klink
172d90e731 fix(flow): fix invalid ellipseText regex
This invalid regex was causing Mermaid to freeze.
2023-11-06 10:08:12 +00:00
Aakansha Doshi
dff13439f6 review fixes 2023-11-06 12:17:43 +05:30
Arda Aydın
b61ea4b8aa Update XYChart's nav link in the docs template
The site gives 404 with xychart but navigates correctly with xyChart
2023-11-05 22:35:36 +03:00
SteffenLm
b5fd8fb7c1 fix text-decoration for abstract attibutes 2023-11-03 20:55:42 +01:00
StefonSimmons
4ba3e2cff3 Update index.md
fix typo
2023-11-03 15:51:33 -04:00
Aakansha Doshi
a818f3e3ae add comment for ts ignore 2023-11-03 13:31:21 +05:30
Aakansha Doshi
58bad981be move decodeEntities to utils 2023-11-03 13:25:26 +05:30
Aakansha Doshi
6a5b7c40bd Merge branch 'develop' into bug/4983-fix-getMessageAPI 2023-11-03 13:18:38 +05:30
Aakansha Doshi
6e6e92a1d1 review fixes 2023-11-03 13:16:30 +05:30
Steph
99244ffae5 Merge branch 'master' into update-latest-news 2023-11-02 05:05:04 -07:00
Laurent
379722d0fb Fix case that generate broken link on docs 2023-11-02 12:51:52 +01:00
Sidharth Vinod
f5bd1e0809 Merge pull request #4997 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-11-02 11:05:01 +00:00
renovate[bot]
0d4faef758 chore(deps): update all minor dependencies 2023-11-01 19:42:28 +00:00
Sidharth Vinod
0c5cf72235 chore: Point to correct changelog 2023-11-01 20:18:49 +05:30
Guy Pursey
57a9d7356c GitGraph: made reroute fn more readable
Pre-commit lint hook had made the use of ternaries harder to read
than I'd originally intended so I introduced an additional
variable which explains what is being checked and keeps ternaries
from becoming obscured.
2023-10-31 17:24:13 +00:00
Guy Pursey
a9c5d903c5 GitGraph: simplified branch check in arrow rerouting fn
Wanted to avoid repetition given that the originally nested
ternaries had the same structure
2023-10-31 17:24:13 +00:00
Guy Pursey
d80e1a2662 GitGraph: added commit IDs to e2e test to remove false positives
Should stop randomised commit IDs from showing arbitrary
differences between test runs.
2023-10-31 17:24:13 +00:00
Guy Pursey
bf52e76a39 GitGraph: Moved branch curve check to within reroute check fn
Based on review by @nirname. I had originally been trying
to minimise number of new arguments being passed to
rerouting check but as the branch curve check is not used
elsewhere and is part of the same rerouting check it makes
sense for them to be together.

Position information now passed to rerouting fn instead.
2023-10-31 17:24:13 +00:00
Guy Pursey
31a8e040fa GitGraph: corrected minor typo in comment. 2023-10-31 17:24:13 +00:00
Guy Pursey
f7d83e2cda GitGraph: added 2x e2e tests for branches not used immediately
My focus earlier on had been on relationship to `main` branch
so this is to ensure that we have some tests that cover
relationship between a pair of branches that doesn't
include `main`.
2023-10-31 17:24:13 +00:00
Guy Pursey
0555368e1c GitGraph: added branch checking to rerouting
Hypothesised that working out which branch needed checking for
overlapping commits might be missing, so added that as a
nested ternary and passed result as new argument to rerouting
check.

If commits are found on the branch which will be getting the
curve (whichever branch is lower or more to the right of main
than the other, for now), then the arrow will be rerouted.

I may refactor in a follow-up commit and I think there's scope
to simplify the logic but this is a test for now.
2023-10-31 17:24:13 +00:00
Guy Pursey
adfe1728ae GitGraph: Added e2e tests for deferred branch use.
In these tests, a new branch is created but then a commit is made
on the main branch before the new branch gets a commit. This
important to see what happens with rerouting of arrows.

Suggested by @nirname in PR review of #4927.
2023-10-31 17:24:13 +00:00
Guy Pursey
2acad550da GitGraph: e2e tests, added commit IDs to test graphs
Followed practice of other tests so that commit IDs are
stabilised (i.e., not randomly generated) and therefore
don't show repeatedly in Cypress diff output screenshots
2023-10-31 17:24:13 +00:00
Guy Pursey
b0b276898a GitGraph: fixed an e2e branch for vertical branch
Fix for error spotted by @mathbraga
2023-10-31 17:24:13 +00:00
Guy Pursey
25a678caec GitGraph: added e2e tests for multiple branches from one commit 2023-10-31 17:24:13 +00:00
Guy Pursey
3e18e76d31 GitGraph: removed check of branch with main from arrow reroute fn
Checking if branch was same as main turned out to be redundant
for now, since there don't seem to be any cases where routing
curves into main.

This fixes issue found in review by @nirname and avoids a
situation where branching from the same commit results in
unnecessary rerouting.
2023-10-31 17:24:13 +00:00
Guy Pursey
3ba33c8b75 GitGraph: added more to demos 2023-10-31 17:24:13 +00:00
Guy Pursey
7c87df7cf6 GitGraph: rename overlap check to shouldRerouteArrow
The function also now does an additional check to see
if source branch in overlap check is on main.

As we're no longer purely checking for an overlap and
the only use of this function is to reroute the arrows
to avoid running over commits, this more literal name
should be clearer.
2023-10-31 17:24:13 +00:00
Guy Pursey
dba7197fc6 GitGraph: simplified overlapping check fn 2023-10-31 17:24:13 +00:00
Guy Pursey
902a9dd42b GitGraph: added and updated demos to align with some of e2e testing 2023-10-31 17:24:13 +00:00
Guy Pursey
461a293d71 GitGraph: refactored overlapping fn for efficiency/performance
On previous rewrite, I had created new functions within the
overlapping functions but these were being recreated on each
iteration of Object.some(). I moved them outside this for
clarity and so they're not recreated each iteration.
2023-10-31 17:24:13 +00:00
Guy Pursey
9f8457d249 GitGraph: Rewrote overlap fn to make main branch exception to rule. 2023-10-31 17:24:13 +00:00
Guy Pursey
8c43d2273f GitGraph: added destination branch check into overlapping fn. 2023-10-31 17:24:13 +00:00
Guy Pursey
69ec4a0359 GitGraph: Added cherry-pick and merge demos for to GitGraph. 2023-10-31 17:24:13 +00:00
Guy Pursey
9469f759a9 GitGraph: Moved overlapping commit arrow colour inside conditional 2023-10-31 17:24:13 +00:00
Guy Pursey
60bb7b5b6c GitGraph: updated demo page to include top-to-bottom examples. 2023-10-31 17:24:13 +00:00
Guy Pursey
4787bb07df GitGraph: corrected object method in hasOverlappingCommits 2023-10-31 17:24:13 +00:00
Guy Pursey
33050e1812 GitGraph: Update variable names in drawArrow fn 2023-10-31 17:24:13 +00:00
Guy Pursey
6dc8e58b47 GitGraph: Refactor hasOverlappingCommits function
Changed argument names from commit1 and commit2 to
commitA and commitB respectively to prevent confusion
with seq number values.

Replaced Array filter method with array some method
so that as soon as one overlap is found, function is
finished.

Used Object.entries instead of Object.keys to reduce
number of variables needed and make function easier
to read.
2023-10-31 17:24:13 +00:00
Guy Pursey
839645f161 GitGraph: Add more example diagrams to test with. 2023-10-31 17:24:13 +00:00
Guy Pursey
d9daf19055 GitGraph: Correct commit variable in overlap check.
Originally, the function was checking if any commits were on the
same branch as `commit2`, the destination commit.

However, in order to avoid a conflict, we should only need to
check whether any commits are on the same branch as `commit 1`.

Updated and moved commenting as well.
2023-10-31 17:24:13 +00:00
Guy Pursey
f42cec282a GitGraph: Add check for direction of merge arrow to determine colour. 2023-10-31 17:24:13 +00:00
Aakansha Doshi
fff25e7e2c add spec 2023-10-31 19:39:43 +05:30
Aakansha Doshi
2a8323f951 Merge branch 'develop' into bug/4983-fix-getMessageAPI 2023-10-31 18:35:25 +05:30
Aakansha Doshi
390e22cc0b fix: getMessageAPI so it considers entity codes 2023-10-31 18:28:45 +05:30
Sebastian Holmqvist
a3ee21d7fc fix(tooltip): change position of tooltip to not cover node
Position the tooltip centered, just below the node being hovered.

Update packages/mermaid/src/diagrams/flowchart/flowDb.js

Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-10-31 12:51:47 +01:00
Sebastian Holmqvist
8f2a5064cb fix(tooltip): remove redundant scroll offset
window.scrollY is already account for which means document.body.scrollTop incorrectly offsets the tooltip vertically.
The same is not true for horizontal position.
2023-10-31 08:38:19 +01:00
Sidharth Vinod
77667b94d3 Merge pull request #4975 from mermaid-js/add-docusaurus
Docs: add Docusaurus to "Integrations - Community" page
2023-10-31 06:42:09 +00:00
Sidharth Vinod
b85a48f7f7 Merge pull request #4976 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-10-31 06:40:19 +00:00
Sidharth Vinod
34f1db399f Merge pull request #4979 from karthxk07/develop
Update README.md
2023-10-31 06:40:05 +00:00
renovate[bot]
e8a04faa36 chore(deps): update all patch dependencies 2023-10-31 06:13:41 +00:00
Sidharth Vinod
d714ecb4d7 Merge pull request #4994 from alex-titarenko/docs/add-noteshub-tool
docs: Add NotesHub to integrations-community page
2023-10-31 06:06:59 +00:00
Sidharth Vinod
54ca3e789f Merge pull request #4991 from sadikkuzu/patch-1
Fix typo in build-docs.yml
2023-10-31 06:03:26 +00:00
Faris
61fb9e50d3 Merge branch 'develop' into fix/1294_exhaustive-clear-sequenceDb-variables 2023-10-30 13:39:09 +03:00
Alex Titarenko
cb06962c85 Update integrations-community.md 2023-10-27 20:27:16 -07:00
Alex Titarenko
e98aa55577 docs: upate the list of tools with native support of mermaid 2023-10-27 18:58:30 -07:00
SADIK KUZU
672a0edc59 Fix typo in build-docs.yml 2023-10-27 12:22:14 +03:00
Knut Sveidqvist
03c59adaed Parsing of block arrows with directions, creating a dedicated new node for this. 2023-10-26 22:02:16 +02:00
Knut Sveidqvist
7198fe55a9 Parsing of block arrows with directions, creating a dedicated new node for this. 2023-10-26 22:01:44 +02:00
Harshit Anand | Frontend Developer | ReactJS
3394541b41 Merge branch 'develop' into bug/4716_fix_target_blank_getting_sanitized 2023-10-26 14:57:15 +05:30
Harshit Anand
54ab3fc3b2 fix: added an e2e test case for classdiagram with anchor tag 2023-10-26 14:55:04 +05:30
Sahil Nagpure
36a727d44e Merge branch 'develop' into patch-1 2023-10-26 11:44:46 +05:30
Harshit Anand
06d2ba8398 fix: added two unit tests to check for the secured anchor tag 2023-10-25 21:17:53 +05:30
Knut Sveidqvist
5f117fc2b2 Merge branch 'master' into develop 2023-10-25 13:36:10 +02:00
Knut Sveidqvist
d7ec9e7b0d Merge branch 'release/10.6.0' 2023-10-25 13:35:58 +02:00
Knut Sveidqvist
29942c04dc Updated mermaid version 2023-10-25 11:07:12 +02:00
Knut Sveidqvist
fc28c1da63 Limiting the number of edges that are allowed in the flowchart 2023-10-25 11:06:37 +02:00
Karthik
ff4d68fd55 Update README.md 2023-10-25 14:11:38 +05:30
Sahil Nagpure
9637b0c187 Merge branch 'develop' into patch-1 2023-10-25 12:24:03 +05:30
RounakJoshi09
5834818ebe Linting Issue Fixed 2023-10-23 21:57:38 +05:30
RounakJoshi09
7f1e0ab422 Updated gitgraph.md 2023-10-23 21:14:38 +05:30
RounakJoshi09
b461efab5d Merge branch 'bug/#4497_unable-to-cherrypick-merge-commit' of https://github.com/RounakJoshi09/mermaid into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-23 21:09:43 +05:30
RounakJoshi09
ca96c0f45f Linting Issue Fixed 2023-10-23 21:06:51 +05:30
RounakJoshi09
122e5929bc Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-23 20:40:02 +05:30
RounakJoshi09
b0cfdcc22f Documentation Modified New Ex Added 2023-10-23 20:34:54 +05:30
Harshit Anand
7960f94eba fix: shifted dompurify.addhook functions inside removescript 2023-10-23 16:09:51 +05:30
Harshit Anand
3f486ac0e1 Merge branch 'bug/4716_fix_target_blank_getting_sanitized' of https://github.com/REVERB283/mermaid into bug/4716_fix_target_blank_getting_sanitized 2023-10-23 12:25:53 +05:30
Harshit Anand
b36cdaceca Merge branch 'develop' of https://github.com/mermaid-js/mermaid into bug/4716_fix_target_blank_getting_sanitized 2023-10-23 12:24:22 +05:30
Harshit Anand
3b8c48dd26 fix: added type Element to the node used in callback in the dompurify.addhook 2023-10-23 12:23:08 +05:30
Harshit Anand
af73818c90 Merge branch 'bug/4716_fix_target_blank_getting_sanitized' of https://github.com/REVERB283/mermaid into bug/4716_fix_target_blank_getting_sanitized 2023-10-23 12:08:09 +05:30
Harshit Anand | Frontend Developer | ReactJS
77e700832f Merge branch 'develop' into bug/4716_fix_target_blank_getting_sanitized 2023-10-23 12:04:53 +05:30
Harshit Anand
111e067df5 fix: added type Element to the node used in callback in the addhook function 2023-10-23 12:03:57 +05:30
Karthik
880d0ebb50 Update README.md 2023-10-23 11:38:52 +05:30
huynhicode
b268bd21e1 Update docs 2023-10-22 21:23:47 +00:00
steph
bc247b1d46 add docusaurus to community integrations 2023-10-22 14:18:41 -07:00
Alois Klink
3957575b6e Merge pull request #4970 from remcohaszing/rename-rehype-mermaid
Replace rehype-mermaidjs with rehype-mermaid
2023-10-22 20:05:10 +00:00
Alois Klink
9daed6ba27 Merge pull request #4951 from mermaid-js/dependabot/npm_and_yarn/babel/traverse-7.23.2
Bump @babel/traverse from 7.22.10 to 7.23.2
2023-10-22 20:00:19 +00:00
RounakJoshi09
58e9e5658b e2e test case added 2023-10-22 21:12:04 +05:30
RounakJoshi09
f92ad6307e Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-22 19:34:05 +05:30
Sahil Nagpure
f31cddee0c Update classDiagram.md
Fixed typo.
2023-10-22 12:27:55 +05:30
Nikolay Rozhkov
b232975064 Merge branch 'develop' into bug/4716_fix_target_blank_getting_sanitized 2023-10-21 01:46:21 +03:00
Remco Haszing
ab9b9abdf9 Replace rehype-mermaidjs with rehype-mermaid
The package was renamed.
2023-10-20 16:55:01 +02:00
Knut Sveidqvist
d32c18a43c Merge branch 'master' into develop 2023-10-20 14:33:07 +02:00
Knut Sveidqvist
35b364c4ea Merge branch 'release/10.5.1' 2023-10-20 14:32:32 +02:00
Knut Sveidqvist
f3f25c7874 #3358 Adding support for space blocks and different shapes 2023-10-20 12:30:25 +02:00
Knut Sveidqvist
5619f8771b #3358 Adding support for space blocks and different shapes 2023-10-20 12:13:49 +02:00
Claes Gill
3389ecdfea Updated README with expandable table of content. 2023-10-19 22:48:49 +02:00
Steph
87675e687e add latest blog post 2023-10-19 11:36:46 -07:00
RounakJoshi09
827808dca3 Merge Conflict Resolved 2023-10-19 10:33:32 +05:30
RounakJoshi09
d65191f6c1 Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-19 10:26:25 +05:30
RounakJoshi09
6eee8973ba Merge branch 'bug/#4497_unable-to-cherrypick-merge-commit' of https://github.com/RounakJoshi09/mermaid into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-18 21:08:14 +05:30
RounakJoshi09
d8500f9e08 Suggested Changes FOR PR DONE 2023-10-18 20:59:55 +05:30
Susheel Thapa
99a79e15f3 Merge branch 'develop' into patch 2023-10-17 20:47:29 +05:45
Anthony Damico
31ec3d1496 Update questions-and-suggestions.md 2023-10-17 10:30:29 -04:00
dependabot[bot]
0e328823b9 Bump @babel/traverse from 7.22.10 to 7.23.2
Bumps [@babel/traverse](https://github.com/babel/babel/tree/HEAD/packages/babel-traverse) from 7.22.10 to 7.23.2.
- [Release notes](https://github.com/babel/babel/releases)
- [Changelog](https://github.com/babel/babel/blob/main/CHANGELOG.md)
- [Commits](https://github.com/babel/babel/commits/v7.23.2/packages/babel-traverse)

---
updated-dependencies:
- dependency-name: "@babel/traverse"
  dependency-type: indirect
...

Signed-off-by: dependabot[bot] <support@github.com>
2023-10-17 11:08:38 +00:00
Sidharth Vinod
33a5fc459d Merge pull request #4945 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-10-17 10:56:23 +00:00
renovate[bot]
e4350f80fe chore(deps): update all patch dependencies 2023-10-16 19:52:01 +00:00
Faris Nabiev
3b5f5c7843 chore: fix autogen docs 2023-10-16 19:47:58 +03:00
Faris
3128ba73a0 chore(sequence): Update packages/mermaid/src/docs/syntax/sequenceDiagram.md
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-10-16 19:36:44 +03:00
Sidharth Vinod
7eac75c15c Merge pull request #4928 from mribeirodantas/fix-minor-typos
fix(typos): Fix minor typos in the source code
2023-10-16 14:00:27 +00:00
Susheel Thapa
d97e31a38c Chore: Typo fixed in multiple files 2023-10-16 16:54:36 +05:45
Alois Klink
d04f4c27fc Merge pull request #4889 from dreathed/bug/4345_bundle_current_config_consitently_in_one_file
making consitent config imports from diagramAPI
2023-10-15 22:54:10 +00:00
Knut Sveidqvist
74a9e86e74 #3358 Putting the elements back in 2023-10-15 22:55:29 +02:00
Knut Sveidqvist
a641fd51e8 #3358 Adding support for column statements 2023-10-15 22:21:25 +02:00
RounakJoshi09
0a0bd0ac97 Merge branch 'develop' into bug/#4497_unable-to-cherrypick-merge-commit 2023-10-14 07:58:09 +05:30
RounakJoshi09
4051b42b5a documentation added, Tests Fixed 2023-10-14 07:26:23 +05:30
RounakJoshi09
6e5cd2b3c2 All Unit Tests Passing 2023-10-14 05:49:51 +05:30
Harshit Anand | Frontend Developer
f12b19216b Merge branch 'develop' into bug/4716_fix_target_blank_getting_sanitized 2023-10-14 00:51:42 +05:30
Harshit Anand
345e82abee fix: removed static target=_blank instaed value will fetched from the target attribute 2023-10-14 00:50:09 +05:30
RounakJoshi09
3118c7c532 Unit Test Cases Added 2023-10-13 23:49:01 +05:30
Faris Nabiev
fc0ade2985 chore(sequence): update doc for actors/participant creation/deletion fix 2023-10-13 12:07:36 +03:00
Faris Nabiev
6eae46b927 chore: remove unused e2e tests file 2023-10-13 00:48:05 +03:00
Faris Nabiev
985eda2dee chore: add e2e test that shows db cleanup problem 2023-10-13 00:43:48 +03:00
Faris Nabiev
45552451fe Merge branch 'fix/1294_add-e2e-test' into fix/1294_exhaustive-clear-sequenceDb-variables 2023-10-13 00:03:28 +03:00
Faris Nabiev
18ea27ac58 chore: add e2e test that shows db cleanup problem 2023-10-13 00:02:46 +03:00
Faris Nabiev
b4f444869e fix: add imperativeState and replace sequenceDb global variables with it 2023-10-12 16:39:31 +03:00
Marcel Ribeiro-Dantas
9080f1f354 Revert typo fix 2023-10-12 01:33:25 -03:00
Marcel Ribeiro-Dantas
4b8441a1a0 Prettify table 2023-10-12 01:27:08 -03:00
RounakJoshi09
13d85b6ee5 Parser and Logic For Parent Commit Added 2023-10-12 02:35:43 +05:30
Marcel Ribeiro-Dantas
00b38c55e9 Merge branch 'develop' into fix-minor-typos 2023-10-11 16:43:47 -03:00
Marcel Ribeiro-Dantas
ab2345093e Revert error typo fix 2023-10-11 16:41:04 -03:00
RounakJoshi09
995449cbf6 Error Message Changed 2023-10-11 20:40:14 +05:30
Sidharth Vinod
df068dbde8 Merge pull request #4892 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-10-11 13:51:04 +00:00
renovate[bot]
7d3c550337 chore(deps): update all minor dependencies 2023-10-11 06:30:11 +00:00
Sidharth Vinod
3e9235a35b Merge pull request #4925 from chaursiyasanjeet/enhancmenttwitter-logo-in-doc
Enhancment: twitter logo in doc
2023-10-11 06:21:40 +00:00
Sidharth Vinod
380aa94214 Merge pull request #4929 from Mister-Hope/patch-1
fix(class): avoid duplicate definition of fill
2023-10-11 06:20:44 +00:00
RounakJoshi09
ce3d9fcdde Added test suggested on PR 2023-10-10 11:09:30 +05:30
Harshit Anand
c279a9f9ed fix: clean link unit test resolved 2023-10-10 01:05:55 +05:30
RounakJoshi09
cdb4639aa4 bug/#3251_linkStyle-can't-specify-ids Fixed 2023-10-10 00:16:05 +05:30
Harshit Anand
2a9eb7f123 fix: target blank removed from anchor tag 2023-10-09 21:13:53 +05:30
Mr.Hope
1fec55d5f7 feat(gantt): update styles 2023-10-09 11:25:09 +08:00
Mr.Hope
444e81ae8a fix(class): avoid duplicate definition of fill 2023-10-09 11:08:46 +08:00
Jakub Mikulas
4559ba625c docs(integrations): add Mermaid for Slack 2023-10-08 21:16:36 +02:00
Hans Blankenhaus
497ffde9fe undo changes for commonDb to avoid circular imports 2023-10-08 18:22:27 +02:00
Hans Blankenhaus
01203d884c fix classDB 2023-10-08 15:32:40 +02:00
Hans Blankenhaus
846fb3f8f8 making consitent config imports from diagramAPI 2023-10-08 14:17:45 +02:00
Marcel Ribeiro-Dantas
30b3e6213f fix(typos): Fix minor typos in the source code
Signed-off-by: Marcel Ribeiro-Dantas <mribeirodantas@seqera.io>
2023-10-07 22:16:11 -03:00
Sanjeet Kumar
38e906edbe Update README.zh-CN.md
updated twitter logo in README.zh-CN.md
2023-10-07 14:09:19 +05:30
Sanjeet Kumar
309bb50155 Update README.md
update Twitter logo in README.md
2023-10-07 14:08:29 +05:30
Nikolay Rozhkov
12a47076cf Merge pull request #4897 from guypursey/patch-1
Update notes on orientation in GitGraph documentation
2023-10-06 10:07:36 +00:00
Nikolay Rozhkov
f346c3f511 Merge branch 'develop' into patch-1 2023-10-06 12:42:56 +03:00
Nikolay Rozhkov
a4020dab27 Merge pull request #4413 from subhash-halder/feature/4269_add_xychart
Add new chart xychart
2023-10-06 09:32:55 +00:00
Nikolay Rozhkov
936319b9ad Merge branch 'develop' into feature/4269_add_xychart 2023-10-06 12:13:21 +03:00
Sidharth Vinod
157c90eeac Revert "fix: Reduce gantt exclude days length"
This reverts commit 2bde5ad667.
2023-10-06 10:49:09 +05:30
Sidharth Vinod
54d7b57f59 Merge pull request #4891 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-10-06 05:03:51 +00:00
Nikolay Rozhkov
c63ea3e987 Commented out broken test (#4913)
* Commented out bronken test

* Skip test instead of commenting out

* Fix

* Update cypress/integration/rendering/gantt.spec.js

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

---------

Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
Co-authored-by: Alois Klink <alois@aloisklink.com>
2023-10-06 04:45:13 +00:00
Sidharth Vinod
2bde5ad667 fix: Reduce gantt exclude days length 2023-10-05 21:37:57 +05:30
Martin Pedersen
41c7b08c99 prevent-inherited-lineheights-on-edgeterminal-4083 2023-10-05 16:52:15 +02:00
Nikolay Rozhkov
3a0ce43252 Merge branch 'develop' into feature/4269_add_xychart 2023-10-05 14:44:55 +03:00
Guy Pursey
97487acbc3 Updated GitGraph doc amendment based on feedback in PR. 2023-10-05 12:13:12 +01:00
guypursey
80af0e7ec7 Update docs 2023-10-04 14:43:00 +00:00
Guy Pursey
395ee5ef06 Update notes on orientation in GitGraph documentation
Attempt to make the documentation around left-right and top-down orientation clearer than it currently is, addressing issue #4885.
2023-10-04 15:37:50 +01:00
Sidharth Vinod
1d9ce74f64 Merge branch 'master' into develop
* master:
  Update docs
  Fix lint issue
  Fix release version
  Fix TopBar
  Add MC to integrations
  Add TopBar
  Docs: Add Product Hunt info (#4900)
2023-10-04 14:36:31 +05:30
Knut Sveidqvist
da79b371fe #3358 Recursive positioning paddings 2023-10-04 10:44:29 +02:00
Sidharth Vinod
6ef2b1ce1e Fix docs 2023-10-04 13:06:07 +05:30
Knut Sveidqvist
c8d155c455 #3358 Recursive positioning 2023-10-03 20:12:33 +02:00
Knut Sveidqvist
f00871a6b4 #3358 Recursive positioning 2023-10-03 14:19:08 +02:00
Knut Sveidqvist
b4e32542e8 #3358 Recursive positioning 2023-10-03 12:56:47 +02:00
subhash-halder
7f9dfa17f3 Update docs 2023-10-02 15:27:16 +00:00
Subhash Halder
0d64d8d8e7 Merge branch 'develop' into feature/4269_add_xychart 2023-10-02 20:52:47 +05:30
Subhash Halder
42f8990834 Changed requested by code review 2023-10-02 20:48:04 +05:30
0xflotus
0239e49d92 docs: fixed typo 2023-10-02 11:16:51 +02:00
Knut Sveidqvist
c9d6769dcd Merge remote-tracking branch 'origin/master' into develop 2023-10-02 10:26:43 +02:00
Knut Sveidqvist
279c1ee6ba Merge branch 'master' into develop 2023-10-02 10:22:21 +02:00
Alois Klink
1bd87e33f0 Merge pull request #4883 from FirstTimeInForever/docs/update-jetbrains-integration
Update link for the Mermaid integration in JetBrains IDEs
2023-09-30 17:43:48 +00:00
Alois Klink
ee78123949 Merge pull request #4887 from dennis0324/develop
docs: fix typo
2023-09-30 17:39:51 +00:00
Dennis Ko
595c63973f docs: typo fixed 2023-09-30 23:34:48 +09:00
Dennis Ko
f931c30f0a docs: typo fixed 2023-09-30 23:33:51 +09:00
Subhash Halder
0d348b7994 Updated code review changes 2023-09-29 18:59:05 +05:30
Subhash Halder
8b04c2ce88 Merge branch 'develop' into feature/4269_add_xychart 2023-09-29 18:12:21 +05:30
Ivan Posti
f8a3807b32 Update link for the Mermaid integration in JetBrains IDEs 2023-09-28 12:58:33 +02:00
Alois Klink
99beeba261 ci(pr-labeler): add required template option
This value is unused, but it's required, so we have to add it.

Fixes: a1673d3aca
2023-09-25 18:20:54 +01:00
renovate[bot]
fd2c2f7af3 chore(deps): update all patch dependencies 2023-09-25 07:43:56 +00:00
Sidharth Vinod
2049915c2a Merge pull request #4869 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-09-25 07:21:51 +00:00
Sidharth Vinod
789a38bece Merge pull request #4870 from mermaid-js/renovate/all-minor
chore(deps): update all minor dependencies (minor)
2023-09-25 07:21:38 +00:00
renovate[bot]
b7bdbf8054 chore(deps): update all minor dependencies 2023-09-25 01:17:07 +00:00
renovate[bot]
7553d0a720 chore(deps): update all patch dependencies 2023-09-25 01:16:33 +00:00
Alois Klink
a1673d3aca ci(pr-labeler): replace TimonVS/pr-labeler-action
Replace the `TimonVS/pr-labeler-action` with
`release-drafter/release-drafter` as it has an [`autolabeler`][1]
option that can autolabel PRs for us.

This should fix labeling PRs from forks,
see https://github.com/TimonVS/pr-labeler-action/issues/25.

I've kept the `.github/pr-labeler.yml` configuration file, so that
links to it from the https://mermaid.js.org website continue to work.

I've also kept everything in the same
`.github/workflows/pr-labeler.yml` GitHub Actions workflow to make the
`git diff` easier to review, and to keep the GitHub Actions permissions
the same.

[1]: ff929b5ceb/README.md (autolabeler)
2023-09-24 19:18:56 +01:00
Alois Klink
672a289909 style(pr-labeler): format .github/pr-labeler.yml
Change the formatting of .github/pr-labeler.yml to make `git diff`'s
easier to understand in a future commit.
2023-09-24 19:18:01 +01:00
Alois Klink
dc22189eef docs(ci/pr-labeler): warn about security issues
Using `pull_request_target` is pretty dangerous, since it heavily
increases the risk of malicious PRs getting access to the mermaid-js
repo.

What we're doing currently is safe, but we should add a warning
message just to ensure that we're very careful when we make changes.

See: https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
See: https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
2023-09-24 19:17:03 +01:00
Alois Klink
5f740312fe ci(release-draft): handle new release-drafter name
https://github.com/toolmantim/release-drafter has been renamed to
https://github.com/release-drafter/release-drafter.
2023-09-24 19:16:57 +01:00
Alois Klink
123d53c265 ci(release-drafter): remove unused branch config
`branch` is not a valid configuration option for release-drafter,
see
https://github.com/release-drafter/release-drafter#configuration-options

There's is a similar [`references` option][1], but it does nothing when
using GitHub Actions (it's only there for GitHub apps).

There's also `commitish`, but it defaults to the target/branch the
GitHub Action job runs on, so we don't need to set that.

[1]: https://github.com/release-drafter/release-drafter#references
2023-09-24 19:16:51 +01:00
Alois Klink
b928e60d8b ci(pr-labeler): limit GITHUB_TOKEN permissions
Limit the `GITHUB_TOKEN` permissions for `TimonVS/pr-labeler-action`
to the minimum required permissions.
2023-09-24 19:16:38 +01:00
Alois Klink
9688269027 ci(release-draft): limit GITHUB_TOKEN permissions
Limit the `GITHUB_TOKEN` permissions for `toolmantim/release-drafter`
to the minimum required permissions.
2023-09-24 19:16:33 +01:00
Sidharth Vinod
b054766388 Merge pull request #4841 from mermaid-js/sidv/LEBeta
Publish Live Editor previews for the `develop` & `next` branches
2023-09-24 05:50:47 +00:00
Sidharth Vinod
7825b59399 Merge pull request #4862 from janjonas/patch-2
Add new Atlassian integrations
2023-09-24 05:45:35 +00:00
Sidharth Vinod
095394dbef docs: Correct words
Co-authored-by: Alois Klink <alois@aloisklink.com>
2023-09-24 11:13:50 +05:30
Jan Jonas
b6134a3d6c Update integrations.md 2023-09-23 17:46:50 +02:00
Jan Jonas
62afe01634 Merge branch 'develop' into patch-2 2023-09-23 17:30:25 +02:00
Jan Jonas
54c56ba119 Update integrations.md 2023-09-23 17:29:56 +02:00
Jan Jonas
866cf4ea8c Update integrations.md 2023-09-23 17:21:37 +02:00
Jan Jonas
4be829412c Update integrations.md 2023-09-23 17:21:02 +02:00
Alois Klink
a19b0cf768 Merge pull request #4859 from Yokozuna59/chore/shorten-flow-huge-test-case
chore: shorten `flow-huge.spec.js` test case using `.repeat`
2023-09-23 13:42:54 +00:00
Jan Jonas
a31606aa82 Merge branch 'develop' into patch-2 2023-09-22 12:43:44 +02:00
Reda Al Sulais
ca960c4f5f Merge branch 'mermaid-js:develop' into chore/shorten-flow-huge-test-case 2023-09-22 13:31:25 +03:00
Reda Al Sulais
bd861977ca chore: shorten huge.html using repeat 2023-09-22 13:16:15 +03:00
Sidharth Vinod
0534d758ce Merge pull request #4860 from dreathed/bug/4849_center_axis_labels
bug/4849_center_axis_labels
2023-09-22 05:59:18 +00:00
Sidharth Vinod
2f6c1972e1 Update cypress/integration/rendering/quadrantChart.spec.js 2023-09-22 05:37:49 +00:00
Sidharth Vinod
d69fee382d Merge branch 'develop' into sidv/LEBeta
* develop:
  docs: Wrap email in <>
  chore(dev-deps): update @typescript-eslint to v6
  chore(deps): update all patch dependencies
  test(e2e): wait for theme-directives.html
  test(e2e): remove unused code in theme-directives
  test(e2e): wait for marker_unique_id.html e2e test
2023-09-22 10:47:48 +05:30
Sidharth Vinod
4946813ac6 chore: Build only mermaid 2023-09-22 10:47:06 +05:30
Sidharth Vinod
882350311b chore: Append commit hash to version 2023-09-22 10:40:42 +05:30
Sidharth Vinod
60d0dba648 Print commit ref 2023-09-22 10:25:42 +05:30
Sidharth Vinod
ab7fcb26d7 Update URLs. 2023-09-22 10:20:16 +05:30
Sidharth Vinod
b0da3fb786 docs: Wrap email in <> 2023-09-21 22:37:37 +05:30
Hans Blankenhaus
de770e4c3c changed name of test 2023-09-21 15:42:36 +02:00
Hans Blankenhaus
05e94b430a add image snapshot test for quadrantchart 2023-09-21 15:25:51 +02:00
Hans Blankenhaus
2d0b22892d added requested changes 2023-09-21 12:24:24 +02:00
Jan Jonas
43873fbe4a Add new Atlassian integrations 2023-09-21 10:57:11 +02:00
Hans Blankenhaus
d7591fbeda changed condition on which axis labels are centered 2023-09-21 10:55:09 +02:00
Hans Blankenhaus
5c39e99e32 Revert "center labels: removed condition"
This reverts commit a83fab28e1.
2023-09-21 10:35:18 +02:00
Sidharth Vinod
74c503204d Merge pull request #4857 from aloisklink/build/update-@typescript-eslint-to-v6
chore(dev-deps): update `@typescript-eslint/*` plugins to v6 (major)
2023-09-21 06:17:18 +00:00
Reda Al Sulais
6f05bf0846 chore: implement actual huge code correctly
Co-authored-by: Alois Klink <alois@aloisklink.com>
2023-09-21 01:26:40 +03:00
Reda Al Sulais
048dc07a90 chore: add comment on why we skip flow huge
Co-authored-by: Alois Klink <alois@aloisklink.com>
2023-09-21 01:23:00 +03:00
Hans Blankenhaus
a83fab28e1 center labels: removed condition 2023-09-20 22:56:45 +02:00
Subhash Halder
f56796c7cf Fix a review request in the docs 2023-09-20 19:57:48 +05:30
Reda Al Sulais
fc3a8902c0 chore: shorten flow-huge test case using repeat 2023-09-20 16:59:55 +03:00
Subhash Halder
f01f2dfcef Fix formatting in doc file 2023-09-19 21:18:06 +05:30
Subhash Halder
e56effa029 Merge branch 'develop' into feature/4269_add_xychart 2023-09-19 21:16:52 +05:30
Subhash Halder
e061489b84 Added review changes 2023-09-19 21:09:31 +05:30
Alois Klink
d4289e8db7 chore(dev-deps): update @typescript-eslint to v6
Update the `@typescript-eslint/eslint-plugin` and
`@typescript-eslint/parser` plugin to v6.

The full list of changes needed can be found in the
[Announcing typescript-eslint v6 blog post][1], but the ones that
affect us are:
- Dropped support for Node.JS v14.
  This isn't a big deal for us, since Mermaid uses a version of
  `eslint-plugin-jsdoc` that does not support Node.JS v14 either,
  see 120029913d
  (chore(deps): update dependency eslint-plugin-jsdoc to v46, 2023-06-27)
- Changes to the `plugin:@typescript-eslint/recommended` configuration.
  I've manually changed the following two rules to match their old
  `@typescript-eslint/parser` v5 settings, to avoid turning ESLint
  warnings into errors:
  - `@typescript-eslint/no-explicit-any` to `warn`
  - `@typescript-eslint/no-unused-vars` to `warn`

[1]: https://main--typescript-eslint.netlify.app/blog/announcing-typescript-eslint-v6
2023-09-19 15:51:51 +01:00
Sidharth Vinod
8be8736131 Merge pull request #4851 from mermaid-js/renovate/patch-all-patch
chore(deps): update all patch dependencies (patch)
2023-09-19 13:03:26 +00:00
renovate[bot]
6bab2f6693 chore(deps): update all patch dependencies 2023-09-19 11:27:03 +00:00
Sidharth Vinod
e8347cedf3 Merge pull request #4846 from aloisklink/test/fix-theme-directives-e2e-test
Wait for `theme-directives.html` E2E test to render before taking a screenshot
2023-09-19 11:18:15 +00:00
Sidharth Vinod
d6f1c11559 Merge pull request #4847 from aloisklink/test/wait-for-4825-e2e-test-to-finish
Wait for `marker_unique_id.html` E2E test to render before taking a screenshot
2023-09-19 11:17:34 +00:00
Alois Klink
17f5052a6f test(e2e): wait for theme-directives.html
The `theme-directives.html` test currently sometimes takes a screenshot
before all of the Mermaid diagrams have completed rendering.

We can use the `urlSnapshopTest()` helper function, which waits until
a `.rendered` property exists on the page.

Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-09-17 18:56:20 +01:00
Alois Klink
518e277cb2 test(e2e): remove unused code in theme-directives
We don't use any font-awesome icons, or custom fonts in this file.
2023-09-17 18:55:54 +01:00
Alois Klink
335ba40dd0 test(e2e): wait for marker_unique_id.html e2e test
Sometimes, Cypress takes the screenshot for marker_unique_id.html early,
before mermaid has finished rendering the diagrams.

Fixes: 924c9e913b

Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2023-09-17 18:32:52 +01:00
Sidharth Vinod
c64e2106cf docs: Add LiveEditor Beta 2023-09-15 13:53:07 +05:30
Subhash Halder
adb3cd16df Merge branch 'develop' into feature/4269_add_xychart 2023-09-14 20:50:27 +05:30
Sidharth Vinod
faa1fda7ba refactor: Unify the edgeMarker adding logic 2023-09-14 15:25:52 +05:30
Sidharth Vinod
29e5e66481 refactor: Unify the edgeMarker adding logic 2023-09-14 15:20:21 +05:30
Knut Sveidqvist
836d3a87be WIP 2023-09-14 10:11:43 +02:00
Subhash Halder
6e9eeb78c6 removed string concat to string builder 2023-09-09 16:11:18 +05:30
Subhash Halder
b98217e3c3 Fix YAML themeVariables config 2023-09-07 13:31:52 +05:30
Subhash Halder
fae648c253 Added the file name changes 2023-09-07 13:16:46 +05:30
Subhash Halder
9558cb9b16 Merge branch 'develop' into feature/4269_add_xychart 2023-09-07 12:55:22 +05:30
Subhash Halder
7c7d5881b7 Fixed all review comment 2023-09-07 12:45:22 +05:30
Knut Sveidqvist
ccdb803501 Rendering, interim 2023-09-05 15:15:08 +02:00
Knut Sveidqvist
1e864a508d Rendering, tmp commit before refactoring 2023-09-05 11:13:27 +02:00
Subhash Halder
a344eb48f4 Added cypress test cases 2023-09-03 20:48:52 +05:30
Subhash Halder
c3a9bb9a23 Fixed more edge cases 2023-09-03 20:48:10 +05:30
Subhash Halder
cc5190c1ba Fix some space management issue 2023-09-03 13:38:47 +05:30
Subhash Halder
060d961f39 Fixed directive related issue 2023-09-02 21:15:21 +05:30
Subhash Halder
fc9ff6c6f3 Added documentations 2023-09-02 20:48:11 +05:30
Subhash Halder
e0418eb661 Made the axis title optional 2023-09-02 18:08:59 +05:30
Subhash Halder
de2aa9d740 Fixed lint issue 2023-09-02 16:33:29 +05:30
Subhash Halder
f57b5271df Merge branch 'develop' into feature/4269_add_xychart 2023-09-02 16:02:27 +05:30
Subhash Halder
f9a91730aa Small minor changes 2023-09-02 15:45:30 +05:30
Subhash Halder
7bdf4c3dbb Added themes config to all the themes 2023-09-02 13:03:30 +05:30
Subhash Halder
b2669aaca9 Fixed some space management issue 2023-09-01 21:27:10 +05:30
Subhash Halder
54f2c63db1 Addressed all the new comment on jison 2023-09-01 20:57:05 +05:30
Knut Sveidqvist
5f1cfc7519 Support for compound blocks with id, title and type 2023-09-01 16:22:23 +02:00
Knut Sveidqvist
e52de6c279 Some cleanup 2023-09-01 15:40:49 +02:00
Knut Sveidqvist
8a55b212a2 Saving data from compound blocks 2023-09-01 15:33:38 +02:00
Knut Sveidqvist
aa7f5a8387 before refactoring 2023-09-01 14:06:13 +02:00
Knut Sveidqvist
5fc99f1982 #3358 Adding db calls from node statements 2023-08-28 12:51:49 +02:00
Subhash Halder
2b4c2e4ca9 Fixed lint and used selectSvgElement 2023-08-20 18:22:34 +05:30
Subhash Halder
5a64cec9ca Merge branch 'develop' into feature/4269_add_xychart 2023-08-20 18:09:51 +05:30
Subhash Halder
6c2bd33f36 Addressed all requested changes 2023-08-20 17:51:53 +05:30
Subhash Halder
526de36c86 Updated code to use latest config system 2023-08-13 22:56:50 +05:30
Knut Sveidqvist
b9531d56c4 Adding support for compound blocks 2023-08-08 15:56:02 +02:00
Subhash Halder
6c2faf0bda Simplified the jison file 2023-08-06 16:11:47 +05:30
Sidharth Vinod
a61d94d3aa Merge branch 'develop' into fix/pie-chart-viewbox 2023-07-25 19:22:19 +05:30
Knut Sveidqvist
13114ebaa1 Merge branch 'develop' into 3358-blocks-diagram 2023-07-25 11:47:22 +02:00
Subhash Halder
6e98759ee7 Improve plot color selection 2023-07-21 22:42:46 +05:30
Subhash Halder
c38cdcf2b2 Introduced theme config to configure cosmetics 2023-07-19 22:41:41 +05:30
Subhash Halder
5fd4ca2d41 added updated lock file 2023-07-19 20:52:34 +05:30
Subhash Halder
da1f46aada Blank commit as commit is not reflecting in the main repo 2023-07-19 20:49:04 +05:30
Subhash Halder
958f63ecd2 Improved parsing to work for minimal configuration possible. 2023-07-19 20:49:04 +05:30
Subhash Halder
1c8497474a Fixed prettier issues 2023-07-19 20:49:04 +05:30
Subhash Halder
89cfa17b07 Fixed some merge related issue and eslint issue 2023-07-19 20:49:04 +05:30
Subhash Halder
355263a4fb Fixed some issue related to rendering and space management 2023-07-19 20:45:44 +05:30
Subhash Halder
553be985ae Improved space management for text 2023-07-19 20:45:44 +05:30
Subhash Halder
597f7a8e87 Rendering the chart with all the property from chart config 2023-07-19 20:45:44 +05:30
Subhash Halder
ebd329149b Able to draw till axis from chart configuration
- there is some issue with drawing the plot from chart data
2023-07-19 20:45:44 +05:30
Subhash Halder
1d98ead5c2 Added support for Diagram title 2023-07-19 20:44:21 +05:30
Subhash Halder
d69a8aeb63 Added full jison for bar and line chart 2023-07-19 20:44:21 +05:30
Subhash Halder
29ab2dec59 Now jison can parse xAxis and yAxis 2023-07-19 20:44:21 +05:30
Subhash Halder
0a731e1ee1 Added support for horizontal drawing 2023-07-19 20:44:21 +05:30
Subhash Halder
547a22edef Added support for bar plot 2023-07-19 20:44:21 +05:30
Subhash Halder
cc1d6af232 Added axis tick and plot border 2023-07-19 20:44:21 +05:30
Subhash Halder
183bc0a978 Rendered axis with basic line chart 2023-07-19 20:44:21 +05:30
Subhash Halder
93697b74f4 Generated the base architecture 2023-07-19 20:44:21 +05:30
Subhash Halder
14e290bf1a Added base structure for xychart 2023-07-19 20:44:21 +05:30
Nikolay Rozhkov
e251baa61c Started layout and rendering 2023-07-11 02:51:10 +03:00
Nikolay Rozhkov
d165e8a642 Started block diag db development 2023-07-10 23:33:11 +03:00
Knut Sveidqvist
c10f76580f Adding some more tests 2023-07-09 12:28:14 +02:00
Nikolay Rozhkov
975f36c7db Fixed block diagram parser import 2023-07-07 14:14:30 +03:00
Nikolay Rozhkov
fee2b244a1 Small cleanup 2023-07-07 14:12:18 +03:00
Nikolay Rozhkov
791e67641e Rename BlockDiagram to Block 2023-07-07 13:58:30 +03:00
Issue哥
e33c4acf7d Merge branch 'fix/pie-chart-viewbox' of github.com:iwestlin/mermaid into fix/pie-chart-viewbox 2023-07-07 15:43:35 +08:00
Issue哥
a2d1fb5e54 use computeWidthOfText 2023-07-07 15:42:40 +08:00
Sidharth Vinod
bb16e50233 Merge branch 'develop' into fix/pie-chart-viewbox 2023-07-07 10:16:47 +05:30
Knut Sveidqvist
86e1bb38ee #3358 First commit with basic grammar and 1st test 2023-07-05 12:01:37 +02:00
Issue哥
f211ed686c fix: apply suggested changes for PR #4288 2023-06-27 21:56:38 +08:00
Issue哥
77999f0b37 fix: adjust piechart viewbox for mobile devices with small width 2023-06-27 01:32:12 +08:00
301 changed files with 18212 additions and 7110 deletions

View File

@@ -49,8 +49,10 @@ module.exports = {
'no-unused-vars': 'off',
'cypress/no-async-tests': 'off',
'@typescript-eslint/consistent-type-imports': 'error',
'@typescript-eslint/no-explicit-any': 'warn',
'@typescript-eslint/no-floating-promises': 'error',
'@typescript-eslint/no-misused-promises': 'error',
'@typescript-eslint/no-unused-vars': 'warn',
'@typescript-eslint/ban-ts-comment': [
'error',
{
@@ -61,6 +63,17 @@ module.exports = {
minimumDescriptionLength: 10,
},
],
'@typescript-eslint/naming-convention': [
'error',
{
selector: 'typeLike',
format: ['PascalCase'],
custom: {
regex: '^I[A-Z]',
match: false,
},
},
],
'json/*': ['error', 'allowComments'],
'@cspell/spellchecker': [
'error',

View File

@@ -17,6 +17,9 @@ body:
- Use a clear and concise title
- Fill out the text fields with as much detail as possible.
- Never be shy to give us screenshots and/or code samples. It will help!
There is a chance that the bug is already fixed in the git `develop` branch, but is not released yet.
So please check in [Live Editor - Develop](https://develop.git.mermaid.live) before raising an issue.
- type: textarea
attributes:
label: Description
@@ -43,7 +46,7 @@ body:
attributes:
label: Code Sample
description: |-
If applicable, add the code sample or a link to the [Live Editor](https://mermaid.live).
If applicable, add the code sample or a link to the [Live Editor - Develop](https://develop.git.mermaid.live).
Any text pasted here will be rendered as a Code block.
render: text
- type: textarea

View File

@@ -3,12 +3,18 @@ contact_links:
- name: GitHub Discussions
url: https://github.com/mermaid-js/mermaid/discussions
about: Ask the Community questions or share your own graphs in our discussions.
- name: Slack
url: https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE
about: Join our Community on Slack for Help and a casual chat.
- name: Discord
url: https://discord.gg/AgrbSrBer3
about: Join our Community on Discord for Help and a casual chat.
- name: Documentation
url: https://mermaid-js.github.io
url: https://mermaid.js.org
about: Read our documentation for all that Mermaid.js can offer.
- name: Live Editor
url: https://mermaid.live
about: Try the live editor to preview graphs in no time.
- name: Live Editor - Develop
url: https://develop.git.mermaid.live
about: Try unreleased changes in the develop branch.
- name: Live Editor - Next
url: https://next.git.mermaid.live
about: Try unreleased changes in the next branch.

4
.github/lychee.toml vendored
View File

@@ -34,8 +34,8 @@ exclude = [
# Don't check files that are generated during the build via `pnpm docs:code`
'packages/mermaid/src/docs/config/setup/*',
# Ignore slack invite
"https://join.slack.com/"
# Ignore Discord invite
"https://discord.gg"
]
# Exclude all private IPs from checking.

View File

@@ -1,4 +1,22 @@
'Type: Bug / Error': ['bug/*', fix/*]
'Type: Enhancement': ['feature/*', 'feat/*']
'Type: Other': ['other/*', 'chore/*', 'test/*', 'refactor/*']
'Area: Documentation': ['docs/*']
# yaml-language-server: $schema=https://raw.githubusercontent.com/release-drafter/release-drafter/master/schema.json
autolabeler:
- label: 'Type: Bug / Error'
branch:
- '/bug\/.+/'
- '/fix\/.+/'
- label: 'Type: Enhancement'
branch:
- '/feature\/.+/'
- '/feat\/.+/'
- label: 'Type: Other'
branch:
- '/other\/.+/'
- '/chore\/.+/'
- '/test\/.+/'
- '/refactor\/.+/'
- label: 'Area: Documentation'
branch:
- '/docs\/.+/'
template: |
This field is unused, as we only use this config file for labeling PRs.

View File

@@ -14,5 +14,5 @@ Make sure you
- [ ] :book: have read the [contribution guidelines](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md)
- [ ] :computer: have added necessary unit/e2e tests.
- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/community/development.md#3-update-documentation) is used for all new features.
- [ ] :notebook: have added documentation. Make sure [`MERMAID_RELEASE_VERSION`](https://github.com/mermaid-js/mermaid/blob/develop/packages/mermaid/src/docs/community/contributing.md#update-documentation) is used for all new features.
- [ ] :bookmark: targeted `develop` branch

View File

@@ -25,8 +25,6 @@ categories:
change-template: '- $TITLE (#$NUMBER) @$AUTHOR'
sort-by: title
sort-direction: ascending
branches:
- develop
exclude-labels:
- 'Skip changelog'
no-changes-template: 'This release contains minor changes and bugfixes.'

View File

@@ -16,20 +16,20 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: 18
node-version-file: '.node-version'
- name: Install Packages
run: pnpm install --frozen-lockfile
- name: Verify release verion
- name: Verify release version
if: ${{ github.event_name == 'push' && (github.ref == 'refs/heads/master' || startsWith(github.ref, 'refs/heads/release')) }}
run: pnpm --filter mermaid run docs:verify-version

View File

@@ -15,20 +15,17 @@ permissions:
jobs:
build-mermaid:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: ${{ matrix.node-version }}
node-version-file: '.node-version'
- name: Install Packages
run: |

View File

@@ -18,7 +18,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: Check for difference in README.md and docs/README.md
run: |

View File

@@ -15,7 +15,7 @@ jobs:
name: check tests
if: github.repository_owner == 'mermaid-js'
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: testomatio/check-tests@stable

View File

@@ -29,7 +29,7 @@ jobs:
steps:
- name: Checkout repository
uses: actions/checkout@v3
uses: actions/checkout@v4
# Initializes the CodeQL tools for scanning.
- name: Initialize CodeQL

View File

@@ -1,6 +1,6 @@
# Dependency Review Action
#
# This Action will scan dependency manifest files that change as part of a Pull Reqest, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
# This Action will scan dependency manifest files that change as part of a Pull Request, surfacing known-vulnerable versions of the packages declared or updated in the PR. Once installed, if the workflow run is marked as required, PRs introducing known-vulnerable packages will be blocked from merging.
#
# Source repository: https://github.com/actions/dependency-review-action
# Public documentation: https://docs.github.com/en/code-security/supply-chain-security/understanding-your-software-supply-chain/about-dependency-review#dependency-review-enforcement
@@ -15,6 +15,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: 'Checkout Repository'
uses: actions/checkout@v3
uses: actions/checkout@v4
- name: 'Dependency Review'
uses: actions/dependency-review-action@v3

View File

@@ -21,24 +21,24 @@ env:
jobs:
e2e-applitools:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
container:
image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
options: --user 1001
steps:
- if: ${{ ! env.USE_APPLI }}
name: Warn if not using Applitools
run: |
echo "::error,title=Not using Applitols::APPLITOOLS_API_KEY is empty, disabling Applitools for this run."
echo "::error,title=Not using Applitools::APPLITOOLS_API_KEY is empty, disabling Applitools for this run."
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
node-version-file: '.node-version'
- if: ${{ env.USE_APPLI }}
name: Notify applitools of new batch

View File

@@ -1,31 +1,90 @@
# We use github cache to save snapshots between runs.
# For PRs and MergeQueues, the target commit is used, and for push events, github.event.previous is used.
# If a snapshot for a given Hash is not found, we checkout that commit, run the tests and cache the snapshots.
# These are then downloaded before running the E2E, providing the reference snapshots.
# If there are any errors, the diff image is uploaded to artifacts, and the user is notified.
name: E2E
on:
push:
branches-ignore:
- 'gh-readonly-queue/**'
pull_request:
merge_group:
permissions:
contents: read
env:
# For PRs and MergeQueues, the target commit is used, and for push events, github.event.previous is used.
targetHash: ${{ github.event.pull_request.base.sha || github.event.merge_group.base_sha || (github.event.before == '0000000000000000000000000000000000000000' && 'develop' || github.event.before) }}
jobs:
cache:
runs-on: ubuntu-latest
container:
image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
options: --user 1001
steps:
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version-file: '.node-version'
- name: Cache snapshots
id: cache-snapshot
uses: actions/cache@v4
with:
save-always: true
path: ./cypress/snapshots
key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
# If a snapshot for a given Hash is not found, we checkout that commit, run the tests and cache the snapshots.
- name: Switch to base branch
if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true' }}
uses: actions/checkout@v4
with:
ref: ${{ env.targetHash }}
- name: Cypress run
uses: cypress-io/github-action@v4
id: cypress-snapshot-gen
if: ${{ steps.cache-snapshot.outputs.cache-hit != 'true' }}
with:
start: pnpm run dev
wait-on: 'http://localhost:9000'
browser: chrome
e2e:
runs-on: ubuntu-latest
container:
image: cypress/browsers:node-20.11.0-chrome-121.0.6167.85-1-ff-120.0-edge-121.0.2277.83-1
options: --user 1001
needs: cache
strategy:
fail-fast: false
matrix:
node-version: [18.x]
containers: [1, 2, 3, 4]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
node-version: ${{ matrix.node-version }}
node-version-file: '.node-version'
# These cached snapshots are downloaded, providing the reference snapshots.
- name: Cache snapshots
id: cache-snapshot
uses: actions/cache/restore@v3
with:
path: ./cypress/snapshots
key: ${{ runner.os }}-snapshots-${{ env.targetHash }}
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
@@ -38,6 +97,7 @@ jobs:
with:
start: pnpm run dev:coverage
wait-on: 'http://localhost:9000'
browser: chrome
# Disable recording if we don't have an API key
# e.g. if this action was run from a fork
record: ${{ secrets.CYPRESS_RECORD_KEY != '' }}
@@ -46,6 +106,7 @@ jobs:
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
VITEST_COVERAGE: true
CYPRESS_COMMIT: ${{ github.sha }}
- name: Upload Coverage to Codecov
uses: codecov/codecov-action@v3
# Run step only pushes to develop and pull_requests
@@ -57,9 +118,55 @@ jobs:
fail_ci_if_error: false
verbose: true
token: 6845cc80-77ee-4e17-85a1-026cd95e0766
# We upload the artifacts into numbered archives to prevent overwriting
- name: Upload Artifacts
uses: actions/upload-artifact@v3
if: ${{ failure() && steps.cypress.conclusion == 'failure' }}
uses: actions/upload-artifact@v4
if: ${{ always() }}
with:
name: snapshots-${{ matrix.containers }}
retention-days: 1
path: ./cypress/snapshots
combineArtifacts:
needs: e2e
runs-on: ubuntu-latest
if: ${{ always() }}
steps:
# Download all snapshot artifacts and merge them into a single folder
- name: Download All Artifacts
uses: actions/download-artifact@v4
with:
path: snapshots
pattern: snapshots-*
merge-multiple: true
# For successful push events, we save the snapshots cache
- name: Save snapshots cache
id: cache-upload
if: ${{ github.event_name == 'push' && needs.e2e.result != 'failure' }}
uses: actions/cache/save@v3
with:
path: ./snapshots
key: ${{ runner.os }}-snapshots-${{ github.event.after }}
- name: Flatten images to a folder
if: ${{ needs.e2e.result == 'failure' }}
run: |
mkdir errors
cd snapshots
find . -mindepth 2 -type d -name "*__diff_output__*" -exec sh -c 'mv "$0"/*.png ../errors/' {} \;
- name: Upload Error snapshots
if: ${{ needs.e2e.result == 'failure' }}
uses: actions/upload-artifact@v4
id: upload-artifacts
with:
name: error-snapshots
path: cypress/snapshots/**/__diff_output__/*
retention-days: 10
path: errors/
- name: Notify Users
if: ${{ needs.e2e.result == 'failure' }}
run: |
echo "::error title=Visual tests failed::You can view images that failed by downloading the error-snapshots artifact: ${{ steps.upload-artifacts.outputs.artifact-url }}"

View File

@@ -26,7 +26,7 @@ jobs:
# lychee only uses the GITHUB_TOKEN to avoid rate-limiting
contents: read
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- name: Restore lychee cache
uses: actions/cache@v3
@@ -36,7 +36,7 @@ jobs:
restore-keys: cache-lychee-
- name: Link Checker
uses: lycheeverse/lychee-action@v1.8.0
uses: lycheeverse/lychee-action@v1.9.1
with:
args: >-
--config .github/lychee.toml

View File

@@ -16,20 +16,17 @@ permissions:
jobs:
lint:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: ${{ matrix.node-version }}
node-version-file: '.node-version'
- name: Install Packages
run: |

View File

@@ -1,23 +0,0 @@
name: Validate PR Labeler Configuration
on:
push:
paths:
- .github/workflows/pr-labeler-config-validator.yml
- .github/workflows/pr-labeler.yml
- .github/pr-labeler.yml
pull_request:
paths:
- .github/workflows/pr-labeler-config-validator.yml
- .github/workflows/pr-labeler.yml
- .github/pr-labeler.yml
jobs:
pr-labeler:
runs-on: ubuntu-latest
steps:
- name: Checkout Repository
uses: actions/checkout@v3
- name: Validate Configuration
uses: Yash-Singh1/pr-labeler-config-validator@releases/v0.0.3
with:
configuration-path: .github/pr-labeler.yml

View File

@@ -1,13 +1,31 @@
name: Apply labels to PR
on:
pull_request_target:
types: [opened]
# required for pr-labeler to support PRs from forks
# ===================== ⛔ ☢️ 🚫 ⚠️ Warning ⚠️ 🚫 ☢️ ⛔ =======================
# Be very careful what you put in this GitHub Action workflow file to avoid
# malicious PRs from getting access to the Mermaid-js repo.
#
# Please read the following first before reviewing/merging:
# - https://docs.github.com/en/actions/using-workflows/events-that-trigger-workflows#pull_request_target
# - https://securitylab.github.com/research/github-actions-preventing-pwn-requests/
types: [opened, reopened, synchronize]
permissions:
contents: read
jobs:
pr-labeler:
runs-on: ubuntu-latest
permissions:
contents: read # read permission is required to read config file
pull-requests: write # write permission is required to label PRs
steps:
- name: Label PR
uses: TimonVS/pr-labeler-action@v4
uses: release-drafter/release-drafter@v5
with:
config-name: pr-labeler.yml
disable-autolabeler: false
disable-releaser: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -23,15 +23,15 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: 18
node-version-file: '.node-version'
- name: Install Packages
run: pnpm install --frozen-lockfile

View File

@@ -3,13 +3,21 @@ name: Draft Release
on:
push:
branches:
- develop
- master
permissions:
contents: read
jobs:
draft-release:
runs-on: ubuntu-latest
permissions:
contents: write # write permission is required to create a github release
pull-requests: read # required to read PR titles/labels
steps:
- name: Draft Release
uses: toolmantim/release-drafter@v5
uses: release-drafter/release-drafter@v5
with:
disable-autolabeler: true
env:
GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

View File

@@ -9,17 +9,17 @@ jobs:
publish-preview:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
with:
fetch-depth: 0
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v3
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: 18.x
node-version-file: '.node-version'
- name: Install Packages
run: |

View File

@@ -8,17 +8,17 @@ jobs:
publish:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: fregante/setup-git-user@v2
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js v18
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: 18.x
node-version-file: '.node-version'
- name: Install Packages
run: |

View File

@@ -8,20 +8,17 @@ permissions:
jobs:
unit-test:
runs-on: ubuntu-latest
strategy:
matrix:
node-version: [18.x]
steps:
- uses: actions/checkout@v3
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
# uses version from "packageManager" field in package.json
- name: Setup Node.js ${{ matrix.node-version }}
uses: actions/setup-node@v3
- name: Setup Node.js
uses: actions/setup-node@v4
with:
cache: pnpm
node-version: ${{ matrix.node-version }}
node-version-file: '.node-version'
- name: Install Packages
run: |

View File

@@ -8,11 +8,18 @@ jobs:
update-browser-list:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
- run: npx browserslist@latest --update-db
- uses: actions/checkout@v4
- uses: pnpm/action-setup@v2
- run: npx update-browserslist-db@latest
- name: Commit changes
uses: EndBug/add-and-commit@v9
with:
author_name: ${{ github.actor }}
author_email: ${{ github.actor }}@users.noreply.github.com
message: 'chore: update browsers list'
push: false
- name: Create Pull Request
uses: peter-evans/create-pull-request@v5
with:
branch: update-browserslist
title: Update Browserslist

1
.gitignore vendored
View File

@@ -46,3 +46,4 @@ stats/
demos/dev/**
!/demos/dev/example.html
tsx-0/**

View File

@@ -6,6 +6,6 @@ export default {
// https://prettier.io/docs/en/cli.html#--cache
'prettier --write',
],
'cSpell.json': ['ts-node-esm scripts/fixCSpell.ts'],
'cSpell.json': ['tsx scripts/fixCSpell.ts'],
'**/*.jison': ['pnpm -w run lint:jison'],
};

1
.node-version Normal file
View File

@@ -0,0 +1 @@
v20.11.0

1
.npmrc
View File

@@ -1,2 +1,3 @@
registry=https://registry.npmjs.org
auto-install-peers=true
strict-peer-dependencies=false

View File

@@ -10,3 +10,6 @@ stats
.nyc_output
# Autogenerated by `pnpm run --filter mermaid types:build-config`
packages/mermaid/src/config.type.ts
# Ignore the files creates in /demos/dev except for example.html
demos/dev/**
!/demos/dev/example.html

View File

@@ -117,6 +117,9 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
output,
},
},
define: {
'import.meta.vitest': 'undefined',
},
resolve: {
extensions: [],
},

View File

@@ -18,12 +18,14 @@ const MERMAID_CONFIG_DIAGRAM_KEYS = [
'er',
'pie',
'quadrantChart',
'xyChart',
'requirement',
'mindmap',
'timeline',
'gitGraph',
'c4',
'sankey',
'block',
] as const;
/**

3
.vscode/launch.json vendored
View File

@@ -18,7 +18,8 @@
"type": "node",
"request": "launch",
"args": ["scripts/docs.cli.mts"],
"runtimeArgs": ["--loader", "ts-node/esm"],
// we'll need to change this to --import in Node.JS v20.6.0 and up
"runtimeArgs": ["--loader", "tsx/esm"],
"cwd": "${workspaceRoot}/packages/mermaid",
"skipFiles": ["<node_internals>/**", "**/node_modules/**"],
"smartStep": true,

View File

@@ -68,7 +68,7 @@ try {
### Init deprecated and InitThrowsErrors removed
The config passed to `init` was not being used eariler.
The config passed to `init` was not being used earlier.
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`.
@@ -195,7 +195,7 @@ mermaid.run({
- "Cannot activate" in sequenceDiagram [\#647](https://github.com/knsv/mermaid/issues/647)
- Link \("click" statement\) in flowchart does not work in exported SVG [\#646](https://github.com/knsv/mermaid/issues/646)
- How to pass styling [\#639](https://github.com/knsv/mermaid/issues/639)
- The live editor cant show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638)
- The live editor can't show seq diagram with notes for 8.0.0-alpha.3 [\#638](https://github.com/knsv/mermaid/issues/638)
- import mermaid.css with ES6 + NPM [\#634](https://github.com/knsv/mermaid/issues/634)
- Actor line cuts through other elements [\#633](https://github.com/knsv/mermaid/issues/633)
- Graph TD line out of the picture \(left side\) [\#630](https://github.com/knsv/mermaid/issues/630)
@@ -504,7 +504,7 @@ mermaid.run({
- Docs css: code hard to read [\#324](https://github.com/knsv/mermaid/issues/324)
- About Markpad integration [\#323](https://github.com/knsv/mermaid/issues/323)
- How to link backwords in flowchat? [\#321](https://github.com/knsv/mermaid/issues/321)
- How to link backwards in flowchat? [\#321](https://github.com/knsv/mermaid/issues/321)
- Help with editor [\#310](https://github.com/knsv/mermaid/issues/310)
- +1 [\#293](https://github.com/knsv/mermaid/issues/293)
- Basic chart does not render on Chome, but does in Firefox [\#290](https://github.com/knsv/mermaid/issues/290)
@@ -619,7 +619,7 @@ mermaid.run({
- render to png from the cli does not display the marker-end arrow heads [\#181](https://github.com/knsv/mermaid/issues/181)
- Links in sequence diagrams [\#159](https://github.com/knsv/mermaid/issues/159)
- comment characters `%%` cause parse error [\#141](https://github.com/knsv/mermaid/issues/141)
- Add a reversed assymetric shape [\#124](https://github.com/knsv/mermaid/issues/124)
- Add a reversed asymmetric shape [\#124](https://github.com/knsv/mermaid/issues/124)
- Add syntax for double headed arrows [\#123](https://github.com/knsv/mermaid/issues/123)
- Support for font-awesome [\#49](https://github.com/knsv/mermaid/issues/49)
@@ -659,7 +659,7 @@ mermaid.run({
- Auto linewrap for notes in sequence diagrams [\#178](https://github.com/knsv/mermaid/issues/178)
- Execute code after initialize [\#176](https://github.com/knsv/mermaid/issues/176)
- Autoscaling for all diagram types [\#175](https://github.com/knsv/mermaid/issues/175)
- Problem wit click event callback [\#174](https://github.com/knsv/mermaid/issues/174)
- Problem with click event callback [\#174](https://github.com/knsv/mermaid/issues/174)
- How to escape characters? [\#170](https://github.com/knsv/mermaid/issues/170)
- it can not work [\#167](https://github.com/knsv/mermaid/issues/167)
- UML Class diagram [\#154](https://github.com/knsv/mermaid/issues/154)
@@ -762,7 +762,7 @@ mermaid.run({
- subgraph background is black in rendered flowchart PNG via CLI [\#121](https://github.com/knsv/mermaid/issues/121)
- Integrate editor at https://github.com/naseer/mermaid-webapp [\#110](https://github.com/knsv/mermaid/issues/110)
- Internet Explorer Support [\#99](https://github.com/knsv/mermaid/issues/99)
- Assymetric shapes not documented [\#82](https://github.com/knsv/mermaid/issues/82)
- Asymmetric shapes not documented [\#82](https://github.com/knsv/mermaid/issues/82)
- NoModificationAllowedError [\#23](https://github.com/knsv/mermaid/issues/23)
- Improve arrows [\#3](https://github.com/knsv/mermaid/issues/3)
@@ -908,7 +908,7 @@ mermaid.run({
- Question marks don't render properly with /dist/mermaid.full.min.js [\#30](https://github.com/knsv/mermaid/issues/30)
- Error with some characters [\#25](https://github.com/knsv/mermaid/issues/25)
- Provide parse function in browser widthout `require`? [\#21](https://github.com/knsv/mermaid/issues/21)
- Provide parse function in browser without `require`? [\#21](https://github.com/knsv/mermaid/issues/21)
- Better label text support [\#18](https://github.com/knsv/mermaid/issues/18)
- Cap-cased words break parser [\#8](https://github.com/knsv/mermaid/issues/8)

View File

@@ -59,8 +59,8 @@ representative at an online or offline event.
## Enforcement
Instances of abusive, harassing, or otherwise unacceptable behavior may be
reported to the community leaders responsible for enforcement at security@mermaid.live
.
reported to the community leaders responsible for enforcement at <security@mermaid.live>.
All complaints will be reviewed and investigated promptly and fairly.
All community leaders are obligated to respect the privacy and security of the

View File

@@ -1,78 +0,0 @@
# Contributing
Please read in detail about how to contribute documentation and code on the [Mermaid documentation site.](https://mermaid-js.github.io/mermaid/#/development)
---
# Mermaid contribution cheat-sheet
## Requirements
- [volta](https://volta.sh/) to manage node versions.
- [Node.js](https://nodejs.org/en/). `volta install node`
- [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
## Development Installation
If you don't have direct access to push to mermaid repositories, make a fork first. Then clone. Or clone directly from mermaid-js:
```bash
git clone git@github.com:mermaid-js/mermaid.git
cd mermaid
```
Install required packages:
```bash
# npx is required for first install as volta support for pnpm is not added yet.
npx pnpm install
pnpm test # run unit tests
pnpm dev # starts a dev server
```
Open <http://localhost:9000> in your browser after starting the dev server.
You can also duplicate the `example.html` file in `demos/dev`, rename it and add your own mermaid code to it.
That will be served at <http://localhost:9000/dev/your-file-name.html>.
### Docker
If you are using docker and docker-compose, you have self-documented `run` bash script, which is a convenient alias for docker-compose commands:
```bash
./run install # npx pnpm install
./run test # pnpm test
```
## Testing
```bash
# Run unit test
pnpm test
# Run unit test in watch mode
pnpm test:watch
# Run E2E test
pnpm e2e
# Debug E2E tests
pnpm dev
pnpm cypress:open # in another terminal
```
## Branch name format:
```text
[feature | bug | chore | docs]/[issue number]_[short description using dashes ('-') or underscores ('_') instead of spaces]
```
eg: `feature/2945_state-diagram-new-arrow-florbs`, `bug/1123_fix_random_ugly_red_text`
## Documentation
Documentation is necessary for all non bugfix/refactoring changes.
Only make changes to files that are in [`/packages/mermaid/src/docs`](packages/mermaid/src/docs)
**_DO NOT CHANGE FILES IN `/docs` MANUALLY_**
The `/docs` folder will be rebuilt and committed as part of a pre-commit hook.
[Join our slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)

1
CONTRIBUTING.md Symbolic link
View File

@@ -0,0 +1 @@
./packages/mermaid/src/docs/community/contributing.md

2
Dockerfile Normal file
View File

@@ -0,0 +1,2 @@
FROM node:20.11.0-alpine3.19 AS base
RUN wget -qO- https://get.pnpm.io/install.sh | ENV="$HOME/.shrc" SHELL="$(which sh)" sh -

View File

@@ -15,11 +15,14 @@ Generate diagrams from markdown-like text.
<a href="https://mermaid.live/"><b>Live Editor!</b></a>
</p>
<p align="center">
<a href="https://mermaid.js.org">📖 Documentation</a> | <a href="https://mermaid.js.org/intro/">🚀 Getting Started</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE" title="Slack invite">🙌 Join Us</a>
<a href="https://mermaid.js.org">📖 Documentation</a> | <a href="https://mermaid.js.org/intro/">🚀 Getting Started</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://discord.gg/AgrbSrBer3" title="Discord invite">🙌 Join Us</a>
</p>
<p align="center">
<a href="./README.zh-CN.md">简体中文</a>
</p>
<p align="center">
Try Live Editor previews of future releases: <a href="https://develop.git.mermaid.live/" title="Try the mermaid version from the develop branch.">Develop</a> | <a href="https://next.git.mermaid.live/" title="Try the mermaid version from the next branch.">Next</a>
</p>
<br>
<br>
@@ -30,8 +33,8 @@ Generate diagrams from markdown-like text.
[![Coverage Status](https://codecov.io/github/mermaid-js/mermaid/branch/develop/graph/badge.svg)](https://app.codecov.io/github/mermaid-js/mermaid/tree/develop)
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
[![NPM Downloads](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=twitter)](https://twitter.com/mermaidjs_)
[![Join our Discord!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=discord&label=discord)](https://discord.gg/AgrbSrBer3)
[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=X)](https://twitter.com/mermaidjs_)
<img src="./img/header.png" alt="" />
@@ -41,6 +44,22 @@ Generate diagrams from markdown-like text.
<a href="https://mermaid-js.github.io/mermaid/landing/"><img src="https://github.com/mermaid-js/mermaid/blob/master/docs/intro/img/book-banner-post-release.jpg" alt="Explore Mermaid.js in depth, with real-world examples, tips & tricks from the creator... The first official book on Mermaid is available for purchase. Check it out!"></a>
## Table of content
<details>
<summary>Expand contents</summary>
- [About](#about)
- [Examples](#examples)
- [Release](#release)
- [Related projects](#related-projects)
- [Contributors](#contributors)
- [Security and safe diagrams](#security-and-safe-diagrams)
- [Reporting vulnerabilities](#reporting-vulnerabilities)
- [Appreciation](#appreciation)
</details>
## About
<!-- <Main description> -->
@@ -55,12 +74,12 @@ Mermaid addresses this problem by enabling users to create easily modifiable dia
<br/>
Mermaid allows even non-programmers to easily create detailed diagrams through the [Mermaid Live Editor](https://mermaid.live/).<br/>
[Tutorials](./docs/config/Tutorials.md) has video tutorials.
For video tutorials, visit our [Tutorials](./docs/ecosystem/tutorials.md) page.
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations-community.md).
You can also use Mermaid within [GitHub](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) as well many of your other favorite applications—check out the list of [Integrations and Usages of Mermaid](./docs/ecosystem/integrations-community.md).
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/intro/getting-started.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/config/Tutorials.md).
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/intro/getting-started.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/ecosystem/tutorials.md).
In our release process we rely heavily on visual regression tests using [applitools](https://applitools.com/). Applitools is a great service which has been easy to use and integrate with our tests.

View File

@@ -12,15 +12,19 @@ Mermaid
<p>
<p align="center">
<a href="https://mermaid.live/"><b>Live Editor!</b></a>
<a href="https://mermaid.live/"><b>实时编辑器!</b></a>
</p>
<p align="center">
<a href="https://mermaid.js.org">📖 文档</a> | <a href="https://mermaid.js.org/intro/">🚀 入门</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE" title="Slack invite">🙌 加入我们</a>
<a href="https://mermaid.js.org">📖 文档</a> | <a href="https://mermaid.js.org/intro/">🚀 入门</a> | <a href="https://www.jsdelivr.com/package/npm/mermaid">🌐 CDN</a> | <a href="https://discord.gg/AgrbSrBer3" title="Discord invite">🙌 加入我们</a>
</p>
<p align="center">
<a href="./README.md">English</a>
</p>
<p align="center">
尝试未来版本的实时编辑器预览: <a href="https://develop.git.mermaid.live/" title="尝试来自develop分支的mermaid版本。">Develop</a> | <a href="https://next.git.mermaid.live/" title="尝试来自next分支的mermaid版本。">Next</a>
</p>
<br>
<br>
@@ -30,8 +34,8 @@ Mermaid
[![Coverage Status](https://codecov.io/github/mermaid-js/mermaid/branch/develop/graph/badge.svg)](https://app.codecov.io/github/mermaid-js/mermaid/tree/develop)
[![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid)
[![NPM Downloads](https://img.shields.io/npm/dm/mermaid)](https://www.npmjs.com/package/mermaid)
[![Join our Slack!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=slack&label=slack)](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=twitter)](https://twitter.com/mermaidjs_)
[![Join our Discord!](https://img.shields.io/static/v1?message=join%20chat&color=9cf&logo=discord&label=discord)](https://discord.gg/AgrbSrBer3)
[![Twitter Follow](https://img.shields.io/badge/Social-mermaidjs__-blue?style=social&logo=X)](https://twitter.com/mermaidjs_)
<img src="./img/header.png" alt="" />
@@ -53,9 +57,9 @@ Mermaid 是一个基于 Javascript 的图表绘制工具,通过解析类 Markd
Mermaid 通过允许用户创建便于修改的图表来解决这一难题,它也可以作为生产脚本(或其他代码)的一部分。<br/>
<br/>
Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://mermaid.live/) 轻松创建详细的图表。<br/>
你可以访问 [教程](./docs/config/Tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/ecosystem/integrations-community.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
你可以访问 [教程](./docs/ecosystem/tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/ecosystem/integrations-community.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/intro/getting-started.md), [用法](./docs/config/usage.md) 和 [教程](./docs/config/Tutorials.md).
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/intro/getting-started.md), [用法](./docs/config/usage.md) 和 [教程](./docs/ecosystem/tutorials.md).
<!-- </Main description> -->

View File

@@ -1,19 +0,0 @@
// eslint-disable-next-line @typescript-eslint/no-var-requires
const { defineConfig } = require('cypress');
module.exports = defineConfig({
testConcurrency: 1,
browser: [
// Add browsers with different viewports
// { width: 800, height: 600, name: 'chrome' },
// { width: 700, height: 500, name: 'firefox' },
// { width: 1600, height: 1200, name: 'ie11' },
// { width: 1024, height: 768, name: 'edgechromium' },
// { width: 800, height: 600, name: 'safari' },
// // Add mobile emulation devices in Portrait mode
// { deviceName: 'iPhone X', screenOrientation: 'portrait' },
// { deviceName: 'Pixel 2', screenOrientation: 'portrait' },
],
// set batch name to the configuration
// batchName: `Mermaid ${process.env.APPLI_BRANCH ?? "'no APPLI_BRANCH set'"}`,
});

View File

@@ -26,7 +26,9 @@
"città",
"classdef",
"codedoc",
"codemia",
"colour",
"colours",
"commitlint",
"cpettitt",
"customizability",
@@ -101,6 +103,7 @@
"pathe",
"pbrolin",
"phpbb",
"pixelmatch",
"plantuml",
"playfair",
"pnpm",
@@ -123,6 +126,7 @@
"sidharth",
"sidharthv",
"sphinxcontrib",
"ssim",
"startx",
"starty",
"statediagram",
@@ -156,6 +160,7 @@
"vitepress",
"vueuse",
"xlink",
"xychart",
"yash",
"yokozuna",
"zenuml",

View File

@@ -1,24 +0,0 @@
/* eslint-disable @typescript-eslint/no-var-requires */
const { defineConfig } = require('cypress');
const { addMatchImageSnapshotPlugin } = require('cypress-image-snapshot/plugin');
const coverage = require('@cypress/code-coverage/task');
module.exports = defineConfig({
projectId: 'n2sma2',
e2e: {
specPattern: 'cypress/integration/**/*.{js,jsx,ts,tsx}',
setupNodeEvents(on, config) {
coverage(on, config);
addMatchImageSnapshotPlugin(on, config);
// copy any needed variables from process.env to config.env
config.env.useAppli = process.env.USE_APPLI ? true : false;
// do not forget to return the changed config object!
return config;
},
},
video: false,
});
require('@applitools/eyes-cypress')(module);

30
cypress.config.ts Normal file
View File

@@ -0,0 +1,30 @@
import { defineConfig } from 'cypress';
import { addMatchImageSnapshotPlugin } from 'cypress-image-snapshot/plugin';
import coverage from '@cypress/code-coverage/task';
import eyesPlugin from '@applitools/eyes-cypress';
export default eyesPlugin(
defineConfig({
projectId: 'n2sma2',
viewportWidth: 1440,
viewportHeight: 1024,
e2e: {
specPattern: 'cypress/integration/**/*.{js,ts}',
setupNodeEvents(on, config) {
coverage(on, config);
on('before:browser:launch', (browser, launchOptions) => {
if (browser.name === 'chrome' && browser.isHeadless) {
launchOptions.args.push('--window-size=1440,1024', '--force-device-scale-factor=1');
}
return launchOptions;
});
addMatchImageSnapshotPlugin(on, config);
// copy any needed variables from process.env to config.env
config.env.useAppli = process.env.USE_APPLI ? true : false;
// do not forget to return the changed config object!
return config;
},
},
video: false,
})
);

View File

@@ -10,7 +10,7 @@ interface CypressConfig {
type CypressMermaidConfig = MermaidConfig & CypressConfig;
interface CodeObject {
code: string;
code: string | string[];
mermaid: CypressMermaidConfig;
}
@@ -25,7 +25,7 @@ const batchId: string =
: Cypress.env('CYPRESS_COMMIT') || Date.now().toString());
export const mermaidUrl = (
graphStr: string,
graphStr: string | string[],
options: CypressMermaidConfig,
api: boolean
): string => {
@@ -82,7 +82,7 @@ export const urlSnapshotTest = (
};
export const renderGraph = (
graphStr: string,
graphStr: string | string[],
options: CypressMermaidConfig = {},
api = false
): void => {

View File

@@ -117,7 +117,6 @@ describe('Configuration', () => {
});
it('should not taint the initial configuration when using multiple directives', () => {
const url = 'http://localhost:9000/regression/issue-1874.html';
cy.viewport(1440, 1024);
cy.visit(url);
cy.get('svg');

View File

@@ -1,14 +1,12 @@
describe('Rerendering', () => {
it('should be able to render after an error has occurred', () => {
const url = 'http://localhost:9000/render-after-error.html';
cy.viewport(1440, 1024);
cy.visit(url);
cy.get('#graphDiv').should('exist');
});
it('should be able to render and rerender a graph via API', () => {
const url = 'http://localhost:9000/rerender.html';
cy.viewport(1440, 1024);
cy.visit(url);
cy.get('#graph [id^=flowchart-A]').should('have.text', 'XMas');

View File

@@ -0,0 +1,386 @@
import { imgSnapshotTest } from '../../helpers/util';
/* eslint-disable no-useless-escape */
describe('Block diagram', () => {
it('BL1: should calculate the block widths', () => {
imgSnapshotTest(
`block-beta
columns 2
block
id2["I am a wide one"]
id1
end
id["Next row"]
`
);
});
it('BL2: should handle colums statement in sub-blocks', () => {
imgSnapshotTest(
`block-beta
id1["Hello"]
block
columns 3
id2["to"]
id3["the"]
id4["World"]
id5["World"]
end
`,
{}
);
});
it('BL3: should align block widths and handle colums statement in sub-blocks', () => {
imgSnapshotTest(
`block-beta
block
columns 1
id1
id2
id2.1
end
id3
id4
`,
{}
);
});
it('BL4: should align block widths and handle colums statements in deeper sub-blocks then 1 level', () => {
imgSnapshotTest(
`block-beta
columns 1
block
columns 1
block
columns 3
id1
id2
id2.1(("XYZ"))
end
id48
end
id3
`,
{}
);
});
it('BL5: should align block widths and handle colums statements in deeper sub-blocks then 1 level (alt)', () => {
imgSnapshotTest(
`block-beta
columns 1
block
id1
id2
block
columns 1
id3("Wider then")
id5(("id5"))
end
end
id4
`,
{}
);
});
it('BL6: should handle block arrows and spece statements', () => {
imgSnapshotTest(
`block-beta
columns 3
space:3
ida idb idc
id1 id2
blockArrowId<["Label"]>(right)
blockArrowId2<["Label"]>(left)
blockArrowId3<["Label"]>(up)
blockArrowId4<["Label"]>(down)
blockArrowId5<["Label"]>(x)
blockArrowId6<["Label"]>(y)
blockArrowId6<["Label"]>(x, down)
`,
{}
);
});
it('BL7: should handle different types of edges', () => {
imgSnapshotTest(
`block-beta
columns 3
A space:5
A --o B
A --> C
A --x D
`,
{}
);
});
it('BL8: should handle sub-blocks without columns statements', () => {
imgSnapshotTest(
`block-beta
columns 2
C A B
block
D
E
end
`,
{}
);
});
it('BL9: should handle edges from blocks in sub blocks to other blocks', () => {
imgSnapshotTest(
`block-beta
columns 3
B space
block
D
end
D --> B
`,
{}
);
});
it('BL10: should handle edges from composite blocks', () => {
imgSnapshotTest(
`block-beta
columns 3
B space
block BL
D
end
BL --> B
`,
{}
);
});
it('BL11: should handle edges to composite blocks', () => {
imgSnapshotTest(
`block-beta
columns 3
B space
block BL
D
end
B --> BL
`,
{}
);
});
it('BL12: edges should handle labels', () => {
imgSnapshotTest(
`block-beta
A
space
A -- "apa" --> E
`,
{}
);
});
it('BL13: should handle block arrows in different directions', () => {
imgSnapshotTest(
`block-beta
columns 3
space blockArrowId1<["down"]>(down) space
blockArrowId2<["right"]>(right) blockArrowId3<["Sync"]>(x, y) blockArrowId4<["left"]>(left)
space blockArrowId5<["up"]>(up) space
blockArrowId6<["x"]>(x) space blockArrowId7<["y"]>(y)
`,
{}
);
});
it('BL14: should style statements and class statements', () => {
imgSnapshotTest(
`block-beta
A
B
classDef blue fill:#66f,stroke:#333,stroke-width:2px;
class A blue
style B fill:#f9F,stroke:#333,stroke-width:4px
`,
{}
);
});
it('BL15: width alignment - D and E should share available space', () => {
imgSnapshotTest(
`block-beta
block
D
E
end
db("This is the text in the box")
`,
{}
);
});
it('BL16: width alignment - C should be as wide as the composite block', () => {
imgSnapshotTest(
`block-beta
block
A("This is the text")
B
end
C
`,
{}
);
});
it('BL16: width alignment - blocks shold be equal in width', () => {
imgSnapshotTest(
`block-beta
A("This is the text")
B
C
`,
{}
);
});
it('BL17: block types 1 - square, rounded and circle', () => {
imgSnapshotTest(
`block-beta
A["square"]
B("rounded")
C(("circle"))
`,
{}
);
});
it('BL18: block types 2 - odd, diamond and hexagon', () => {
imgSnapshotTest(
`block-beta
A>"rect_left_inv_arrow"]
B{"diamond"}
C{{"hexagon"}}
`,
{}
);
});
it('BL19: block types 3 - stadium', () => {
imgSnapshotTest(
`block-beta
A(["stadium"])
`,
{}
);
});
it('BL20: block types 4 - lean right, lean left, trapezoid and inv trapezoid', () => {
imgSnapshotTest(
`block-beta
A[/"lean right"/]
B[\"lean left"\]
C[/"trapezoid"\]
D[\"trapezoid alt"/]
`,
{}
);
});
it('BL21: block types 1 - square, rounded and circle', () => {
imgSnapshotTest(
`block-beta
A["square"]
B("rounded")
C(("circle"))
`,
{}
);
});
it('BL22: sizing - it should be possible to make a block wider', () => {
imgSnapshotTest(
`block-beta
A("rounded"):2
B:2
C
`,
{}
);
});
it('BL23: sizing - it should be possible to make a composite block wider', () => {
imgSnapshotTest(
`block-beta
block:2
A
end
B
`,
{}
);
});
it('BL24: block in the middle with space on each side', () => {
imgSnapshotTest(
`block-beta
columns 3
space
middle["In the middle"]
space
`,
{}
);
});
it('BL25: space and an edge', () => {
imgSnapshotTest(
`block-beta
columns 5
A space B
A --x B
`,
{}
);
});
it('BL26: block sizes for regular blocks', () => {
imgSnapshotTest(
`block-beta
columns 3
a["A wide one"] b:2 c:2 d
`,
{}
);
});
it('BL27: composite block with a set width - f should use the available space', () => {
imgSnapshotTest(
`block-beta
columns 3
a:3
block:e:3
f
end
g
`,
{}
);
});
it('BL23: composite block with a set width - f and g should split the available space', () => {
imgSnapshotTest(
`block-beta
columns 3
a:3
block:e:3
f
g
end
h
i
j
`,
{}
);
});
});

View File

@@ -571,4 +571,14 @@ class C13["With Città foreign language"]
{ logLevel: 1, flowchart: { htmlLabels: false } }
);
});
it('should render a simple class diagram with style definition', () => {
imgSnapshotTest(
`
classDiagram-v2
class Class10
style Class10 fill:#f9f,stroke:#333,stroke-width:4px
`,
{ logLevel: 1, flowchart: { htmlLabels: false } }
);
});
});

View File

@@ -501,4 +501,16 @@ describe('Class diagram', () => {
B : -methods()
`);
});
it('should handle notes with anchor tag having target attribute', () => {
renderGraph(
`classDiagram
class test { }
note for test "<a href='https://mermaid.js.org/' target="_blank"><code>note about mermaid</code></a>"`
);
cy.get('svg').then((svg) => {
cy.get('a').should('have.attr', 'target', '_blank').should('have.attr', 'rel', 'noopener');
});
});
});

View File

@@ -1,4 +1,4 @@
import { imgSnapshotTest } from '../../helpers/util.ts';
import { imgSnapshotTest, urlSnapshotTest } from '../../helpers/util.ts';
describe('Configuration and directives - nodes should be light blue', () => {
it('No config - use default', () => {
@@ -206,8 +206,7 @@ graph TD
describe('when rendering several diagrams', () => {
it('diagrams should not taint later diagrams', () => {
const url = 'http://localhost:9000/theme-directives.html';
cy.visit(url);
cy.matchImageSnapshot('conf-and-directives.spec-when-rendering-several-diagrams-diagram-1');
urlSnapshotTest(url, {});
});
});
});

View File

@@ -1,12 +0,0 @@
import { imgSnapshotTest } from '../../helpers/util.ts';
describe('Flowchart', () => {
it('34: testing the label width in percy', () => {
imgSnapshotTest(
`graph TD
A[Christmas]
`,
{ theme: 'forest', fontFamily: '"Noto Sans SC", sans-serif' }
);
});
});

View File

@@ -729,6 +729,37 @@ A ~~~ B
{}
);
});
it('5064: Should render when subgraph child has links to outside node and subgraph', () => {
imgSnapshotTest(
`flowchart TB
Out --> In
subgraph Sub
In
end
Sub --> In`
);
});
it('5059: Should render when subgraph contains only subgraphs, has link to outside and itself is part of a link', () => {
imgSnapshotTest(
`flowchart
subgraph Main
subgraph Child1
Node1
Node2
end
subgraph Child2
Node3
Node4
end
end
Main --> Out1
Child2 --> Out2`
);
});
describe('Markdown strings flowchart (#4220)', () => {
describe('html labels', () => {
it('With styling and classes', () => {
@@ -874,4 +905,93 @@ end
});
});
});
describe('Subgraph title margins', () => {
it('Should render subgraphs with title margins set (LR)', () => {
imgSnapshotTest(
`flowchart LR
subgraph TOP
direction TB
subgraph B1
direction RL
i1 -->f1
end
subgraph B2
direction BT
i2 -->f2
end
end
A --> TOP --> B
B1 --> B2
`,
{ flowchart: { subGraphTitleMargin: { top: 10, bottom: 5 } } }
);
});
it('Should render subgraphs with title margins set (TD)', () => {
imgSnapshotTest(
`flowchart TD
subgraph TOP
direction LR
subgraph B1
direction RL
i1 -->f1
end
subgraph B2
direction BT
i2 -->f2
end
end
A --> TOP --> B
B1 --> B2
`,
{ flowchart: { subGraphTitleMargin: { top: 8, bottom: 16 } } }
);
});
it('Should render subgraphs with title margins set (LR) and htmlLabels set to false', () => {
imgSnapshotTest(
`flowchart LR
subgraph TOP
direction TB
subgraph B1
direction RL
i1 -->f1
end
subgraph B2
direction BT
i2 -->f2
end
end
A --> TOP --> B
B1 --> B2
`,
{
htmlLabels: false,
flowchart: { htmlLabels: false, subGraphTitleMargin: { top: 10, bottom: 5 } },
}
);
});
it('Should render subgraphs with title margins and edge labels', () => {
imgSnapshotTest(
`flowchart LR
subgraph TOP
direction TB
subgraph B1
direction RL
i1 --lb1-->f1
end
subgraph B2
direction BT
i2 --lb2-->f2
end
end
A --lb3--> TOP --lb4--> B
B1 --lb5--> B2
`,
{ flowchart: { subGraphTitleMargin: { top: 10, bottom: 5 } } }
);
});
});
});

View File

@@ -245,7 +245,10 @@ describe('Gantt diagram', () => {
const style = svg.attr('style');
expect(style).to.match(/^max-width: [\d.]+px;$/);
const maxWidthValue = parseFloat(style.match(/[\d.]+/g).join(''));
expect(maxWidthValue).to.be.within(984 * 0.95, 984 * 1.05);
expect(maxWidthValue).to.be.within(
Cypress.config().viewportWidth * 0.95,
Cypress.config().viewportWidth * 1.05
);
});
});
@@ -285,11 +288,11 @@ describe('Gantt diagram', () => {
{ gantt: { useMaxWidth: false } }
);
cy.get('svg').should((svg) => {
// const height = parseFloat(svg.attr('height'));
const width = parseFloat(svg.attr('width'));
// use within because the absolute value can be slightly different depending on the environment ±5%
// expect(height).to.be.within(484 * 0.95, 484 * 1.05);
expect(width).to.be.within(984 * 0.95, 984 * 1.05);
expect(width).to.be.within(
Cypress.config().viewportWidth * 0.95,
Cypress.config().viewportWidth * 1.05
);
expect(svg).to.not.have.attr('style');
});
});
@@ -520,7 +523,15 @@ describe('Gantt diagram', () => {
);
});
it('should render a gantt diagram with very large intervals, skipping excludes if interval > 5 years', () => {
// TODO: fix it
//
// This test is skipped deliberately
// because it fails and blocks our development pipeline
// It was added as an attempt to fix gantt performance issues
//
// https://github.com/mermaid-js/mermaid/issues/3274
//
it.skip('should render a gantt diagram with very large intervals, skipping excludes if interval > 5 years', () => {
imgSnapshotTest(
`gantt
title A long Gantt Diagram
@@ -528,7 +539,6 @@ describe('Gantt diagram', () => {
axisFormat %m-%d
tickInterval 1day
excludes weekends
section Section
A task : a1, 9999-10-01, 30d
Another task : after a1, 20d
@@ -573,4 +583,106 @@ describe('Gantt diagram', () => {
{}
);
});
it("should render when there's a semicolon in the title", () => {
imgSnapshotTest(
`
gantt
title ;Gantt With a Semicolon in the Title
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
it("should render when there's a semicolon in a section is true", () => {
imgSnapshotTest(
`
gantt
title Gantt Digram
dateFormat YYYY-MM-DD
section ;Section With a Semicolon
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
it("should render when there's a semicolon in the task data", () => {
imgSnapshotTest(
`
gantt
title Gantt Digram
dateFormat YYYY-MM-DD
section Section
;A task with a semiclon :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
it("should render when there's a hashtag in the title", () => {
imgSnapshotTest(
`
gantt
title #Gantt With a Hashtag in the Title
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
it("should render when there's a hashtag in a section is true", () => {
imgSnapshotTest(
`
gantt
title Gantt Digram
dateFormat YYYY-MM-DD
section #Section With a Hashtag
A task :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
it("should render when there's a hashtag in the task data", () => {
imgSnapshotTest(
`
gantt
title Gantt Digram
dateFormat YYYY-MM-DD
section Section
#A task with a hashtag :a1, 2014-01-01, 30d
Another task :after a1 , 20d
section Another
Task in sec :2014-01-12 , 12d
another task : 24d
`,
{}
);
});
});

View File

@@ -26,7 +26,7 @@ describe('Git Graph diagram', () => {
`gitGraph
commit id: "Normal Commit"
commit id: "Reverse Commit" type: REVERSE
commit id: "Hightlight Commit" type: HIGHLIGHT
commit id: "Highlight Commit" type: HIGHLIGHT
`,
{}
);
@@ -36,7 +36,7 @@ describe('Git Graph diagram', () => {
`gitGraph
commit id: "Normal Commit with tag" tag: "v1.0.0"
commit id: "Reverse Commit with tag" type: REVERSE tag: "RC_1"
commit id: "Hightlight Commit" type: HIGHLIGHT tag: "8.8.4"
commit id: "Highlight Commit" type: HIGHLIGHT tag: "8.8.4"
`,
{}
);
@@ -102,7 +102,7 @@ describe('Git Graph diagram', () => {
{}
);
});
it('8: should render a simple gitgraph with more than 8 branchs & overriding variables', () => {
it('8: should render a simple gitgraph with more than 8 branches & overriding variables', () => {
imgSnapshotTest(
`%%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
'gitBranchLabel0': '#ffffff',
@@ -358,7 +358,7 @@ gitGraph
`gitGraph TB:
commit id: "Normal Commit"
commit id: "Reverse Commit" type: REVERSE
commit id: "Hightlight Commit" type: HIGHLIGHT
commit id: "Highlight Commit" type: HIGHLIGHT
`,
{}
);
@@ -368,7 +368,7 @@ gitGraph
`gitGraph TB:
commit id: "Normal Commit with tag" tag: "v1.0.0"
commit id: "Reverse Commit with tag" type: REVERSE tag: "RC_1"
commit id: "Hightlight Commit" type: HIGHLIGHT tag: "8.8.4"
commit id: "Highlight Commit" type: HIGHLIGHT tag: "8.8.4"
`,
{}
);
@@ -434,7 +434,7 @@ gitGraph
{}
);
});
it('22: should render a simple gitgraph with more than 8 branchs & overriding variables | Vertical Branch', () => {
it('22: should render a simple gitgraph with more than 8 branches & overriding variables | Vertical Branch', () => {
imgSnapshotTest(
`%%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
'gitBranchLabel0': '#ffffff',
@@ -701,4 +701,246 @@ gitGraph TB:
{}
);
});
it('34: should render a simple gitgraph with two branches from same commit', () => {
imgSnapshotTest(
`gitGraph
commit id:"1-abcdefg"
commit id:"2-abcdefg"
branch feature-001
commit id:"3-abcdefg"
commit id:"4-abcdefg"
checkout main
branch feature-002
commit id:"5-abcdefg"
checkout feature-001
merge feature-002
`,
{}
);
});
it('35: should render a simple gitgraph with two branches from same commit | Vertical Branch', () => {
imgSnapshotTest(
`gitGraph TB:
commit id:"1-abcdefg"
commit id:"2-abcdefg"
branch feature-001
commit id:"3-abcdefg"
commit id:"4-abcdefg"
checkout main
branch feature-002
commit id:"5-abcdefg"
checkout feature-001
merge feature-002
`,
{}
);
});
it('36: should render GitGraph with branch that is not used immediately', () => {
imgSnapshotTest(
`gitGraph LR:
commit id:"1-abcdefg"
branch x
checkout main
commit id:"2-abcdefg"
checkout x
commit id:"3-abcdefg"
checkout main
merge x
`,
{}
);
});
it('37: should render GitGraph with branch that is not used immediately | Vertical Branch', () => {
imgSnapshotTest(
`gitGraph TB:
commit id:"1-abcdefg"
branch x
checkout main
commit id:"2-abcdefg"
checkout x
commit id:"3-abcdefg"
checkout main
merge x
`,
{}
);
});
it('38: should render GitGraph with branch and sub-branch neither of which used immediately', () => {
imgSnapshotTest(
`gitGraph LR:
commit id:"1-abcdefg"
branch x
checkout main
commit id:"2-abcdefg"
checkout x
commit id:"3-abcdefg"
checkout main
merge x
checkout x
branch y
checkout x
commit id:"4-abcdefg"
checkout y
commit id:"5-abcdefg"
checkout x
merge y
`,
{}
);
});
it('39: should render GitGraph with branch and sub-branch neither of which used immediately | Vertical Branch', () => {
imgSnapshotTest(
`gitGraph TB:
commit id:"1-abcdefg"
branch x
checkout main
commit id:"2-abcdefg"
checkout x
commit id:"3-abcdefg"
checkout main
merge x
checkout x
branch y
checkout x
commit id:"4-abcdefg"
checkout y
commit id:"5-abcdefg"
checkout x
merge y
`,
{}
);
});
it('40: should render a simple gitgraph with cherry pick merge commit', () => {
imgSnapshotTest(
`gitGraph
commit id: "ZERO"
branch feature
branch release
checkout feature
commit id: "A"
commit id: "B"
checkout main
merge feature id: "M"
checkout release
cherry-pick id: "M" parent:"B"`
);
});
it('41: should render default GitGraph with parallelCommits set to false', () => {
imgSnapshotTest(
`gitGraph
commit id:"1-abcdefg"
commit id:"2-abcdefg"
branch develop
commit id:"3-abcdefg"
commit id:"4-abcdefg"
checkout main
branch feature
commit id:"5-abcdefg"
commit id:"6-abcdefg"
checkout main
commit id:"7-abcdefg"
commit id:"8-abcdefg"
`,
{ gitGraph: { parallelCommits: false } }
);
});
it('42: should render GitGraph with parallel commits', () => {
imgSnapshotTest(
`gitGraph
commit id:"1-abcdefg"
commit id:"2-abcdefg"
branch develop
commit id:"3-abcdefg"
commit id:"4-abcdefg"
checkout main
branch feature
commit id:"5-abcdefg"
commit id:"6-abcdefg"
checkout main
commit id:"7-abcdefg"
commit id:"8-abcdefg"
`,
{ gitGraph: { parallelCommits: true } }
);
});
it('43: should render GitGraph with parallel commits | Vertical Branch', () => {
imgSnapshotTest(
`gitGraph TB:
commit id:"1-abcdefg"
commit id:"2-abcdefg"
branch develop
commit id:"3-abcdefg"
commit id:"4-abcdefg"
checkout main
branch feature
commit id:"5-abcdefg"
commit id:"6-abcdefg"
checkout main
commit id:"7-abcdefg"
commit id:"8-abcdefg"
`,
{ gitGraph: { parallelCommits: true } }
);
});
it('44: should render GitGraph with unconnected branches and no parallel commits', () => {
imgSnapshotTest(
`gitGraph
branch dev
branch v2
branch feat
commit id:"1-abcdefg"
commit id:"2-abcdefg"
checkout main
commit id:"3-abcdefg"
checkout dev
commit id:"4-abcdefg"
checkout v2
commit id:"5-abcdefg"
checkout main
commit id:"6-abcdefg"
`,
{ gitGraph: { parallelCommits: false } }
);
});
it('45: should render GitGraph with unconnected branches and parallel commits', () => {
imgSnapshotTest(
`gitGraph
branch dev
branch v2
branch feat
commit id:"1-abcdefg"
commit id:"2-abcdefg"
checkout main
commit id:"3-abcdefg"
checkout dev
commit id:"4-abcdefg"
checkout v2
commit id:"5-abcdefg"
checkout main
commit id:"6-abcdefg"
`,
{ gitGraph: { parallelCommits: true } }
);
});
it('46: should render GitGraph with unconnected branches and parallel commits | Vertical Branch', () => {
imgSnapshotTest(
`gitGraph TB:
branch dev
branch v2
branch feat
commit id:"1-abcdefg"
commit id:"2-abcdefg"
checkout main
commit id:"3-abcdefg"
checkout dev
commit id:"4-abcdefg"
checkout v2
commit id:"5-abcdefg"
checkout main
commit id:"6-abcdefg"
`,
{ gitGraph: { parallelCommits: true } }
);
});
});

View File

@@ -44,7 +44,7 @@ describe('pie chart', () => {
const style = svg.attr('style');
expect(style).to.match(/^max-width: [\d.]+px;$/);
const maxWidthValue = parseFloat(style.match(/[\d.]+/g).join(''));
expect(maxWidthValue).to.eq(984);
expect(maxWidthValue).to.be.within(590, 600); // depends on installed fonts: 596.2 on my PC, 597.5 on CI
});
});
@@ -59,7 +59,7 @@ describe('pie chart', () => {
);
cy.get('svg').should((svg) => {
const width = parseFloat(svg.attr('width'));
expect(width).to.eq(984);
expect(width).to.be.within(590, 600); // depends on installed fonts: 596.2 on my PC, 597.5 on CI
expect(svg).to.not.have.attr('style');
});
});

View File

@@ -160,4 +160,70 @@ describe('Quadrant Chart', () => {
);
cy.get('svg');
});
it('should render x-axis labels in the center, if x-axis has two labels', () => {
imgSnapshotTest(
`
quadrantChart
title Reach and engagement of campaigns
x-axis Low Reach --> High Reach
y-axis Low Engagement
quadrant-1 We should expand
quadrant-2 Need to promote
quadrant-3 Re-evaluate
quadrant-4 May be improved
Campaign A: [0.3, 0.6]
Campaign B: [0.45, 0.23]
Campaign C: [0.57, 0.69]
Campaign D: [0.78, 0.34]
Campaign E: [0.40, 0.34]
Campaign F: [0.35, 0.78]
`,
{}
);
cy.get('svg');
});
it('should render y-axis labels in the center, if y-axis has two labels', () => {
imgSnapshotTest(
`
quadrantChart
title Reach and engagement of campaigns
x-axis Low Reach
y-axis Low Engagement --> High Engagement
quadrant-1 We should expand
quadrant-2 Need to promote
quadrant-3 Re-evaluate
quadrant-4 May be improved
Campaign A: [0.3, 0.6]
Campaign B: [0.45, 0.23]
Campaign C: [0.57, 0.69]
Campaign D: [0.78, 0.34]
Campaign E: [0.40, 0.34]
Campaign F: [0.35, 0.78]
`,
{}
);
cy.get('svg');
});
it('should render both axes labels on the left and bottom, if both axes have only one label', () => {
imgSnapshotTest(
`
quadrantChart
title Reach and engagement of campaigns
x-axis Reach -->
y-axis Engagement -->
quadrant-1 We should expand
quadrant-2 Need to promote
quadrant-3 Re-evaluate
quadrant-4 May be improved
Campaign A: [0.3, 0.6]
Campaign B: [0.45, 0.23]
Campaign C: [0.57, 0.69]
Campaign D: [0.78, 0.34]
Campaign E: [0.40, 0.34]
Campaign F: [0.35, 0.78]
`,
{}
);
cy.get('svg');
});
});

View File

@@ -375,6 +375,26 @@ context('Sequence diagram', () => {
{}
);
});
it('should have actor-top and actor-bottom classes on top and bottom actor box and symbol', () => {
imgSnapshotTest(
`
sequenceDiagram
actor Bob
Alice->>Bob: Hi Bob
Bob->>Alice: Hi Alice
`,
{}
);
cy.get('.actor').should('have.class', 'actor-top');
cy.get('.actor-man').should('have.class', 'actor-top');
cy.get('.actor.actor-top').should('not.have.class', 'actor-bottom');
cy.get('.actor-man.actor-top').should('not.have.class', 'actor-bottom');
cy.get('.actor').should('have.class', 'actor-bottom');
cy.get('.actor-man').should('have.class', 'actor-bottom');
cy.get('.actor.actor-bottom').should('not.have.class', 'actor-top');
cy.get('.actor-man.actor-bottom').should('not.have.class', 'actor-top');
});
it('should render long notes left of actor', () => {
imgSnapshotTest(
`
@@ -792,6 +812,34 @@ context('Sequence diagram', () => {
});
});
context('links', () => {
it('should support actor links', () => {
renderGraph(
`
sequenceDiagram
link Alice: Dashboard @ https://dashboard.contoso.com/alice
link Alice: Wiki @ https://wiki.contoso.com/alice
link John: Dashboard @ https://dashboard.contoso.com/john
link John: Wiki @ https://wiki.contoso.com/john
Alice->>John: Hello John<br/>
John-->>Alice: Great<br/><br/>day!
`,
{ securityLevel: 'loose' }
);
cy.get('#actor0_popup').should((popupMenu) => {
const style = popupMenu.attr('style');
expect(style).to.undefined;
});
cy.get('#root-0').click();
cy.get('#actor0_popup').should((popupMenu) => {
const style = popupMenu.attr('style');
expect(style).to.match(/^display: block;$/);
});
cy.get('#root-0').click();
cy.get('#actor0_popup').should((popupMenu) => {
const style = popupMenu.attr('style');
expect(style).to.match(/^display: none;$/);
});
});
it('should support actor links and properties EXPERIMENTAL: USE WITH CAUTION', () => {
//Be aware that the syntax for "properties" is likely to be changed.
imgSnapshotTest(
@@ -930,4 +978,36 @@ context('Sequence diagram', () => {
});
});
});
context('render after error', () => {
it('should render diagram after fixing destroy participant error', () => {
cy.on('uncaught:exception', (err) => {
return false;
});
renderGraph([
`sequenceDiagram
Alice->>Bob: Hello Bob, how are you ?
Bob->>Alice: Fine, thank you. And you?
create participant Carl
Alice->>Carl: Hi Carl!
create actor D as Donald
Carl->>D: Hi!
destroy Carl
Alice-xCarl: We are too many
destroy Bo
Bob->>Alice: I agree`,
`sequenceDiagram
Alice->>Bob: Hello Bob, how are you ?
Bob->>Alice: Fine, thank you. And you?
create participant Carl
Alice->>Carl: Hi Carl!
create actor D as Donald
Carl->>D: Hi!
destroy Carl
Alice-xCarl: We are too many
destroy Bob
Bob->>Alice: I agree`,
]);
});
});
});

View File

@@ -57,7 +57,7 @@ describe('Timeline diagram', () => {
{}
);
});
it('5: should render a simple timeline with directive overriden colors', () => {
it('5: should render a simple timeline with directive overridden colors', () => {
imgSnapshotTest(
` %%{init: { 'logLevel': 'debug', 'theme': 'default' , 'themeVariables': {
'cScale0': '#ff0000',

View File

@@ -0,0 +1,322 @@
import { imgSnapshotTest, renderGraph } from '../../helpers/util.ts';
describe('XY Chart', () => {
it('should render the simplest possible chart', () => {
imgSnapshotTest(
`
xychart-beta
line [10, 30, 20]
`,
{}
);
cy.get('svg');
});
it('Should render a complete chart', () => {
imgSnapshotTest(
`
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
});
it('Should render a chart without title', () => {
imgSnapshotTest(
`
xychart-beta
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('y-axis title not required', () => {
imgSnapshotTest(
`
xychart-beta
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Should render a chart without y-axis with different range', () => {
imgSnapshotTest(
`
xychart-beta
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
bar [5000, 6000, 7500, 8200, 9500, 10500, 14000, 3200, 9200, 9900, 3400, 6000]
line [2000, 7000, 6500, 9200, 9500, 7500, 11000, 10200, 3200, 8500, 7000, 8800]
`,
{}
);
cy.get('svg');
});
it('x axis title not required', () => {
imgSnapshotTest(
`
xychart-beta
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
bar [5000, 6000, 7500, 8200, 9500, 10500, 14000, 3200, 9200, 9900, 3400, 6000]
line [2000, 7000, 6500, 9200, 9500, 7500, 11000, 10200, 3200, 8500, 7000, 8800]
`,
{}
);
cy.get('svg');
});
it('Multiple plots can be rendered', () => {
imgSnapshotTest(
`
xychart-beta
line [23, 46, 77, 34]
line [45, 32, 33, 12]
bar [87, 54, 99, 85]
line [78, 88, 22, 4]
line [22, 29, 75, 33]
bar [52, 96, 35, 10]
`,
{}
);
cy.get('svg');
});
it('Decimals and negative numbers are supported', () => {
imgSnapshotTest(
`
xychart-beta
y-axis -2.4 --> 3.5
line [+1.3, .6, 2.4, -.34]
`,
{}
);
cy.get('svg');
});
it('Render spark line with "plotReservedSpacePercent"', () => {
imgSnapshotTest(
`
---
config:
theme: dark
xyChart:
width: 200
height: 20
plotReservedSpacePercent: 100
---
xychart-beta
line [5000, 9000, 7500, 6200, 9500, 5500, 11000, 8200, 9200, 9500, 7000, 8800]
`,
{}
);
cy.get('svg');
});
it('Render spark bar without displaying other property', () => {
imgSnapshotTest(
`
---
config:
theme: dark
xyChart:
width: 200
height: 20
xAxis:
showLabel: false
showTitle: false
showTick: false
showAxisLine: false
yAxis:
showLabel: false
showTitle: false
showTick: false
showAxisLine: false
---
xychart-beta
bar [5000, 9000, 7500, 6200, 9500, 5500, 11000, 8200, 9200, 9500, 7000, 8800]
`,
{}
);
cy.get('svg');
});
it('Should use all the config from directive', () => {
imgSnapshotTest(
`
%%{init: {"xyChart": {"width": 1000, "height": 600, "titlePadding": 5, "titleFontSize": 10, "xAxis": {"labelFontSize": "20", "labelPadding": 10, "titleFontSize": 30, "titlePadding": 20, "tickLength": 10, "tickWidth": 5}, "yAxis": {"labelFontSize": "20", "labelPadding": 10, "titleFontSize": 30, "titlePadding": 20, "tickLength": 10, "tickWidth": 5}, "plotBorderWidth": 5, "chartOrientation": "horizontal", "plotReservedSpacePercent": 60 }}}%%
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Should use all the config from yaml', () => {
imgSnapshotTest(
`
---
config:
theme: forest
xyChart:
width: 1000
height: 600
titlePadding: 5
titleFontSize: 10
xAxis:
labelFontSize: 20
labelPadding: 10
titleFontSize: 30
titlePadding: 20
tickLength: 10
tickWidth: 5
axisLineWidth: 5
yAxis:
labelFontSize: 20
labelPadding: 10
titleFontSize: 30
titlePadding: 20
tickLength: 10
tickWidth: 5
axisLineWidth: 5
chartOrientation: horizontal
plotReservedSpacePercent: 60
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Render with show axis title false', () => {
imgSnapshotTest(
`
---
config:
xyChart:
xAxis:
showTitle: false
yAxis:
showTitle: false
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Render with show axis label false', () => {
imgSnapshotTest(
`
---
config:
xyChart:
xAxis:
showLabel: false
yAxis:
showLabel: false
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Render with show axis tick false', () => {
imgSnapshotTest(
`
---
config:
xyChart:
xAxis:
showTick: false
yAxis:
showTick: false
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Render with show axis line false', () => {
imgSnapshotTest(
`
---
config:
xyChart:
xAxis:
showAxisLine: false
yAxis:
showAxisLine: false
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
it('Render all the theme color', () => {
imgSnapshotTest(
`
---
config:
themeVariables:
xyChart:
titleColor: "#ff0000"
backgroundColor: "#f0f8ff"
yAxisLabelColor: "#ee82ee"
yAxisTitleColor: "#7fffd4"
yAxisTickColor: "#87ceeb"
yAxisLineColor: "#ff6347"
xAxisLabelColor: "#7fffd4"
xAxisTitleColor: "#ee82ee"
xAxisTickColor: "#ff6347"
xAxisLineColor: "#87ceeb"
plotColorPalette: "#008000, #faba63"
---
xychart-beta
title "Sales Revenue"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
`,
{}
);
cy.get('svg');
});
});

File diff suppressed because one or more lines are too long

View File

@@ -17,24 +17,30 @@
<style>
body {
/* background: rgb(221, 208, 208); */
/* background:#333; */
background: #333;
font-family: 'Arial';
/* font-size: 18px !important; */
}
h1 {
color: grey;
}
.mermaid {
border: 1px solid #ddd;
margin: 10px;
}
.mermaid2 {
display: none;
}
.mermaid svg {
/* font-size: 18px !important; */
background-color: #efefef;
background-image: radial-gradient(#fff 51%, transparent 91%),
radial-gradient(#fff 51%, transparent 91%);
/* background-color: #efefef; */
background-color: #333;
background-image: radial-gradient(#333 51%, transparent 91%),
radial-gradient(#333 51%, transparent 91%);
background-size: 20px 20px;
background-position: 0 0, 10px 10px;
background-repeat: repeat;
border: 2px solid rgb(131, 142, 205);
}
.malware {
position: fixed;
@@ -58,37 +64,192 @@
</head>
<body>
<pre id="diagram" class="mermaid">
flowchart-elk LR
subgraph example
node
end
block-beta
blockArrowId<["Label"]>(right)
blockArrowId2<["Label"]>(left)
blockArrowId3<["Label"]>(up)
blockArrowId4<["Label"]>(down)
blockArrowId5<["Label"]>(x)
blockArrowId6<["Label"]>(y)
blockArrowId6<["Label"]>(x, down)
</pre>
<pre id="diagram" class="mermaid">
block-beta
block:e:4
columns 2
f
g
end
</pre>
<pre id="diagram" class="mermaid">
block-beta
block:e:4
columns 2
f
g
h
end
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 4
a b c d
block:e:4
columns 2
f
g
h
end
i:4
</pre>
<pre id="diagram" class="mermaid2">
flowchart
Node1:::class1 --> Node2:::class2
Node1:::class1 --> Node3:::class2
Node3 --> Node4((I am a circle)):::larger
classDef class1 fill:lightblue
classDef class2 fill:pink
classDef larger font-size:30px,fill:yellow
</pre
>
flowchart LR
X-- "y" -->z
</pre>
<pre id="diagram" class="mermaid2">
stateDiagram-v2
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*] </pre
>
block-beta
columns 5
A space B
A --x B
</pre>
<pre id="diagram" class="mermaid2">
block-beta
columns 3
a["A wide one"] b:2 c:2 d
</pre>
<pre id="diagram" class="mermaid2">
block-beta
block:e
f
end
</pre>
<pre id="diagram" class="mermaid2">
block-beta
columns 3
a:3
block:e:3
f
end
g
</pre>
<pre id="diagram" class="mermaid2">
block-beta
columns 3
a:3
block:e:3
f
g
end
h
i
j
</pre>
<pre id="diagram" class="mermaid2">
block-beta
columns 3
a b:2
block:e:3
f
end
g h i
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 3
a b c
e:3
f g h
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 1
db(("DB"))
blockArrowId6<["&nbsp;&nbsp;&nbsp;"]>(down)
block:ID
A
B["A wide one in the middle"]
C
end
space
D
ID --> D
C --> D
style B fill:#f9F,stroke:#333,stroke-width:4px
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 5
A1:3
A2:1
A3
B1 B2 B3:3
</pre>
<pre id="diagram" class="mermaid2">
block-beta
block
D
E
end
db("This is the text in the box")
</pre>
<pre id="diagram" class="mermaid2">
block-beta
block
D
end
A["A: I am a wide one"]
</pre>
<pre id="diagram" class="mermaid2">
block-beta
A["square"]
B("rounded")
C(("circle"))
</pre>
<pre id="diagram" class="mermaid2">
block-beta
A>"rect_left_inv_arrow"]
B{"diamond"}
C{{"hexagon"}}
</pre>
<pre id="diagram" class="mermaid2">
block-beta
A(["stadium"])
</pre>
<pre id="diagram" class="mermaid2">
block-beta
%% A[["subroutine"]]
%% B[("cylinder")]
C>"surprise"]
</pre>
<pre id="diagram" class="mermaid2">
block-beta
A[/"lean right"/]
B[\"lean left"\]
C[/"trapezoid"\]
D[\"trapezoid"/]
</pre>
<pre id="diagram" class="mermaid2">
flowchart
B
style B fill:#f9F,stroke:#333,stroke-width:4px
</pre>
<pre id="diagram" class="mermaid2">
flowchart LR
a1 -- apa --> b1
</pre>
<pre id="diagram" class="mermaid2">
flowchart RL
subgraph "`one`"
a1 -- l1 --> a2
a1 -- l2 --> a2
end
subgraph "`one`"
id
end
</pre>
<pre id="diagram" class="mermaid2">
flowchart RL
@@ -433,14 +594,9 @@ mindmap
// useMaxWidth: false,
// });
mermaid.initialize({
flowchart: { titleTopMargin: 10 },
fontFamily: 'courier',
sequence: {
actorFontFamily: 'courier',
noteFontFamily: 'courier',
messageFontFamily: 'courier',
},
fontSize: 16,
theme: 'dark',
startOnLoad: true,
logLevel: 0,
});
function callback() {
alert('It worked');

View File

@@ -42,7 +42,8 @@
</pre>
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.initialize({ startOnLoad: true, logLevel: 0 });
mermaid.initialize({ startOnLoad: false, logLevel: 0 });
await mermaid.run();
if (window.Cypress) {
window.rendered = true;

View File

@@ -1,15 +1,6 @@
<html>
<head>
<link href="https://fonts.googleapis.com/css?family=Montserrat&display=swap" rel="stylesheet" />
<link href="https://unpkg.com/tailwindcss@^1.0/dist/tailwind.min.css" rel="stylesheet" />
<link
rel="stylesheet"
href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/4.7.0/css/font-awesome.min.css"
/>
<link
href="https://fonts.googleapis.com/css?family=Noto+Sans+SC&display=swap"
rel="stylesheet"
/>
<style>
body {
/* background: rgb(221, 208, 208); */
@@ -122,26 +113,21 @@
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.parseError = function (err, hash) {
// console.error('Mermaid error: ', err);
};
mermaid.initialize({
// theme: 'dark',
// theme: 'dark',
// arrowMarkerAbsolute: true,
// themeCSS: '.edgePath .path {stroke: red;} .arrowheadPath {fill: red;}',
logLevel: 0,
// flowchart: { useMaxWidth: true },
graph: { curve: 'cardinal', htmlLabels: false },
// gantt: { axisFormat: '%m/%d/%Y' },
sequence: { actorMargin: 50, showSequenceNumbers: true },
// sequenceDiagram: { actorMargin: 300 } // deprecated
fontFamily: '"arial", sans-serif',
curve: 'cardinal',
securityLevel: 'strict',
startOnLoad: false,
});
function callback() {
alert('It worked');
await mermaid.run();
if (window.Cypress) {
window.rendered = true;
}
</script>
</body>

View File

@@ -24,8 +24,18 @@
// -- This is will overwrite an existing command --
// Cypress.Commands.overwrite("visit", (originalFn, url, options) => { ... })
// import '@percy/cypress';
import { addMatchImageSnapshotCommand } from 'cypress-image-snapshot/command';
// The SSIM comparison method can be used if the pixelmatch is throwing lots of false positives.
// SSIM actually does not catch minute changes in the image, so it is not as accurate as pixelmatch.
// addMatchImageSnapshotCommand({
// comparisonMethod: 'ssim',
// failureThreshold: 0.01,
// failureThresholdType: 'percent',
// customDiffConfig: {
// ssim: 'fast',
// },
// blur: 1,
// });
addMatchImageSnapshotCommand();

139
demos/block.html Normal file
View File

@@ -0,0 +1,139 @@
<!DOCTYPE html>
<html lang="en" xmlns="http://www.w3.org/1999/html">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Mermaid Block diagram demo page</title>
<link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=" />
</head>
<body>
<h1>Block diagram demos</h1>
<pre id="diagram" class="mermaid">
block-beta
columns 1
db(("DB"))
blockArrowId6<["&nbsp;&nbsp;&nbsp;"]>(down)
block:ID
A
B["A wide one in the middle"]
C
end
space
D
ID --> D
C --> D
style B fill:#f9F,stroke:#333,stroke-width:4px
</pre>
<pre id="diagram" class="mermaid">
block-beta
A1["square"]
B1("rounded")
C1(("circle"))
A2>"rect_left_inv_arrow"]
B2{"diamond"}
C2{{"hexagon"}}
</pre>
<pre id="diagram" class="mermaid">
block-beta
A1(["stadium"])
A2[["subroutine"]]
B1[("cylinder")]
C1>"surprise"]
A3[/"lean right"/]
B2[\"lean left"\]
C2[/"trapezoid"\]
D2[\"trapezoid"/]
</pre>
<pre id="diagram" class="mermaid">
block-beta
block:e:4
columns 2
f
g
end
</pre>
<pre id="diagram" class="mermaid">
block-beta
block:e:4
columns 2
f
g
h
end
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 3
a:3
block:e:3
f
g
end
h
i
j
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 4
a b c d
block:e:4
columns 2
f
g
h
end
i:4
</pre>
<pre id="diagram" class="mermaid">
flowchart LR
X-- "a label" -->z
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 5
A space B
A --x B
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 3
a["A wide one"] b:2 c:2 d
</pre>
<pre id="diagram" class="mermaid">
block-beta
columns 3
a b c
e:3
f g h
</pre>
<pre id="diagram" class="mermaid">
block-beta
A1:3
A2:1
A3
</pre>
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.initialize({
theme: 'default',
logLevel: 3,
securityLevel: 'loose',
block: {
padding: 10,
},
});
</script>
</body>
</html>

View File

@@ -173,7 +173,7 @@
Container(mobile, "Mobile App", "Xamarin", "Provides a limited subset of the Internet Banking functionality to customers via their mobile device.")
}
Deployment_Node(comp, "Customer's computer", "Mircosoft Windows or Apple macOS"){
Deployment_Node(comp, "Customer's computer", "Microsoft Windows or Apple macOS"){
Deployment_Node(browser, "Web Browser", "Google Chrome, Mozilla Firefox,<br/> Apple Safari or Microsoft Edge"){
Container(spa, "Single Page Application", "JavaScript and Angular", "Provides all of the Internet Banking functionality to customers via their web browser.")
}

View File

@@ -22,7 +22,7 @@
---
graph LR
accTitle: This is a complicated flow
accDescr: This is the descriptoin for the complicated flow.
accDescr: This is the description for the complicated flow.
sid-B3655226-6C29-4D00-B685-3D5C734DC7E1["

View File

@@ -30,6 +30,21 @@
</pre>
<hr />
<pre class="mermaid">
gantt
title #; Gantt Diagrams Allow Semicolons and Hashtags #;!
accTitle: A simple sample gantt diagram
accDescr: 2 sections with 2 tasks each, from 2014
dateFormat YYYY-MM-DD
section #;Section
#;A task :a1, 2014-01-01, 30d
#;Another task :after a1 , 20d
section #;Another
Task in sec :2014-01-12 , 12d
another task : 24d
</pre>
<hr />
<pre class="mermaid">
gantt
title Airworks roadmap

View File

@@ -14,30 +14,364 @@
</head>
<body>
<h1>Git diagram demo</h1>
<h1>Git graph demo</h1>
<h2>Simple "branch and merge" graph</h2>
<pre class="mermaid">
---
title: Simple Git diagram
title: Simple "branch and merge" (left-to-right)
---
gitGraph:
options
{
"nodeSpacing": 50,
"nodeRadius": 5
}
end
branch master
gitGraph LR:
commit
branch newbranch
checkout newbranch
commit
checkout main
merge newbranch
</pre>
<pre class="mermaid">
---
title: Simple "branch and merge" (top-to-bottom)
---
gitGraph TB:
commit
checkout master
branch newbranch
checkout newbranch
commit
checkout main
merge newbranch
</pre>
<h2>Continuous development graph</h2>
<pre class="mermaid">
---
title: Continuous development (left-to-right)
---
gitGraph LR:
commit
branch develop
checkout develop
commit
checkout main
merge develop
checkout develop
commit
checkout main
merge develop
</pre>
<pre class="mermaid">
---
title: Continuous development (top-to-bottom)
---
gitGraph TB:
commit
branch develop
checkout develop
commit
checkout main
merge develop
checkout develop
commit
checkout main
merge develop
</pre>
<h2>Merge feature to advanced main graph</h2>
<pre class="mermaid">
---
title: Merge feature to advanced main (left-to-right)
---
gitGraph LR:
commit
branch newbranch
checkout newbranch
commit
checkout main
commit
merge newbranch
</pre>
<pre class="mermaid">
---
title: Merge feature to advanced main (top-to-bottom)
---
gitGraph TB:
commit
branch newbranch
checkout newbranch
commit
checkout main
commit
merge newbranch
</pre>
<h2>Two-way merges</h2>
<pre class="mermaid">
---
title: Two-way merges (left-to-right)
---
gitGraph LR:
commit
branch develop
checkout develop
commit
checkout main
merge develop
commit
checkout develop
merge main
commit
checkout main
merge develop
</pre>
<pre class="mermaid">
---
title: Two-way merges (top-to-bottom)
---
gitGraph TB:
commit
branch develop
checkout develop
commit
checkout main
merge develop
commit
checkout develop
merge main
commit
checkout main
merge develop
</pre>
<h2>Cherry-pick from branch graph</h2>
<pre class="mermaid">
---
title: Cherry-pick from branch (left-to-right)
---
gitGraph LR:
commit
branch newbranch
checkout newbranch
commit id: "Pick me"
checkout main
commit
checkout newbranch
commit
checkout main
cherry-pick id: "Pick me"
</pre>
<pre class="mermaid">
---
title: Cherry-pick from branch (top-to-bottom)
---
gitGraph TB:
commit
branch newbranch
checkout newbranch
commit id: "Pick me"
checkout main
commit
checkout newbranch
commit
checkout main
cherry-pick id: "Pick me"
</pre>
<h2>Cherry-pick from main graph</h2>
<pre class="mermaid">
---
title: Cherry-pick from main (left-to-right)
---
gitGraph LR:
commit
branch develop
commit
checkout main
commit id:"A"
checkout develop
commit
cherry-pick id: "A"
</pre>
<pre class="mermaid">
---
title: Cherry-pick from main (top-to-bottom)
---
gitGraph TB:
commit
branch develop
commit
checkout main
commit id:"A"
checkout develop
commit
cherry-pick id: "A"
</pre>
<h2>Cherry-pick then merge graph</h2>
<pre class="mermaid">
---
title: Cherry-pick then merge (left-to-right)
---
gitGraph LR:
commit
branch newbranch
checkout newbranch
commit id: "Pick me"
checkout main
commit
checkout newbranch
commit
checkout main
cherry-pick id: "Pick me"
merge newbranch
</pre>
<pre class="mermaid">
---
title: Cherry-pick then merge (top-to-bottom)
---
gitGraph TB:
commit
branch newbranch
checkout newbranch
commit id: "Pick me"
checkout main
commit
checkout newbranch
commit
checkout main
cherry-pick id: "Pick me"
merge newbranch
</pre>
<h2>Merge from main onto undeveloped branch graph</h2>
<pre class="mermaid">
---
title: Merge from main onto undeveloped branch (left-to-right)
---
gitGraph LR:
commit
branch develop
commit
checkout main
commit
checkout develop
merge main
</pre>
<pre class="mermaid">
---
title: Merge from main onto undeveloped branch (top-to-bottom)
---
gitGraph TB:
commit
branch develop
commit
checkout main
commit
checkout develop
merge main
</pre>
<h2>Merge from main onto developed branch graph</h2>
<pre class="mermaid">
---
title: Merge from main onto developed branch (left-to-right)
---
gitGraph LR:
commit
branch develop
commit
checkout main
commit
checkout develop
commit
merge main
</pre>
<pre class="mermaid">
---
title: Merge from main onto developed branch (top-to-bottom)
---
gitGraph TB:
commit
branch develop
commit
checkout main
commit
checkout develop
commit
merge main
</pre>
<h2>Two branches from same commit graph</h2>
<pre class="mermaid">
---
title: Two branches from same commit (left-to-right)
---
gitGraph LR:
commit
commit
branch feature-001
commit
commit
checkout main
branch feature-002
commit
checkout feature-001
merge feature-002
</pre>
<pre class="mermaid">
---
title: Two branches from same commit (top-to-bottom)
---
gitGraph TB:
commit
commit
branch feature-001
commit
commit
checkout main
branch feature-002
commit
checkout feature-001
merge feature-002
</pre>
<h2>Three branches and a cherry-pick from each graph</h2>
<pre class="mermaid">
---
title: Three branches and a cherry-pick from each (left-to-right)
---
gitGraph LR:
commit id: "ZERO"
branch develop
commit id:"A"
checkout main
commit id:"ONE"
checkout develop
commit id:"B"
branch featureA
commit id:"FIX"
commit id: "FIX-2"
checkout main
commit id:"TWO"
cherry-pick id:"A"
commit id:"THREE"
cherry-pick id:"FIX"
checkout develop
commit id:"C"
merge featureA
</pre>
<pre class="mermaid">
---
title: Three branches and a cherry-pick from each (top-to-bottom)
---
gitGraph TB:
commit id: "ZERO"
branch develop
commit id:"A"
checkout main
commit id:"ONE"
checkout develop
commit id:"B"
branch featureA
commit id:"FIX"
commit id: "FIX-2"
checkout main
commit id:"TWO"
cherry-pick id:"A"
commit id:"THREE"
cherry-pick id:"FIX"
checkout develop
commit id:"C"
merge featureA
</pre>
<script type="module">
import mermaid from './mermaid.esm.mjs';
const ALLOWED_TAGS = [

View File

@@ -60,6 +60,9 @@
<li>
<h2><a href="./quadrantchart.html">Quadrant charts</a></h2>
</li>
<li>
<h2><a href="./xychart.html">XY charts</a></h2>
</li>
<li>
<h2><a href="./requirements.html">Requirements</a></h2>
</li>
@@ -78,6 +81,9 @@
<li>
<h2><a href="./sankey.html">Sankey</a></h2>
</li>
<li>
<h2><a href="./block.html">Layered Blocks</a></h2>
</li>
</ul>
</body>
</html>

View File

@@ -15,7 +15,7 @@
<body>
<h1>Pie chart demos</h1>
<pre class="mermaid">
pie title Pets adopted by volunteers
pie title Default text position: Animal adoption
accTitle: simple pie char demo
accDescr: pie chart with 3 sections: dogs, cats, rats. Most are dogs.
"Dogs": 386
@@ -27,7 +27,7 @@
<pre class="mermaid">
%%{init: {"pie": {"textPosition": 0.9}, "themeVariables": {"pieOuterStrokeWidth": "5px"}}}%%
pie
title Key elements in Product X
title Offset labels close to border: Product X
accTitle: Key elements in Product X
accDescr: This is a pie chart showing the key elements in Product X.
"Calcium": 42.96
@@ -36,6 +36,19 @@
"Iron": 5
</pre>
<pre class="mermaid">
%%{init: {"pie": {"textPosition": 0.45}, "themeVariables": {"pieOuterStrokeWidth": "5px"}}}%%
pie
title Centralized labels: Languages
accTitle: Key elements in Product X
accDescr: This is a pie chart showing the key elements in Product X.
"JavaScript": 30
"Python": 25
"Java": 20
"C#": 15
"Others": 10
</pre>
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.initialize({

View File

@@ -17,7 +17,7 @@
<h1>Requirement diagram demos</h1>
<pre class="mermaid">
requirementDiagram
accTitle: Requirments demo in black and white
accTitle: Requirements demo in black and white
accDescr: A series of requirement boxes showing relationships among them. Has meaningless task names
requirement test_req {

View File

@@ -33,6 +33,7 @@
---
config:
sankey:
useMaxWidth: true
showValues: false
width: 1200
height: 600

View File

@@ -23,6 +23,10 @@
participant Alice
participant Bob
participant John as John<br />Second Line
link Alice: Dashboard @ https://dashboard.contoso.com/alice
link Alice: Wiki @ https://wiki.contoso.com/alice
link John: Dashboard @ https://dashboard.contoso.com/john
link John: Wiki @ https://wiki.contoso.com/john
autonumber 10 10
rect rgb(200, 220, 100)
rect rgb(200, 255, 200)
@@ -62,6 +66,26 @@
</pre>
<hr />
<pre class="mermaid">
---
title: With forced menus
config:
sequence:
forceMenus: true
---
sequenceDiagram
participant Alice
participant John
link Alice: Dashboard @ https://dashboard.contoso.com/alice
link Alice: Wiki @ https://wiki.contoso.com/alice
link John: Dashboard @ https://dashboard.contoso.com/john
link John: Wiki @ https://wiki.contoso.com/john
Alice->>John: Hello John, how are you?
John-->>Alice: Great!
Alice-)John: See you later!
</pre
>
<hr />
<pre class="mermaid">
sequenceDiagram
accTitle: Sequence diagram title is here
accDescr: Hello friends

View File

@@ -183,7 +183,7 @@
</pre>
<hr />
<h2>Compsite states can link to themselves</h2>
<h2>Composite states can link to themselves</h2>
<pre class="mermaid">
stateDiagram-v2
state Active {
@@ -199,7 +199,7 @@
stateDiagram-v2
[*] --> S1
S1 --> S2: This long line uses a br tag<br />to create multiple<br />lines.
S1 --> S3: This transition descripton uses \na newline character\nto create multiple\nlines.
S1 --> S3: This transition description uses \na newline character\nto create multiple\nlines.
</pre>
<hr />

184
demos/xychart.html Normal file
View File

@@ -0,0 +1,184 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8" />
<meta http-equiv="X-UA-Compatible" content="IE=edge" />
<title>Mermaid Quick Test Page</title>
<link rel="icon" type="image/png" href="data:image/png;base64,iVBORw0KGgo=" />
<style>
div.mermaid {
/* font-family: 'trebuchet ms', verdana, arial; */
font-family: 'Courier New', Courier, monospace !important;
}
</style>
</head>
<body>
<h1>XY Charts demos</h1>
<pre class="mermaid">
xychart-beta
title "Sales Revenue (in $)"
x-axis [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
</pre>
<hr />
<h1>XY Charts horizontal</h1>
<pre class="mermaid">
xychart-beta horizontal
title "Basic xychart"
x-axis "this is x axis" [category1, "category 2", category3, category4]
y-axis yaxisText 10 --> 150
bar "sample bat" [52, 96, 35, 10]
line [23, 46, 75, 43]
</pre>
<hr />
<h1>XY Charts only lines and bar</h1>
<pre class="mermaid">
xychart-beta
line [23, 46, 77, 34]
line [45, 32, 33, 12]
line [87, 54, 99, 85]
line [78, 88, 22, 4]
line [22, 29, 75, 33]
bar [52, 96, 35, 10]
</pre>
<hr />
<h1>XY Charts with +ve and -ve numbers</h1>
<pre class="mermaid">
xychart-beta
line [+1.3, .6, 2.4, -.34]
</pre>
<h1>XY Charts Bar with multiple category</h1>
<pre class="mermaid">
xychart-beta
title "Basic xychart with many categories"
x-axis "this is x axis" [category1, "category 2", category3, category4, category5, category6, category7]
y-axis yaxisText 10 --> 150
bar "sample bar" [52, 96, 35, 10, 87, 34, 67, 99]
</pre>
<h1>XY Charts line with multiple category</h1>
<pre class="mermaid">
xychart-beta
title "Line chart with many category"
x-axis "this is x axis" [category1, "category 2", category3, category4, category5, category6, category7]
y-axis yaxisText 10 --> 150
line "sample line" [52, 96, 35, 10, 87, 34, 67, 99]
</pre>
<h1>XY Charts category with large text</h1>
<pre class="mermaid">
xychart-beta
title "Basic xychart with many categories with category overlap"
x-axis "this is x axis" [category1, "Lorem ipsum dolor sit amet, qui minim labore adipisicing minim sint cillum sint consectetur cupidatat.", category3, category4, category5, category6, category7]
y-axis yaxisText 10 --> 150
bar "sample bar" [52, 96, 35, 10, 87, 34, 67, 99]
</pre>
<h1>sparkline demo</h1>
<pre class="mermaid">
---
config:
theme: dark
xyChart:
width: 200
height: 20
plotReservedSpacePercent: 100
---
xychart-beta
line [5000, 9000, 7500, 6200, 9500, 5500, 11000, 8200, 9200, 9500, 7000, 8800]
</pre>
<h1>sparkBar demo</h1>
<pre class="mermaid">
---
config:
theme: dark
xyChart:
width: 200
height: 20
plotReservedSpacePercent: 100
---
xychart-beta
bar [5000, 9000, 7500, 6200, 9500, 5500, 11000, 8200, 9200, 9500, 7000, 8800]
</pre>
<h1>XY Charts demos with all configs</h1>
<pre class="mermaid">
---
config:
theme: forest
xyChart:
width: 1000
height: 600
titlePadding: 5
titleFontSize: 10
xAxis:
labelFontSize: 20
labelPadding: 10
titleFontSize: 30
titlePadding: 20
tickLength: 10
tickWidth: 5
axisLineWidth: 5
yAxis:
labelFontSize: 20
labelPadding: 10
titleFontSize: 30
titlePadding: 20
tickLength: 10
tickWidth: 5
axisLineWidth: 5
chartOrientation: horizontal
plotReservedSpacePercent: 60
---
xychart-beta
title "Sales Revene"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
</pre>
<h1>XY Charts demos with all theme config</h1>
<pre class="mermaid">
---
config:
themeVariables:
xyChart:
titleColor: "#ff0000"
backgroundColor: "#f0f8ff"
yAxisLabelColor: "#ee82ee"
yAxisTitleColor: "#7fffd4"
yAxisTickColor: "#87ceeb"
yAxisLineColor: "#ff6347"
xAxisLabelColor: "#7fffd4"
xAxisTitleColor: "#ee82ee"
xAxisTickColor: "#ff6347"
xAxisLineColor: "#87ceeb"
plotColorPalette: "#008000, #faba63"
---
xychart-beta
title "Sales Revene"
x-axis Months [jan, feb, mar, apr, may, jun, jul, aug, sep, oct, nov, dec]
y-axis "Revenue (in $)" 4000 --> 11000
bar [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
line [5000, 6000, 7500, 8200, 9500, 10500, 11000, 10200, 9200, 8500, 7000, 6000]
</pre>
<hr />
<script type="module">
import mermaid from './mermaid.esm.mjs';
mermaid.initialize({
theme: 'default',
logLevel: 3,
securityLevel: 'loose',
});
</script>
</body>
</html>

View File

@@ -1,13 +1,16 @@
version: '3.9'
services:
mermaid:
image: node:18.17.1-alpine3.18
build:
context: .
dockerfile: Dockerfile
stdin_open: true
tty: true
working_dir: /mermaid
mem_limit: '4G'
mem_limit: '8G'
entrypoint: '/mermaid/docker-entrypoint.sh'
environment:
- NODE_OPTIONS=--max_old_space_size=4096
- NODE_OPTIONS=--max_old_space_size=8192
volumes:
- ./:/mermaid
- root_cache:/root/.cache

3
docker-entrypoint.sh Executable file
View File

@@ -0,0 +1,3 @@
#!/bin/sh
source /root/.shrc
exec "$@"

View File

@@ -1,176 +0,0 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/code.md](../../packages/mermaid/src/docs/community/code.md).
# Contributing Code
The basic steps for contributing code are:
```mermaid-example
graph LR
git[1. Checkout a git branch] --> codeTest[2. Write tests and code] --> doc[3. Update documentation] --> submit[4. Submit a PR] --> review[5. Review and merge]
```
```mermaid
graph LR
git[1. Checkout a git branch] --> codeTest[2. Write tests and code] --> doc[3. Update documentation] --> submit[4. Submit a PR] --> review[5. Review and merge]
```
1. **Create** and checkout a git branch and work on your code in the branch
2. Write and update **tests** (unit and perhaps even integration (e2e) tests) (If you do TDD/BDD, the order might be different.)
3. **Let users know** that things have changed or been added in the documents! This is often overlooked, but _critical_
4. **Submit** your code as a _pull request_.
5. Maintainers will **review** your code. If there are no changes necessary, the PR will be merged. Otherwise, make the requested changes and repeat.
## 1. Checkout a git branch
Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)inspired approach to branching.
Development is done in the `develop` branch.
Once development is done we create a `release/vX.X.X` branch from `develop` for testing.
Once the release happens we add a tag to the `release` branch and merge it with `master`. The live product and on-line documentation are what is in the `master` branch.
**All new work should be based on the `develop` branch.**
**When you are ready to do work, always, ALWAYS:**
1. Make sure you have the most up-to-date version of the `develop` branch. (fetch or pull to update it)
2. Check out the `develop` branch
3. Create a new branch for your work. Please name the branch following our naming convention below.
We use the following naming convention for branches:
```txt
[feature | bug | chore | docs]/[issue number]_[short description using dashes ('-') or underscores ('_') instead of spaces]
```
You can always check current [configuration of labelling and branch prefixes](https://github.com/mermaid-js/mermaid/blob/develop/.github/pr-labeler.yml)
- The first part is the **type** of change: a feature, bug, chore, or documentation change ('docs')
- followed by a _slash_ (which helps to group like types together in many git tools)
- followed by the **issue number**
- followed by an _underscore_ ('\_')
- followed by a short text description (but use dashes ('-') or underscores ('\_') instead of spaces)
If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the description. This will help us keep release notes organized: it will help us keep changes for a diagram type together.
**Ex: A new feature described in issue 2945 that adds a new arrow type called 'florbs' to state diagrams**
`feature/2945_state-diagram-new-arrow-florbs`
**Ex: A bug described in issue 1123 that causes random ugly red text in multiple diagram types**
`bug/1123_fix_random_ugly_red_text`
## 2. Write Tests
Tests ensure that each function, module, or part of code does what it says it will do. This is critically
important when other changes are made to ensure that existing code is not broken (no regression).
Just as important, the tests act as _specifications:_ they specify what the code does (or should do).
Whenever someone is new to a section of code, they should be able to read the tests to get a thorough understanding of what it does and why.
If you are fixing a bug, you should add tests to ensure that your code has actually fixed the bug, to specify/describe what the code is doing, and to ensure the bug doesn't happen again.
(If there had been a test for the situation, the bug never would have happened in the first place.)
You may need to change existing tests if they were inaccurate.
If you are adding a feature, you will definitely need to add tests. Depending on the size of your feature, you may need to add integration tests.
### Unit Tests
Unit tests are tests that test a single function or module. They are the easiest to write and the fastest to run.
Unit tests are mandatory all code except the renderers. (The renderers are tested with integration tests.)
We use [Vitest](https://vitest.dev) to run unit tests.
You can use the following command to run the unit tests:
```sh
pnpm test
```
When writing new tests, it's easier to have the tests automatically run as you make changes. You can do this by running the following command:
```sh
pnpm test:watch
```
### Integration/End-to-End (e2e) tests
These test the rendering and visual appearance of the diagrams.
This ensures that the rendering of that feature in the e2e will be reviewed in the release process going forward. Less chance that it breaks!
To start working with the e2e tests:
1. Run `pnpm dev` to start the dev server
2. Start **Cypress** by running `pnpm cypress:open`.
The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.
When running in CI it will take a snapshot of the rendered diagram and compare it with the snapshot from last build and flag it for review if it differs.
This is what a rendering test looks like:
```js
it('should render forks and joins', () => {
imgSnapshotTest(
`
stateDiagram
state fork_state &lt;&lt;fork&gt;&gt;
[*] --> fork_state
fork_state --> State2
fork_state --> State3
state join_state &lt;&lt;join&gt;&gt;
State2 --> join_state
State3 --> join_state
join_state --> State4
State4 --> [*]
`,
{ logLevel: 0 }
);
cy.get('svg');
});
```
**_\[TODO - running the tests against what is expected in development. ]_**
**_\[TODO - how to generate new screenshots]_**
....
## 3. Update Documentation
If the users have no way to know that things have changed, then you haven't really _fixed_ anything for the users; you've just added to making Mermaid feel broken.
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.
The documentation has to be updated to users know that things have changed and added!
If you are adding a new feature, add `(v<MERMAID_RELEASE_VERSION>+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
eg: `# Feature Name (v<MERMAID_RELEASE_VERSION>+)`
We know it can sometimes be hard to code _and_ write user documentation.
Our documentation is managed in `packages/mermaid/src/docs`. Details on how to edit is in the [Contributing Documentation](#contributing-documentation) section.
Create another issue specifically for the documentation.\
You will need to help with the PR, but definitely ask for help if you feel stuck.
When it feels hard to write stuff out, explaining it to someone and having that person ask you clarifying questions can often be 80% of the work!
When in doubt, write up and submit what you can. It can be clarified and refined later. (With documentation, something is better than nothing!)
## 4. Submit your pull request
**\[TODO - PR titles should start with (fix | feat | ....)]**
We make all changes via Pull Requests (PRs). As we have many Pull Requests from developers new to Mermaid, we have put in place a process wherein _knsv, Knut Sveidqvist_ is in charge of the final release process and the active maintainers are in charge of reviewing and merging most PRs.
- PRs will be reviewed by active maintainers, who will provide feedback and request changes as needed.
- The maintainers will request a review from knsv, if necessary.
- Once the PR is approved, the maintainers will merge the PR into the `develop` branch.
- When a release is ready, the `release/x.x.x` branch will be created, extensively tested and knsv will be in charge of the release process.
**Reminder: Pull Requests should be submitted to the develop branch.**

View File

@@ -0,0 +1,521 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/contributing.md](../../packages/mermaid/src/docs/community/contributing.md).
# Mermaid Contributing Guide
You decided to take part in the development? Welcome!
We are trying to make our guidelines for you as explicit and detailed as possible.
## Initial Setup
Initial setup consists of 3 main steps:
```mermaid
flowchart LR
source --> requirements --> setup
source[Get the Source Code]
requirements[Install the Requirements]
setup[Install Packages]
```
### Get the Source Code
In GitHub, you first [**fork a mermaid repository**](https://github.com/mermaid-js/mermaid/fork) when you are going to make changes and submit pull requests.
Then you **clone** a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with.
> **💡 Tip** > [Here is a GitHub document that gives an overview of the process](https://docs.github.com/en/get-started/quickstart/fork-a-repo).
```bash
git clone git@github.com/your-fork/mermaid
```
Once you have cloned the repository onto your development machine, change into the `mermaid` project folder (the top level directory of the mermaid project repository)
```bash
cd mermaid
```
### Install Requirements
We support **development within Docker** environment along with **host setup**. You may choose it up to your preferences.
**Host**
These are the tools we use for working with the code and documentation:
- [Node.js](https://nodejs.org/en/).
- [pnpm](https://pnpm.io/) package manager.
The following commands must be sufficient enough to start with:
```bash
curl -fsSL https://get.pnpm.io/install.sh | sh -
pnpm env use --global 18
```
You may also need to reload `.shrc` or `.bashrc` afterwards.
**Docker**
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
You might already have it installed, so check this by running:
```bash
echo $DISPLAY
```
If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
### Install Packages
**Host**
Install packages:
```bash
pnpm install
```
**Docker**
For development using Docker there is a self-documented `run` bash script, which provides convenient aliases for `docker compose` commands.
Make sure that `./run` script is executable:
```bash
chmod +x run
```
> **💡 Tip**
> To get detailed help simply type `./run` or `./run help`.
>
> It also has short _Development quick start guide_ embedded.
Then install packages:
```bash
./run pnpm install
```
### Verify Everything Works
This step is optional, but it helps to make sure that everything in development branch was OK before you started making any changes.
You can run the `test` script to verify that pnpm is working _and_ that the repository has been cloned correctly:
**Host**
```bash
pnpm test
```
**Docker**
```bash
./run pnpm test
```
The `test` script and others are in the top-level `package.json` file.
All tests should run successfully without any errors or failures.
> **Note**
> You might see _lint_ or _formatting_ warnings. Those are ok during this step.
## Workflow
Contributing process is very simple and strightforward:
```mermaid
flowchart LR
branch --> changes --> submit
branch[Checkout a New Branch]
changes[Make Changes]
submit[Submit a PR]
```
Mermaid uses a [Git Flow](https://guides.github.com/introduction/flow/)inspired approach to branching.
Development is done in the `develop` branch.
```mermaid
---
config:
gitGraph:
mainBranchName: develop
---
gitGraph LR:
commit
commit
branch "docs/2910_update-guidelines" order: 1
commit
commit
commit
checkout develop
merge "docs/2910_update-guidelines"
commit
```
To prepare a new version for release the maintainers create a `release/vX.X.X` branch from `develop` for testing. Once the release happens we add a tag to the `release` branch and merge it with `master`. The live product and on-line documentation are what is in the `master` branch.
## Checkout a New Branch
> **💡 Tip**
> All new work should be based on the `develop` branch.
Make sure you have the most up-to-date version of the `develop` branch.
Check out the `develop` branch, then `fetch` or `pull` to update it:
```bash
git checkout develop
git fetch # or `git pull`
```
Create a new branch for your work:
```bash
git checkout -b docs/2910_update-contributing-guidelines
```
We use the following naming convention for branches:
```txt
[feature | bug | chore | docs]/[issue number]_[short-description]
```
You can always check current [configuration of labelling and branch prefixes](https://github.com/mermaid-js/mermaid/blob/develop/.github/pr-labeler.yml)
- The first part is the **type** of change: a `feature`, `bug`, `chore`, `docs`
- followed by a **slash** (`/`),which helps to group like types together in many git tools
- followed by the **issue number**, e.g. `2910`
- followed by an **underscore** (`_`)
- followed by a **short description** with dashes (`-`) or underscores (`_`) instead of spaces
```mermaid
flowchart LR
feature --> slash
bug --> slash
chore --> slash
docs --> slash
slash --> 2945 --> underscore
slash --> 1123 --> underscore
underscore --> short_description_1
underscore --> short_description_2
underscore["_"]
slash["/"]
short_description_1["state-diagram-new-arrow-florbs"]
short_description_2["fix_random_ugly_red_text"]
```
If your work is specific to a single diagram type, it is a good idea to put the diagram type at the start of the description. This will help us keep release notes organized by a diagram type.
> **Note**
> A new feature described in issue 2945 that adds a new arrow type called 'florbs' to state diagrams
>
> `feature/2945_state-diagram-new-arrow-florbs`
> **💡 Tip**
> A bug described in issue 1123 that causes random ugly red text in multiple diagram types
>
> `bug/1123_fix_random_ugly_red_text`
## Contributing Code
Code is the heart of every software project. We strive to make it better. Who if not us?
### Where is the Code Located?
The core of Mermaid is located under `packages/mermaid/src`.
### Running Mermaid Locally
**Host**
```bash
pnpm run dev
```
**Docker**
```bash
./run dev
```
After starting the dev server open <http://localhost:9000> in your browser.
Now you are ready to make your changes!
### Make Changes
Have a look at <http://localhost:9000>. There is a list of demos that can be used to see and test your changes.
If you need a specific diagram, you can duplicate the `example.html` file in `/demos/dev` and add your own mermaid code to your copy.
That will be served at <http://localhost:9000/dev/your-file-name.html>.
After making code changes, the dev server will rebuild the mermaid library and automatically reload the page.
Edit files in `packages/mermaid/src` as required.
### Write Tests
Tests ensure that each function, module, or part of code does what it says it will do. This is critically important when other changes are made to ensure that existing code is not broken (no regression).
Just as important, the tests act as _specifications:_ they specify what the code does (or should do).
Whenever someone is new to a section of code, they should be able to read the tests to get a thorough understanding of what it does and why.
If you are fixing a bug, you should add tests to ensure that your code has actually fixed the bug, to specify/describe what the code is doing, and to ensure the bug doesn't happen again.
(If there had been a test for the situation, the bug never would have happened in the first place.)
You may need to change existing tests if they were inaccurate.
If you are adding a feature, you will definitely need to add tests. Depending on the size of your feature, you may need to add integration tests.
#### Unit Tests
Unit tests are tests that test a single function or module. They are the easiest to write and the fastest to run.
Unit tests are mandatory for all code except the renderers. (The renderers are tested with integration tests.)
We use [Vitest](https://vitest.dev) to run unit tests.
**Host**
You can use the following command to run the unit tests:
```sh
pnpm test
```
When writing new tests, it's easier to have the tests automatically run as you make changes. You can do this by running the following command:
```sh
pnpm test:watch
```
**Docker**
When using Docker prepend your command with `./run`:
```sh
./run pnpm test
```
#### Integration / End-to-End (E2E) Tests
These test the rendering and visual appearance of the diagrams.
This ensures that the rendering of that feature in the E2E will be reviewed in the release process going forward. Less chance that it breaks!
To start working with the E2E tests:
**Host**
- Run `pnpm dev` to start the dev server
- Start **Cypress** by running `pnpm cypress:open`
**Docker**
- Enable local connections for x11 server `xhost +local:`
- Run `./run pnpm dev` to start the dev server
- Start **Cypress** by running `./run pnpm cypress:open --project .`
The rendering tests are very straightforward to create. There is a function `imgSnapshotTest`, which takes a diagram in text form and the mermaid options, and it renders that diagram in Cypress.
When running in CI it will take a snapshot of the rendered diagram and compare it with the snapshot from last build and flag it for review if it differs.
This is what a rendering test looks like:
```js
it('should render forks and joins', () => {
imgSnapshotTest(
`
stateDiagram
state fork_state &lt;&lt;fork&gt;&gt;
[*] --> fork_state
fork_state --> State2
fork_state --> State3
state join_state &lt;&lt;join&gt;&gt;
State2 --> join_state
State3 --> join_state
join_state --> State4
State4 --> [*]
`,
{ logLevel: 0 }
);
});
```
<!-- **_[TODO - running the tests against what is expected in development. ]_** -->
<!-- **_[TODO - how to generate new screenshots]_** -->
### Update Documentation
> **💡 Tip**
> Our documentation is managed in `packages/mermaid/src/docs`. Details on how to edit is in the [documentation section](#contributing-documentation)
If the users have no way to know that things have changed, then you haven't really _fixed_ anything for the users; you've just added to making Mermaid feel broken.
Likewise, if users don't know that there is a new feature that you've implemented, it will forever remain unknown and unused.
The documentation has to be updated for users to know that things have been changed and added!
If you are adding a new feature, add `(v10.8.0+)` in the title or description. It will be replaced automatically with the current version number when the release happens.
eg: `# Feature Name (v10.8.0+)`
We know it can sometimes be hard to code _and_ write user documentation.
Create another issue specifically for the documentation.\
You will need to help with the PR, but definitely ask for help if you feel stuck.
When it feels hard to write stuff out, explaining it to someone and having that person ask you clarifying questions can often be 80% of the work!
When in doubt, write up and submit what you can. It can be clarified and refined later. (With documentation, something is better than nothing!)
## Contributing Documentation
If it is not in the documentation, it's like it never happened. Wouldn't that be sad? With all the effort that was put into the feature?
### Where is the Documentation Located?
> **Warning**
> DO NOT CHANGE FILES IN `/docs`
>
> The `docs` folder will be automatically generated when committing to `packages/mermaid/src/docs` and **should not** be edited manually.
Documentation is located in the [`packages/mermaid/src/docs`](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs) folder. Just pick the right section and start typing.
The contents of [mermaid.js.org](https://mermaid.js.org/) are based on the docs from the `master` branch. Updates committed to the `master` branch are reflected in the [Mermaid Docs](https://mermaid.js.org/) once published.
```mermaid-example
flowchart LR
classDef default fill:#fff,color:black,stroke:black
source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"]
```
```mermaid
flowchart LR
classDef default fill:#fff,color:black,stroke:black
source["Edit /packages/mermaid/src/docs"] -- automatic processing--> published["View /docs which will be publised on Official Website"]
```
### Running the Documentation Website Locally
**[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).**
Start development server for the documentation site
**Host**
```bash
pnpm --filter mermaid run docs:dev
```
or
```bash
cd packages/mermaid
pnpm docs:dev
```
**Docker**
```bash
./run docs:dev
```
Open <http://localhost:3333/> in your browser.
### Formatting
The documentation is written in Markdown. To get acquainted with its syntax [see the GitHub Markdown help page](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
> **‼️ Danger**
> Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
Here are a few examples:
````markdown
```note
This is a note
```
```tip
This is a tip
```
```warning
This is a warning
```
```danger
This is a danger alert
```
````
> **Note**
> This is a note
> **💡 Tip**
> This is a tip
> **Warning**
> This is a warning
> **‼️ Danger**
> This is a danger alert
### Navigation
If you want to propose changes to how the documentation is _organized_, such as adding a new section or re-arranging or renaming a section, you must update the **sidebar navigation**, which is defined in [the vitepress config](../.vitepress/config.ts). The same goes to **topbar**.
### Build Docs
The content of `/docs` folder is built with Github Actions.
> **Warning**
> So as to allow automatic compilation of documentation pages you have to enable Github Actions on your fork first
## Submit your pull request
> **Note**
> Do not forget to push your changes
>
> ```bash
> git push -u origin docs/2910_update-guidelines
> ```
We make all changes via Pull Requests (PRs). Open a new one.
Right now we are not following any strict rules about naming PRs. Give it a representative title and short description. There is also a [pull request template](https://github.com/mermaid-js/mermaid/blob/develop/.github/pull_request_template.md) which will help you with it.
In case in its description contains a [magic comment](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue) your PR will be automatically attached to the issue:
```markdown
Resolves #<your issue ID here>
```
## Congratulations
You have successfully submitted your improvements! What is next?
- PRs will be reviewed by active maintainers, who will provide feedback and request changes as needed.
- The maintainers will request a review from _knsv_, if necessary.
- Once the PR is approved, the maintainers will merge the PR into the `develop` branch.
- When a release is ready, the `release/x.x.x` branch will be created, extensively tested and knsv will be in charge of the release process.
Thanks for you help!

View File

@@ -1,96 +0,0 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/development.md](../../packages/mermaid/src/docs/community/development.md).
# Contributing to Mermaid
> The following documentation describes how to work with Mermaid in your host environment.
> There's also a [Docker installation guide](../community/docker-development.md)
> if you prefer to work in a Docker environment.
So you want to help? That's great!
![Image of happy people jumping with excitement](https://media.giphy.com/media/BlVnrxJgTGsUw/giphy.gif)
Here are a few things to get you started on the right path.
## Get the Source Code
In GitHub, you first **fork** a repository when you are going to make changes and submit pull requests.
Then you **clone** a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with.
[Fork mermaid](https://github.com/mermaid-js/mermaid/fork) to start contributing to the main project and its documentation, or [search for other repositories](https://github.com/orgs/mermaid-js/repositories).
[Here is a GitHub document that gives an overview of the process.](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
## Technical Requirements
> The following documentation describes how to work with Mermaid in your host environment.
> There's also a [Docker installation guide](../community/docker-development.md)
> if you prefer to work in a Docker environment.
These are the tools we use for working with the code and documentation:
- [volta](https://volta.sh/) to manage node versions.
- [Node.js](https://nodejs.org/en/). `volta install node`
- [pnpm](https://pnpm.io/) package manager. `volta install pnpm`
- [npx](https://docs.npmjs.com/cli/v8/commands/npx) the packaged executor in npm. This is needed [to install pnpm.](#install-packages)
Follow the setup steps below to install them and start the development.
## Setup and Launch
### Switch to project
Once you have cloned the repository onto your development machine, change into the `mermaid` project folder (the top level directory of the mermaid project repository)
```bash
cd mermaid
```
### Install packages
Run `npx pnpm install`. You will need `npx` for this because volta doesn't support it yet.
```bash
npx pnpm install # npx is required for first install
```
### Launch
```bash
npx pnpm run dev
```
Now you are ready to make your changes! Edit whichever files in `src` as required.
Open <http://localhost:9000> in your browser, after starting the dev server.
There is a list of demos that can be used to see and test your changes.
If you need a specific diagram, you can duplicate the `example.html` file in `/demos/dev` and add your own mermaid code to your copy.
That will be served at <http://localhost:9000/dev/your-file-name.html>.
After making code changes, the dev server will rebuild the mermaid library. You will need to reload the browser page yourself to see the changes. (PRs for auto reload are welcome!)
## Verify Everything is Working
You can run the `test` script to verify that pnpm is working _and_ that the repository has been cloned correctly:
```bash
pnpm test
```
The `test` script and others are in the top-level `package.json` file.
All tests should run successfully without any errors or failures. (You might see _lint_ or _formatting_ warnings; those are ok during this step.)
## Last Words
Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.
[Join our Slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
![Image of superhero wishing you good luck](https://media.giphy.com/media/l49JHz7kJvl6MCj3G/giphy.gif)

View File

@@ -1,109 +0,0 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/docker-development.md](../../packages/mermaid/src/docs/community/docker-development.md).
# Contributing to Mermaid via Docker
> The following documentation describes how to work with Mermaid in a Docker environment.
> There's also a [host installation guide](../community/development.md)
> if you prefer to work without a Docker environment.
So you want to help? That's great!
![Image of happy people jumping with excitement](https://media.giphy.com/media/BlVnrxJgTGsUw/giphy.gif)
Here are a few things to get you started on the right path.
## Get the Source Code
In GitHub, you first **fork** a repository when you are going to make changes and submit pull requests.
Then you **clone** a copy to your local development machine (e.g. where you code) to make a copy with all the files to work with.
[Fork mermaid](https://github.com/mermaid-js/mermaid/fork) to start contributing to the main project and its documentation, or [search for other repositories](https://github.com/orgs/mermaid-js/repositories).
[Here is a GitHub document that gives an overview of the process.](https://docs.github.com/en/get-started/quickstart/fork-a-repo)
## Technical Requirements
> The following documentation describes how to work with Mermaid in a Docker environment.
> There's also a [host installation guide](../community/development.md)
> if you prefer to work without a Docker environment.
[Install Docker](https://docs.docker.com/engine/install/). And that is pretty much all you need.
Optionally, to run GUI (Cypress) within Docker you will also need an X11 server installed.
You might already have it installed, so check this by running:
```bash
echo $DISPLAY
```
If the `$DISPLAY` variable is not empty, then an X11 server is running. Otherwise you may need to install one.
## Setup and Launch
### Switch to project
Once you have cloned the repository onto your development machine, change into the `mermaid` project folder (the top level directory of the mermaid project repository)
```bash
cd mermaid
```
### Make `./run` executable
For development using Docker there is a self-documented `run` bash script, which provides convenient aliases for `docker compose` commands.
Ensure `./run` script is executable:
```bash
chmod +x run
```
> **💡 Tip**
> To get detailed help simply type `./run` or `./run help`.
>
> It also has short _Development quick start guide_ embedded.
### Install packages
```bash
./run pnpm install # Install packages
```
### Launch
```bash
./run dev
```
Now you are ready to make your changes! Edit whichever files in `src` as required.
Open <http://localhost:9000> in your browser, after starting the dev server.
There is a list of demos that can be used to see and test your changes.
If you need a specific diagram, you can duplicate the `example.html` file in `/demos/dev` and add your own mermaid code to your copy.
That will be served at <http://localhost:9000/dev/your-file-name.html>.
After making code changes, the dev server will rebuild the mermaid library. You will need to reload the browser page yourself to see the changes. (PRs for auto reload are welcome!)
## Verify Everything is Working
```bash
./run pnpm test
```
The `test` script and others are in the top-level `package.json` file.
All tests should run successfully without any errors or failures. (You might see _lint_ or _formatting_ warnings; those are ok during this step.)
## Last Words
Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.
[Join our Slack community if you want closer contact!](https://join.slack.com/t/mermaid-talk/shared_invite/enQtNzc4NDIyNzk4OTAyLWVhYjQxOTI2OTg4YmE1ZmJkY2Y4MTU3ODliYmIwOTY3NDJlYjA0YjIyZTdkMDMyZTUwOGI0NjEzYmEwODcwOTE)
![Image of superhero wishing you good luck](https://media.giphy.com/media/l49JHz7kJvl6MCj3G/giphy.gif)

View File

@@ -1,105 +0,0 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/documentation.md](../../packages/mermaid/src/docs/community/documentation.md).
# Contributing Documentation
**_\[TODO: This section is still a WIP. It still needs MAJOR revision.]_**
If it is not in the documentation, it's like it never happened. Wouldn't that be sad? With all the effort that was put into the feature?
The docs are located in the `packages/mermaid/src/docs` folder and are written in Markdown. Just pick the right section and start typing.
The contents of [mermaid.js.org](https://mermaid.js.org/) are based on the docs from the `master` branch.
Updates committed to the `master` branch are reflected in the [Mermaid Docs](https://mermaid.js.org/) once published.
## How to Contribute to Documentation
We are a little less strict here, it is OK to commit directly in the `develop` branch if you are a collaborator.
The documentation is located in the `packages/mermaid/src/docs` directory and organized according to relevant subfolder.
The `docs` folder will be automatically generated when committing to `packages/mermaid/src/docs` and **should not** be edited manually.
```mermaid-example
flowchart LR
classDef default fill:#fff,color:black,stroke:black
source["files in /packages/mermaid/src/docs\n(changes should be done here)"] -- automatic processing\nto generate the final documentation--> published["files in /docs\ndisplayed on the official documentation site"]
```
```mermaid
flowchart LR
classDef default fill:#fff,color:black,stroke:black
source["files in /packages/mermaid/src/docs\n(changes should be done here)"] -- automatic processing\nto generate the final documentation--> published["files in /docs\ndisplayed on the official documentation site"]
```
You can use `note`, `tip`, `warning` and `danger` in triple backticks to add a note, tip, warning or danger box.
Do not use vitepress specific markdown syntax `::: warning` as it will not be processed correctly.
````markdown
```note
Note content
```
```tip
Tip content
```
```warning
Warning content
```
```danger
Danger content
```
````
> **Note**
> If the change is _only_ to the documentation, you can get your changes published to the site quicker by making a PR to the `master` branch. In that case, your branch should be based on master, not develop.
We encourage contributions to the documentation at [packages/mermaid/src/docs in the _develop_ branch](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs).
**_DO NOT CHANGE FILES IN `/docs`_**
## The official documentation site
**[The mermaid documentation site](https://mermaid.js.org/) is powered by [Vitepress](https://vitepress.vuejs.org/).**
To run the documentation site locally:
1. Run `pnpm --filter mermaid run docs:dev` to start the dev server. (Or `pnpm docs:dev` inside the `packages/mermaid` directory.)
2. Open <http://localhost:3333/> in your browser.
Markdown is used to format the text, for more information about Markdown [see the GitHub Markdown help page](https://help.github.com/en/github/writing-on-github/basic-writing-and-formatting-syntax).
To edit Docs on your computer:
_\[TODO: need to keep this in sync with [check out a git branch in Contributing Code above](#1-checkout-a-git-branch) ]_
1. Create a fork of the develop branch to work on.
2. Find the Markdown file (.md) to edit in the `packages/mermaid/src/docs` directory.
3. Make changes or add new documentation.
4. Commit changes to your branch and push it to GitHub (which should create a new branch).
5. Create a Pull Request from the branch of your fork.
To edit Docs on GitHub:
1. Login to [GitHub.com](https://www.github.com).
2. Navigate to [packages/mermaid/src/docs](https://github.com/mermaid-js/mermaid/tree/develop/packages/mermaid/src/docs) in the mermaid-js repository.
3. To edit a file, click the pencil icon at the top-right of the file contents panel.
4. Describe what you changed in the **Propose file change** section, located at the bottom of the page.
5. Submit your changes by clicking the button **Propose file change** at the bottom (by automatic creation of a fork and a new branch).
6. Visit the Actions tab in Github, `https://github.com/<Your Username>/mermaid/actions` and enable the actions for your fork. This will ensure that the documentation is built and updated in your fork.
7. Create a Pull Request of your newly forked branch by clicking the green **Create Pull Request** button.
## Documentation organization: Sidebar navigation
If you want to propose changes to how the documentation is _organized_, such as adding a new section or re-arranging or renaming a section, you must update the **sidebar navigation.**
The sidebar navigation is defined in [the vitepress configuration file config.ts](../.vitepress/config.ts).

60
docs/community/intro.md Normal file
View File

@@ -0,0 +1,60 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/intro.md](../../packages/mermaid/src/docs/community/intro.md).
# Getting Started
So you want to help? That's great!
![Image of happy people jumping with excitement](https://media.giphy.com/media/BlVnrxJgTGsUw/giphy.gif)
Here are a few things to get you started on the right path.
## How can I help?
```mermaid
mindmap
root)Contributing(
Development
Solving issues
Adding new diagrams
Handling pull requests
Updating tooling
Testing
Verification of fixed issues
Regression testing in connection with releases
Testing pull requests
Management
Coordinating the work
Classification and monitoring of incoming issues
```
## Join the Development
> **💡 Tip** > **Check out our** [**detailed contribution guide**](./contributing.md).
Where to start:
- You could start getting some knowledge of the code base by working on [these "good first issues"](https://github.com/mermaid-js/mermaid/issues?utf8=%E2%9C%93&q=is%3Aissue+is%3Aopen+label%3A%22Good+first+issue%21%22+).
- You could jump right in and help us fix any of [these bugs](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Type%3A+Bug+%2F+Error%22++label%3A%22Contributor+needed%22+)!
- You could help write and [improve the documentation](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
- You could work on a new feature! [These](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Development%22+label%3A%22Type%3A+Enhancement%22+label%3A%22Status%3A+Approved%22+) are some ideas!
- You could confirm the bugs in [these issues](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Status%3A+Triage%22++label%3A%22Type%3A+Bug+%2F+Error%22).
[You can join our Discord server if you want closer contact!](https://discord.gg/AgrbSrBer3)
## A Question Or a Suggestion?
> **💡 Tip** > **Have a look at** [**how to open an issue**](./questions-and-suggestions.md).
If you have faced a vulnerability [report it to us](./security.md).
## Last Words
Don't get daunted if it is hard in the beginning. We have a great community with only encouraging words. So, if you get stuck, ask for help and hints in the Slack forum. If you want to show off something good, show it off there.
[You can join our Discord server if you want closer contact!](https://discord.gg/AgrbSrBer3)
![Image of superhero wishing you good luck](https://media.giphy.com/media/l49JHz7kJvl6MCj3G/giphy.gif)

View File

@@ -2,7 +2,7 @@
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/newDiagram.md](../../packages/mermaid/src/docs/community/newDiagram.md).
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/community/new-diagram.md](../../packages/mermaid/src/docs/community/new-diagram.md).
# Adding a New Diagram/Chart 📊

View File

@@ -6,21 +6,20 @@
# Questions or Suggestions?
**_\[TODO: This section is still a WIP. It still needs MAJOR revision.]_**
## Search for Existing Issue
## First search to see if someone has already asked (and hopefully been answered) or suggested the same thing.
First search to see if someone has already asked (and hopefully been answered) or suggested the same thing.
- Search in Discussions
- Search in open Issues
- Search in closed Issues
- [Search in Discussions](https://github.com/orgs/mermaid-js/discussions)
- [Search in Issues (Open & Closed)](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue)
If you find an open issue or discussion thread that is similar to your question but isn't answered, you can let us know that you are also interested in it.
Use the GitHub reactions to add a thumbs-up to the issue or discussion thread.
Use the GitHub reactions to add a thumbs-up to the issue or discussion thread, or append to the issue if needed.
This helps the team know the relative interest in something and helps them set priorities and assignments.
Feel free to add to the discussion on the issue or topic.
## Add a new Issue
If you can't find anything that already addresses your question or suggestion, _open a new issue:_
You have not found anything that already addresses your request, or maybe you have come up with the new idea? Feel free to open a new issue or discussion.
Log in to [GitHub.com](https://www.github.com), open or append to an issue [using the GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues?q=is%3Aissue+is%3Aopen+label%3A%22Area%3A+Documentation%22).
Log in to [GitHub.com](https://www.github.com), and use [GitHub issue tracker of the mermaid-js repository](https://github.com/mermaid-js/mermaid/issues). Press \[<https://github.com/mermaid-js/mermaid/issues/new/choose>] issue, select the appropriate template and describe your problem.

View File

@@ -16,7 +16,7 @@ We aim to reply within three working days, probably much sooner.
You should expect a close collaboration as we work to resolve the issue you have reported. Please reach out to <security@mermaid.live> again if you do not receive prompt attention and regular updates.
You may also reach out to the team via our public Slack chat channels; however, please make sure to e-mail <security@mermaid.live> when reporting an issue, and avoid revealing information about vulnerabilities in public as that could that could put users at risk.
You may also reach out to the team via our public Discord chat channels; however, please make sure to e-mail <security@mermaid.live> when reporting an issue, and avoid revealing information about vulnerabilities in public as that could that could put users at risk.
## Best practices

View File

@@ -97,7 +97,7 @@ See [the accTitle and accDescr usage examples](#acctitle-and-accdescr-usage-exam
graph LR
accTitle: Big Decisions
accDescr: Bob's Burgers process for making big decisions
A[Identify Big Descision] --> B{Make Big Decision}
A[Identify Big Decision] --> B{Make Big Decision}
B --> D[Be done]
```
@@ -105,7 +105,7 @@ See [the accTitle and accDescr usage examples](#acctitle-and-accdescr-usage-exam
graph LR
accTitle: Big Decisions
accDescr: Bob's Burgers process for making big decisions
A[Identify Big Descision] --> B{Make Big Decision}
A[Identify Big Decision] --> B{Make Big Decision}
B --> D[Be done]
```
@@ -137,7 +137,7 @@ Here is the HTML generated for the SVG element: _(Note that some of the SVG attr
for making very, very big decisions.
This is actually a very simple flow: identify the big decision and then make the big decision.
}
A[Identify Big Descision] --> B{Make Big Decision}
A[Identify Big Decision] --> B{Make Big Decision}
B --> D[Be done]
```
@@ -149,7 +149,7 @@ Here is the HTML generated for the SVG element: _(Note that some of the SVG attr
for making very, very big decisions.
This is actually a very simple flow: identify the big decision and then make the big decision.
}
A[Identify Big Descision] --> B{Make Big Decision}
A[Identify Big Decision] --> B{Make Big Decision}
B --> D[Be done]
```

View File

@@ -1,30 +0,0 @@
> **Warning**
>
> ## THIS IS AN AUTOGENERATED FILE. DO NOT EDIT.
>
> ## Please edit the corresponding file in [/packages/mermaid/src/docs/config/advanced.md](../../packages/mermaid/src/docs/config/advanced.md).
# Advanced mermaid (Coming soon..)
## splitting mermaid code from html
A more condensed html code can be achieved by embedding the mermaid code in its own .js file, which is referenced like so:
```html
...
</div>
</body>
</html>
```
The actual mermaid file could for example look like this:
```javascript
mermaid content ...
```
## mermaid configuration options
```markdown
(coming soon)
```

View File

@@ -10,8 +10,8 @@ When mermaid starts, configuration is extracted to determine a configuration to
- The default configuration
- Overrides at the site level are set by the initialize call, and will be applied to all diagrams in the site/app. The term for this is the **siteConfig**.
- Frontmatter (v10.5.0+) - diagram authors can update select configuration parameters in the frontmatter of the diagram. These are applied to the render config.
- Directives (Deprecated by Frontmatter) - diagram authors can update select configuration parameters directly in the diagram code via directives. These are applied to the render config.
- Frontmatter (v10.5.0+) - diagram authors can update selected configuration parameters in the frontmatter of the diagram. These are applied to the render config.
- Directives (Deprecated by Frontmatter) - diagram authors can update selected configuration parameters directly in the diagram code via directives. These are applied to the render config.
**The render config** is configuration that is used when rendering by applying these configurations.

View File

@@ -16,4 +16,4 @@
#### Defined in
[mermaidAPI.ts:59](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L59)
[mermaidAPI.ts:60](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L60)

View File

@@ -39,7 +39,7 @@ bindFunctions?.(div); // To call bindFunctions only if it's present.
#### Defined in
[mermaidAPI.ts:79](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L79)
[mermaidAPI.ts:80](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L80)
---
@@ -51,4 +51,4 @@ The svg code for the rendered graph.
#### Defined in
[mermaidAPI.ts:69](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L69)
[mermaidAPI.ts:70](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L70)

View File

@@ -14,7 +14,7 @@
#### Defined in
[defaultConfig.ts:268](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L268)
[defaultConfig.ts:272](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/defaultConfig.ts#L272)
---

View File

@@ -25,7 +25,7 @@ Renames and re-exports [mermaidAPI](mermaidAPI.md#mermaidapi)
#### Defined in
[mermaidAPI.ts:63](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L63)
[mermaidAPI.ts:64](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L64)
## Variables
@@ -96,7 +96,7 @@ mermaid.initialize(config);
#### Defined in
[mermaidAPI.ts:641](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L641)
[mermaidAPI.ts:607](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L607)
## Functions
@@ -127,7 +127,7 @@ Return the last node appended
#### Defined in
[mermaidAPI.ts:299](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L299)
[mermaidAPI.ts:263](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L263)
---
@@ -153,7 +153,7 @@ the cleaned up svgCode
#### Defined in
[mermaidAPI.ts:245](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L245)
[mermaidAPI.ts:209](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L209)
---
@@ -178,7 +178,7 @@ the string with all the user styles
#### Defined in
[mermaidAPI.ts:175](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L175)
[mermaidAPI.ts:139](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L139)
---
@@ -201,7 +201,7 @@ the string with all the user styles
#### Defined in
[mermaidAPI.ts:222](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L222)
[mermaidAPI.ts:186](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L186)
---
@@ -228,47 +228,7 @@ with an enclosing block that has each of the cssClasses followed by !important;
#### Defined in
[mermaidAPI.ts:160](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L160)
---
### decodeEntities
**decodeEntities**(`text`): `string`
#### Parameters
| Name | Type | Description |
| :----- | :------- | :----------------- |
| `text` | `string` | text to be decoded |
#### Returns
`string`
#### Defined in
[mermaidAPI.ts:146](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L146)
---
### encodeEntities
**encodeEntities**(`text`): `string`
#### Parameters
| Name | Type | Description |
| :----- | :------- | :----------------- |
| `text` | `string` | text to be encoded |
#### Returns
`string`
#### Defined in
[mermaidAPI.ts:117](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L117)
[mermaidAPI.ts:124](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L124)
---
@@ -294,7 +254,7 @@ Put the svgCode into an iFrame. Return the iFrame code
#### Defined in
[mermaidAPI.ts:276](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L276)
[mermaidAPI.ts:240](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L240)
---
@@ -319,4 +279,4 @@ Remove any existing elements from the given document
#### Defined in
[mermaidAPI.ts:349](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L349)
[mermaidAPI.ts:313](https://github.com/mermaid-js/mermaid/blob/master/packages/mermaid/src/mermaidAPI.ts#L313)

View File

@@ -20,7 +20,7 @@ Please note that you can switch versions through the dropdown box at the top rig
For the majority of users, Using the [Live Editor](https://mermaid.live/) would be sufficient, however you may also opt to deploy mermaid as a dependency or using the [Mermaid API](./setup/README.md).
We have compiled some Video [Tutorials](./Tutorials.md) on how to use the Mermaid Live Editor.
We have compiled some Video [Tutorials](../ecosystem/tutorials.md) on how to use the Mermaid Live Editor.
### Installing and Hosting Mermaid on a Webpage

View File

Before

Width:  |  Height:  |  Size: 38 KiB

After

Width:  |  Height:  |  Size: 38 KiB

View File

@@ -6,51 +6,69 @@
# Integrations
## Official integration: [Mermaid Chart](./mermaid-chart.md)
## Official integration
We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created with Mermaid.
### Mermaid Chart
Mermaid Chart is built by the team behind Mermaid JS.
For more details, visit the [Mermaid Chart page](./mermaid-chart.md), or visit the [Mermaid Chart website](https://www.mermaidchart.com) .
## Community integrations
Below are a list of community plugins and integrations created with Mermaid.
We're excited about the growth of the Mermaid community, and the number of plugins and integrations that have been created by the community.
See the list below of community plugins and integrations created with Mermaid.
> **Note**
> A ✅ indicates Native support for Mermaid on the respective platform.
To add an integration to this list, see the [Integrations - create page](./integrations-create.md).
### Productivity tools
✅ = Native support
- [Atlassian Products](https://www.atlassian.com)
- [Mermaid for Confluence](https://marketplace.atlassian.com/apps/1224722/mermaid-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Integration for Confluence](https://marketplace.atlassian.com/apps/1222792/mermaid-integration-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Charts & Diagrams for Confluence](https://marketplace.atlassian.com/apps/1222572/)
- [Mermaid Diagrams for Confluence](https://marketplace.atlassian.com/apps/1226945/mermaid-diagrams-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Live Editor for Confluence Cloud](https://marketplace.atlassian.com/apps/1231571/mermaid-live-editor-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Macro for Confluence](https://marketplace.atlassian.com/apps/1231150/mermaid-macro-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Plugin for Confluence](https://marketplace.atlassian.com/apps/1214124/mermaid-plugin-for-confluence?hosting=server&tab=overview)
- [EliteSoft Mermaid Charts and Diagrams](https://marketplace.atlassian.com/apps/1227286/elitesoft-mermaid-charts-and-diagrams?hosting=cloud&tab=overview)
- [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid)
- [Mermaid Charts & Diagrams for Jira](https://marketplace.atlassian.com/apps/1224537/)
- [Mermaid for Jira Cloud - Draw UML diagrams easily](https://marketplace.atlassian.com/apps/1223053/mermaid-for-jira-cloud-draw-uml-diagrams-easily?hosting=cloud&tab=overview)
- [CloudScript.io Mermaid Addon](https://marketplace.atlassian.com/apps/1219878/cloudscript-io-mermaid-addon?hosting=cloud&tab=overview)
- [Azure Devops](https://learn.microsoft.com/en-us/azure/devops/project/wiki/markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) ✅
- [Deepdwn](https://billiam.itch.io/deepdwn) ✅
- [GitBook](https://gitbook.com)
- [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid)
- [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf)
- [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli)
- [Gitea](https://gitea.io) ✅
- [GitHub](https://github.com) ✅
- [Using code blocks](https://github.blog/2022-02-14-include-diagrams-markdown-files-mermaid/) ✅
- [GitHub action: Compile mermaid to image](https://github.com/neenjaw/compile-mermaid-markdown-action)
- [svg-generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator)
- [GitHub Writer](https://github.com/ckeditor/github-writer)
- [SVG diagram generator](https://github.com/SimonKenyonShepard/mermaidjs-github-svg-generator)
- [GitLab](https://docs.gitlab.com/ee/user/markdown.html#diagrams-and-flowcharts) ✅
- [Gitea](https://gitea.io) ✅
- [Azure Devops](https://docs.microsoft.com/en-us/azure/devops/project/wiki/wiki-markdown-guidance?view=azure-devops#add-mermaid-diagrams-to-a-wiki-page) ✅
- [Mermaid Plugin for JetBrains IDEs](https://plugins.jetbrains.com/plugin/20146-mermaid)
- [Joplin](https://joplinapp.org) ✅
- [LiveBook](https://livebook.dev) ✅
- [Tuleap](https://docs.tuleap.org/user-guide/writing-in-tuleap.html#graphs) ✅
- [Mermaid Flow Visual Editor](https://www.mermaidflow.app) ✅
- [Deepdwn](https://billiam.itch.io/deepdwn) ✅
- [Joplin](https://joplinapp.org) ✅
- [Mermerd](https://github.com/KarnerTh/mermerd)
- [Slab](https://slab.com) ✅
- [Swimm](https://swimm.io) ✅
- [Swimm](https://docs.swimm.io/features/diagrams-and-charts/#mermaid--swimm--up-to-date-diagrams-) ✅
- [NotesHub](https://noteshub.app) ✅
- [Notion](https://notion.so) ✅
- [Observable](https://observablehq.com/@observablehq/mermaid) ✅
- [Obsidian](https://help.obsidian.md/Editing+and+formatting/Advanced+formatting+syntax#Diagram) ✅
- [GitBook](https://gitbook.com)
- [Mermaid Plugin](https://github.com/JozoVilcek/gitbook-plugin-mermaid)
- [Markdown with Mermaid CLI](https://github.com/miao1007/gitbook-plugin-mermaid-cli)
- [Mermaid plugin for GitBook](https://github.com/wwformat/gitbook-plugin-mermaid-pdf)
- [LiveBook](https://livebook.dev) ✅
- [Atlassian Products](https://www.atlassian.com)
- [Mermaid Live Editor for Confluence Cloud](https://marketplace.atlassian.com/apps/1231571/mermaid-live-editor-for-confluence?hosting=cloud&tab=overview)
- [Mermaid Plugin for Confluence](https://marketplace.atlassian.com/apps/1214124/mermaid-plugin-for-confluence?hosting=server&tab=overview)
- [CloudScript.io Addon](https://marketplace.atlassian.com/apps/1219878/cloudscript-io-mermaid-addon?hosting=cloud&tab=overview)
- [Auto convert diagrams in Jira](https://github.com/coddingtonbear/jirafs-mermaid)
- [Redmine](https://redmine.org)
- [Mermaid Macro](https://www.redmine.org/plugins/redmine_mermaid_macro)
- [Markdown for mermaid plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin)
- [redmine-mermaid](https://github.com/styz/redmine_mermaid)
- [markdown-for-mermaid-plugin](https://github.com/jamieh-mongolian/markdown-for-mermaid-plugin)
- [JetBrains IDE eg Pycharm](https://www.jetbrains.com/go/guide/tips/mermaid-js-support-in-markdown/)
- [mermerd](https://github.com/KarnerTh/mermerd)
- Visual Studio Code [Polyglot Interactive Notebooks](https://github.com/dotnet/interactive#net-interactive)
### CRM/ERP
@@ -63,133 +81,137 @@ Customer Relationship Management/Enterprise Resource Planning
Blogging frameworks and platforms
- [WordPress](https://wordpress.org)
- [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md)
- [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/)
- [Hexo](https://hexo.io)
- [hexo-filter-mermaid-diagrams](https://github.com/webappdevelp/hexo-filter-mermaid-diagrams)
- [hexo-tag-mermaid](https://github.com/JameChou/hexo-tag-mermaid)
- [hexo-mermaid-diagrams](https://github.com/mslxl/hexo-mermaid-diagrams)
- [Nextra](https://nextra.site/)
- [Mermaid](https://nextra.site/docs/guide/mermaid)
- [WordPress](https://wordpress.org)
- [WordPress Markdown Editor](https://wordpress.org/plugins/wp-githuber-md)
- [WP-ReliableMD](https://wordpress.org/plugins/wp-reliablemd/)
### CMS/ECM
Content Management Systems/Enterprise Content Management
- [Grav CMS](https://getgrav.org/)
- [Mermaid Diagrams Plugin](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams)
- [GitLab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter)
- [VitePress](https://vitepress.vuejs.org/)
- [Plugin for Mermaid.js](https://emersonbottero.github.io/vitepress-plugin-mermaid/)
- [VuePress](https://vuepress.vuejs.org/)
- [Plugin for Mermaid.js](https://github.com/eFrane/vuepress-plugin-mermaidjs)
- [Grav CMS](https://getgrav.org/)
- [Mermaid Diagrams](https://github.com/DanielFlaum/grav-plugin-mermaid-diagrams)
- [GitLab Markdown Adapter](https://github.com/Goutte/grav-plugin-gitlab-markdown-adapter)
### Communication
Communication tools and platforms
- [Discourse](https://discourse.org)
- [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid), [And](https://github.com/unfoldingWord-dev/discourse-mermaid)
- [Mermaid Plugin](https://github.com/pnewell/discourse-mermaid)
- [Mattermost](https://mattermost.com/)
- [Mermaid Plugin](https://github.com/SpikeTings/Mermaid)
- [NodeBB](https://nodebb.org)
- [Mermaid Parser Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid)
- [phpBB](https://phpbb.com)
- [phpbb-ext-mermaid](https://github.com/AlfredoRamos/phpbb-ext-mermaid)
- [NodeBB](https://nodebb.org)
- [Mermaid Plugin](https://www.npmjs.com/package/nodebb-plugin-mermaid)
- [Slack](https://slack.com)
- [Mermaid Preview](https://github.com/JackuB/mermaid-for-slack)
### Wikis
- [MediaWiki](https://www.mediawiki.org)
- [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid)
- [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams)
- [Semantic Media Wiki](https://semantic-mediawiki.org)
- [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid)
- [DokuWiki](https://dokuwiki.org)
- [ComboStrap](https://combostrap.com/mermaid)
- [Mermaid Plugin](https://www.dokuwiki.org/plugin:mermaid)
- [Foswiki](https://foswiki.org)
- [Mermaid Plugin](https://foswiki.org/Extensions/MermaidPlugin)
- [DokuWiki](https://dokuwiki.org)
- [Mermaid Plugin](https://www.dokuwiki.org/plugin:mermaid)
- [ComboStrap](https://combostrap.com/mermaid)
- [MediaWiki](https://www.mediawiki.org)
- [Flex Diagrams Extension](https://www.mediawiki.org/wiki/Extension:Flex_Diagrams)
- [Mermaid Extension](https://www.mediawiki.org/wiki/Extension:Mermaid)
- [PmWiki](https://www.pmwiki.org)
- [MermaidJs Cookbook recipe](https://www.pmwiki.org/wiki/Cookbook/MermaidJs)
- [Semantic Media Wiki](https://semantic-mediawiki.org)
- [Mermaid Plugin](https://github.com/SemanticMediaWiki/Mermaid)
- [TiddlyWiki](https://tiddlywiki.com/)
- [mermaid-tw5: full js library](https://github.com/efurlanm/mermaid-tw5)
- [tw5-mermaid: wrapper for Mermaid Live](https://github.com/jasonmhoule/tw5-mermaid)
- [mermaid-tw5: wrapper for Mermaid Live](https://github.com/efurlanm/mermaid-tw5)
- [tw5-mermaid: plugin for managing Mermaid.js tiddlers](https://github.com/jasonmhoule/tw5-mermaid)
### Editor Plugins
- [VS Code](https://code.visualstudio.com/)
- [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
- [Mermaid Preview](https://marketplace.visualstudio.com/items?itemName=vstirbu.vscode-mermaid-preview)
- [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
- [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
- [Mermaid Editor](https://marketplace.visualstudio.com/items?itemName=tomoyukim.vscode-mermaid-editor)
- [Mermaid Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export)
- [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf)
- [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode)
- [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode)
- [Markdown-It](https://github.com/markdown-it/markdown-it)
- [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml)
- [Mermaid Plugin](https://github.com/tylingsoft/markdown-it-mermaid)
- [md-it-mermaid](https://github.com/iamcco/md-it-mermaid)
- [markdown-it-mermaid-fence-new](https://github.com/Revomatico/markdown-it-mermaid-fence-new)
- [markdown-it-mermaid-less](https://github.com/searKing/markdown-it-mermaid-less)
- Atom _(Atom has been [archived.](https://github.blog/2022-06-08-sunsetting-atom/))_
- [Markdown Preview Enhanced](https://github.com/shd101wyy/markdown-preview-enhanced)
- [Atom Mermaid](https://github.com/y-takey/atom-mermaid)
- [Language Mermaid Syntax Highlighter](https://github.com/ytisf/language-mermaid)
- [Sublime Text 3](https://sublimetext.com)
- [Mermaid Package](https://packagecontrol.io/packages/Mermaid)
- [Astah](https://astah.net)
- [Export to Mermaid](https://github.com/Avens666/Astah_Jude_UML_export_to_Markdown-mermaid-Plantuml-)
- [Light Table](http://lighttable.com/)
- [Mermaid Plugin](https://github.com/cldwalker/Mermaid)
- [Draw.io](https://draw.io) - [Plugin](https://github.com/nopeslide/drawio_mermaid_plugin)
- [Inkdrop](https://www.inkdrop.app) - [Plugin](https://github.com/inkdropapp/inkdrop-mermaid)
- [Vim](https://www.vim.org)
- [Official Vim Syntax and ftplugin](https://github.com/craigmac/vim-mermaid)
- [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram)
- [Brackets](https://brackets.io/)
- [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview)
- [CKEditor](https://github.com/ckeditor/ckeditor5)
- [CKEditor 5 Mermaid plugin](https://github.com/ckeditor/ckeditor5-mermaid)
- [Draw.io](https://draw.io)
- [Mermaid Plugin](https://github.com/nopeslide/drawio_mermaid_plugin)
- [GNU Emacs](https://www.gnu.org/software/emacs/)
- [Major mode for .mmd files](https://github.com/abrochard/mermaid-mode)
- [Org-Mode integration](https://github.com/arnm/ob-mermaid)
- [Brackets](https://brackets.io/)
- [Mermaid Preview](https://github.com/AlanHohn/mermaid-preview)
- [Iodide](https://github.com/iodide-project/iodide)
- [iodide-mermaid-plugin](https://github.com/iodide-project/iodide-mermaid-plugin)
- [Google docs](https://docs.google.com/)
- [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856)
- [Podlite](https://github.com/zag/podlite-desktop)
- [Named block =Diagram](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams)
- [GNU Nano](https://www.nano-editor.org/)
- [Nano Mermaid](https://github.com/Yash-Singh1/nano-mermaid)
- [CKEditor](https://github.com/ckeditor/ckeditor5)
- [CKEditor 5 Mermaid plugin](https://github.com/ckeditor/ckeditor5-mermaid)
- [Google docs](https://docs.google.com/)
- [Mermaid plugin for google docs](https://workspace.google.com/marketplace/app/mermaid/636321283856)
- [Inkdrop](https://www.inkdrop.app)
- [Mermaid Plugin](https://github.com/inkdropapp/inkdrop-mermaid)
- [Light Table](http://lighttable.com/)
- [Mermaid Plugin](https://github.com/cldwalker/Mermaid)
- [Markdown-It](https://github.com/markdown-it/markdown-it)
- [Textual UML Parser](https://github.com/manastalukdar/markdown-it-textual-uml)
- [Mermaid Plugin](https://github.com/tylingsoft/markdown-it-mermaid)
- [md-it-mermaid](https://github.com/iamcco/md-it-mermaid)
- [markdown-it-mermaid-less](https://github.com/searKing/markdown-it-mermaid-less)
- [Podlite](https://github.com/zag/podlite-desktop)
- [=Diagram block](https://github.com/zag/podlite/tree/main/packages/podlite-diagrams)
- [Standard Notes](https://standardnotes.com/)
- [sn-mermaid](https://github.com/nienow/sn-mermaid)
- [Mermaid Extension](https://github.com/nienow/sn-mermaid)
- [Sublime Text 3](https://sublimetext.com)
- [Mermaid Package](https://packagecontrol.io/packages/Mermaid)
- [VS Code](https://code.visualstudio.com/)
- [Mermaid Editor](https://marketplace.visualstudio.com/items?itemName=tomoyukim.vscode-mermaid-editor)
- [Mermaid Export](https://marketplace.visualstudio.com/items?itemName=Gruntfuggly.mermaid-export)
- [Markdown PDF](https://marketplace.visualstudio.com/items?itemName=yzane.markdown-pdf)
- [Markdown Preview Mermaid Support](https://marketplace.visualstudio.com/items?itemName=bierner.markdown-mermaid)
- [Markdown Preview Enhanced](https://marketplace.visualstudio.com/items?itemName=shd101wyy.markdown-preview-enhanced)
- [Mermaid Preview](https://marketplace.visualstudio.com/items?itemName=vstirbu.vscode-mermaid-preview)
- [Preview](https://marketplace.visualstudio.com/items?itemName=searKing.preview-vscode)
- [Preview Sequence Diagrams](https://marketplace.visualstudio.com/items?itemName=arichika.previewseqdiag-vscode)
- [Mermaid Markdown Syntax Highlighting](https://marketplace.visualstudio.com/items?itemName=bpruitt-goddard.mermaid-markdown-syntax-highlighting)
- [Vim](https://www.vim.org)
- [Vim Diagram Syntax](https://github.com/zhaozg/vim-diagram)
- [Official Vim Syntax and ft plugin](https://github.com/craigmac/vim-mermaid)
### Document Generation
- [Swimm - Up-to-date diagrams with Swimm, the knowledge management tool for code](https://docs.swimm.io/Features/diagrams-and-charts)
- [Sphinx](https://www.sphinx-doc.org/en/master/)
- [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid)
- [remark](https://remark.js.org/)
- [remark-mermaidjs](https://github.com/remcohaszing/remark-mermaidjs)
- [rehype](https://github.com/rehypejs/rehype)
- [rehype-mermaidjs](https://github.com/remcohaszing/rehype-mermaidjs)
- [Codedoc](https://codedoc.cc/)
- [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin)
- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid)
- [Docusaurus](https://docusaurus.io/docs/markdown-features/diagrams) ✅
- [Gatsby](https://www.gatsbyjs.com/)
- [gatsby-remark-mermaid](https://github.com/remcohaszing/gatsby-remark-mermaid)
- [JSDoc](https://jsdoc.app/)
- [jsdoc-mermaid](https://github.com/Jellyvision/jsdoc-mermaid)
- [mdBook](https://rust-lang.github.io/mdBook/index.html)
- [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)
- [MkDocs](https://www.mkdocs.org)
- [mkdocs-mermaid2-plugin](https://github.com/fralau/mkdocs-mermaid2-plugin)
- [mkdocs-material](https://github.com/squidfunk/mkdocs-material), check the [docs](https://squidfunk.github.io/mkdocs-material/reference/diagrams/)
- [Quarto](https://quarto.org/)
- [rehype](https://github.com/rehypejs/rehype)
- [rehype-mermaid](https://github.com/remcohaszing/rehype-mermaid)
- [remark](https://remark.js.org/)
- [remark-mermaidjs](https://github.com/remcohaszing/remark-mermaidjs)
- [Sphinx](https://www.sphinx-doc.org/en/master/)
- [sphinxcontrib-mermaid](https://github.com/mgaitan/sphinxcontrib-mermaid)
- [Type Doc](https://typedoc.org/)
- [typedoc-plugin-mermaid](https://www.npmjs.com/package/typedoc-plugin-mermaid)
- [Docsy Hugo Theme](https://www.docsy.dev/docs/adding-content/lookandfeel/#diagrams-with-mermaid) (native support in theme)
- [Codedoc](https://codedoc.cc/)
- [codedoc-mermaid-plugin](https://www.npmjs.com/package/codedoc-mermaid-plugin)
- [mdbook](https://rust-lang.github.io/mdBook/index.html)
- [mdbook-mermaid](https://github.com/badboy/mdbook-mermaid)
- [Quarto](https://quarto.org/)
- [Typora](https://typora.io/) ([native support](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid))
- [Typora](https://support.typora.io/Draw-Diagrams-With-Markdown/#mermaid) ✅
- [Unison programming language](https://www.unison-lang.org/docs/usage-topics/documentation/)
### Browser Extensions
@@ -200,7 +222,7 @@ Communication tools and platforms
| Diagram Tab | - | - | - | - | [🐙🔗](https://github.com/khafast/diagramtab) |
| Markdown Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/markdown-diagrams/pmoglnmodacnbbofbgcagndelmgaclel/) | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-diagrams/) | [🔴🔗](https://addons.opera.com/en/extensions/details/markdown-diagrams/) | [🌀🔗](https://microsoftedge.microsoft.com/addons/detail/markdown-diagrams/hceenoomhhdkjjijnmlclkpenkapfihe) | [🐙🔗](https://github.com/marcozaccari/markdown-diagrams-browser-extension/tree/master/doc/examples) |
| Markdown Viewer | - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | - | - | [🐙🔗](https://github.com/simov/markdown-viewer) |
| Extensions for Mermaid | - | [🦊🔗](https://addons.mozilla.org/en-US/firefox/addon/markdown-viewer-chrome/) | [🔴🔗](https://addons.opera.com/en/extensions/details/extensions-for-mermaid/) | - | [🐙🔗](https://github.com/Stefan-S/mermaid-extension) |
| Extensions for Mermaid | - | - | [🔴🔗](https://addons.opera.com/en/extensions/details/extensions-for-mermaid/) | - | [🐙🔗](https://github.com/Stefan-S/mermaid-extension) |
| Chrome Diagrammer | [🎡🔗](https://chrome.google.com/webstore/detail/chrome-diagrammer/bkpbgjmkomfoakfklcjeoegkklgjnnpk) | - | - | - | - |
| Mermaid Diagrams | [🎡🔗](https://chrome.google.com/webstore/detail/mermaid-diagrams/phfcghedmopjadpojhmmaffjmfiakfil) | - | - | - | - |
| Monkeys | [🎡🔗](https://chrome.google.com/webstore/detail/monkeys-mermaid-for-githu/cplfdpoajbclbgphaphphcldamfkjlgi) | - | - | - | - |
@@ -208,19 +230,23 @@ Communication tools and platforms
### Other
- [Bisheng](https://www.npmjs.com/package/bisheng)
- [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid)
- [Codemia: A tool to practice system design problems](https://codemia.io) ✅
- [ExDoc](https://github.com/elixir-lang/ex_doc)
- [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs)
- [Jekyll](https://jekyllrb.com/)
- [jekyll-mermaid](https://rubygems.org/gems/jekyll-mermaid)
- [jekyll-mermaid-diagrams](https://github.com/fuzhibo/jekyll-mermaid-diagrams)
- [mermaid-isomorphic](https://github.com/remcohaszing/mermaid-isomorphic)
- [mermaid-server: Generate diagrams using a HTTP request](https://github.com/TomWright/mermaid-server)
- [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io) ✅
- [ui.mermaid(...)](https://nicegui.io/documentation/mermaid)
- [Reveal.js](https://github.com/hakimel/reveal.js)
- [reveal.js-mermaid-plugin](https://github.com/ludwick/reveal.js-mermaid-plugin)
- [Bisheng](https://www.npmjs.com/package/bisheng)
- [bisheng-plugin-mermaid](https://github.com/yct21/bisheng-plugin-mermaid)
- [Reveal CK](https://github.com/jedcn/reveal-ck)
- [reveal-ck-mermaid-plugin](https://github.com/tmtm/reveal-ck-mermaid-plugin)
- [mermaid-isomorphic](https://github.com/remcohaszing/mermaid-isomorphic)
- [mermaid-server: Generate diagrams using a HTTP request](https://github.com/TomWright/mermaid-server)
- [ExDoc](https://github.com/elixir-lang/ex_doc)
- [Rendering Mermaid graphs](https://github.com/elixir-lang/ex_doc#rendering-mermaid-graphs)
- [NiceGUI: Let any browser be the frontend of your Python code](https://nicegui.io)
- [ui.mermaid(...)](https://nicegui.io/reference#mermaid_diagrams)
- [ui.markdown(..., extras=\['mermaid'\])](https://nicegui.io/reference#markdown_element)

View File

@@ -22,9 +22,9 @@ Currently pending [IANA](https://www.iana.org/) recognition.
## Showcase
### Mermaid Slack workspace
### Mermaid Discord workspace
We would love to see what you create with Mermaid. Please share your creations with us in our [Slack](https://join.slack.com/t/mermaid-talk/shared_invite/zt-22p2r8p9y-qiyP1H38GjFQ6S6jbBkOxQ) workspace [#community-showcase](https://mermaid-talk.slack.com/archives/C05NK37LT40) channel.
We would love to see what you create with Mermaid. Please share your creations with us in our [Discord](https://discord.gg/AgrbSrBer3) server [#showcase](https://discord.com/channels/1079455296289788015/1079502635054399649) channel.
### Add to Mermaid Ecosystem

View File

@@ -22,9 +22,16 @@
- **Collaboration** - A web based collaboration feature for multi-user editing on Mermaid diagrams in real-time (Pro plan).
- **Plugins** - A plugin system for extending the functionality of Mermaid. Currently includes [VS Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart) and [ChatGPT](https://www.mermaidchart.com/plugins/chatgpt).
- **Plugins** - A plugin system for extending the functionality of Mermaid.
- **AI** - An AI chatbot that can generate Mermaid diagrams from text (Pro plan).
Plugins are available for:
- [ChatGPT](https://docs.mermaidchart.com/plugins/chatgpt)
- [JetBrains IDE](https://plugins.jetbrains.com/plugin/23043-mermaid-chart)
- [Microsoft PowerPoint and Word](https://appsource.microsoft.com/en-us/product/office/WA200006214?tab=Overview)
- [Visual Studio Code](https://marketplace.visualstudio.com/items?itemName=MermaidChart.vscode-mermaid-chart)
- **AI diagramming** - A feature for generating Mermaid diagrams from text using AI (Pro plan).
- **More** - To learn more, visit our [Product](https://www.mermaidchart.com/product) page.
@@ -40,7 +47,7 @@
Sign up for a free account at [Mermaid Chart](https://www.mermaidchart.com/app/sign-up).
Mermaid Chart is currently offering a 30-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page.
Mermaid Chart is currently offering a 14-day free trial of our newly-launched Pro tier. To learn more, visit our [Pricing](https://mermaidchart.com/pricing) page.
## Mermaid JS contributions

Some files were not shown because too many files have changed in this diff Show More