Compare commits

...

575 Commits

Author SHA1 Message Date
sidharthv96
8acc6c1c53 Update snapshots 2022-12-15 19:14:06 +00:00
sidharthv96
be1656b136 Update snapshots 2022-12-15 19:13:57 +00:00
sidharthv96
33c5ba02e6 Update snapshots 2022-12-15 19:13:47 +00:00
sidharthv96
1015516416 Update snapshots 2022-12-15 19:12:47 +00:00
sidharthv96
d475696534 Update snapshots 2022-12-15 19:09:19 +00:00
sidharthv96
f1634216c4 Update snapshots 2022-12-15 19:09:16 +00:00
Sidharth Vinod
2777ed24f2 Merge branch 'develop' into sidv/e2eCI
* develop: (44 commits)
  Update docs
  Add `workflow_dispatch` to lint.yml
  chore: update docs folder
  lint
  fix typescript error
  fix(docs): build the docs
  fix(docs): remove duplicate section
  chore(deps): update all non-major dependencies
  Update docs/misc/integrations.md
  Add links to github atom add-ons
  remove links from atom.io; add note Atom has been archived
  set svg role to 'graphics-document document'
  common function for a11y; add to renderAsync; + renderAsync spec
  feat: add links to theme listing
  fix cspell
  fix cspell
  fix lint
  refactor theming doc
  remove typeof
  use camelCase
  ...
2022-12-16 00:34:36 +05:30
Sidharth Vinod
579536a151 Pull before commit 2022-12-16 00:32:41 +05:30
Sidharth Vinod
d6fad1bbd8 Merge pull request #3890 from BD103/patch-1
Add links to theme listing
2022-12-16 00:24:15 +05:30
BD103
e2b05d3cf6 Update docs 2022-12-15 18:24:23 +00:00
BD103
1495baac2c Merge branch 'develop' into patch-1 2022-12-15 13:20:45 -05:00
Sidharth Vinod
ff7ed7f49f Merge branch 'develop' of https://github.com/mermaid-js/mermaid into develop
* 'develop' of https://github.com/mermaid-js/mermaid: (40 commits)
  lint
  fix typescript error
  fix(docs): build the docs
  fix(docs): remove duplicate section
  chore(deps): update all non-major dependencies
  Update docs/misc/integrations.md
  Add links to github atom add-ons
  remove links from atom.io; add note Atom has been archived
  set svg role to 'graphics-document document'
  common function for a11y; add to renderAsync; + renderAsync spec
  fix cspell
  fix cspell
  fix lint
  refactor theming doc
  remove typeof
  use camelCase
  make test title clearer
  update /docs
  add test for multi-line accDescr
  use MockedD3, spies in util insertTitle spec (remove MockD3)
  ...
2022-12-15 21:50:06 +05:30
Sidharth Vinod
333b974f10 Add workflow_dispatch to lint.yml 2022-12-15 21:50:00 +05:30
Sidharth Vinod
01039c574c Merge pull request #3914 from tommoor/patch-1
fix: Typescript error in usage
2022-12-15 21:45:06 +05:30
Sidharth Vinod
4e70f327c4 Merge pull request #3897 from weedySeaDragon/feat/3896_a11y-svg-role-graphics-doc-doc
feat: Set svg role to 'graphics-document document'
2022-12-15 21:42:08 +05:30
Sidharth Vinod
54bb2ef00e Merge pull request #3908 from Joxtacy/patch-1
fix(docs): remove duplicate section
2022-12-15 20:39:52 +05:30
BD103
992d1623a7 chore: update docs folder 2022-12-15 09:46:00 -05:00
Tom Moor
78dd03dcdb lint 2022-12-15 09:29:30 -05:00
Tom Moor
9f2d29b68b fix typescript error 2022-12-15 06:09:22 -08:00
Jesper Hasselquist
dfa1d26952 fix(docs): build the docs 2022-12-12 22:32:50 +09:00
Jesper Hasselquist
32fcea3bdd fix(docs): remove duplicate section
Remove duplicate `Return Type` section
2022-12-12 21:39:19 +09:00
renovate[bot]
a975c8c9cd chore(deps): update all non-major dependencies 2022-12-12 04:57:37 +00:00
Alois Klink
e97bef2ff7 Merge pull request #3899 from weedySeaDragon/docs/remove-atom-links
doc: remove links from atom.io; add note Atom has been archived
2022-12-11 00:12:59 +00:00
Ashley Engelund
e4c9aa198e Update docs/misc/integrations.md
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-12-10 13:47:01 -08:00
Ashley Engelund
76e9e07370 Add links to github atom add-ons
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-12-10 13:46:24 -08:00
Ashley Engelund (weedySeaDragon @ github)
de795a915e remove links from atom.io; add note Atom has been archived 2022-12-09 04:56:55 -08:00
Ashley Engelund (weedySeaDragon @ github)
e59b830d74 set svg role to 'graphics-document document' 2022-12-08 11:25:04 -08:00
sidharthv96
2c4443ec71 Update snapshots 2022-12-08 10:12:47 +00:00
Sidharth Vinod
638607da00 reduce failure threshold 2022-12-08 15:36:07 +05:30
Knut Sveidqvist
90d9724d1a Merge pull request #3808 from weedySeaDragon/feat/3626-aria-descBy-roledescription-mocks
Feat: Add aria-describedby, aria-roledescription
2022-12-08 10:44:31 +01:00
sidharthv96
f3e1479c77 Update snapshots 2022-12-08 09:29:38 +00:00
Sidharth Vinod
bc5b9d3937 fix: CI write permissions 2022-12-08 14:54:03 +05:30
Sidharth Vinod
976585401c Upload ci snapshots 2022-12-08 14:22:48 +05:30
Sidharth Vinod
6694bca803 Add ssim:fast 2022-12-08 14:18:24 +05:30
Sidharth Vinod
2a7dc427ae Use ci snapshots 2022-12-08 14:13:25 +05:30
Sidharth Vinod
a3d8f1f8e4 Remove ssim:fast 2022-12-08 14:05:37 +05:30
Sidharth Vinod
688d671d2e Add pingfang font 2022-12-08 14:04:06 +05:30
Sidharth Vinod
b14b23a6af Use ssim fast algorithm 2022-12-08 13:07:23 +05:30
Sidharth Vinod
aa949b4ff6 Increase blur 2022-12-08 12:54:45 +05:30
Sidharth Vinod
e792bf5239 Add blur 2022-12-08 12:54:28 +05:30
Ashley Engelund (weedySeaDragon @ github)
1c9a559362 common function for a11y; add to renderAsync; + renderAsync spec 2022-12-07 10:19:30 -08:00
Ashley Engelund (weedySeaDragon @ github)
b1dd0008bc Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-descBy-roledescription-mocks 2022-12-07 09:31:20 -08:00
Sidharth Vinod
a0d3b8c1fe Increase threshold 2022-12-07 17:22:57 +05:30
Sidharth Vinod
a86f831b3e Remove courier font 2022-12-07 16:24:09 +05:30
Sidharth Vinod
1c794ce619 Add courier font 2022-12-07 15:50:07 +05:30
Sidharth Vinod
86cab46cf0 Try SSIM 2022-12-07 15:07:08 +05:30
Sidharth Vinod
e6e02a9b70 Fix viewport size 2022-12-07 15:03:42 +05:30
Sidharth Vinod
f3a209badc Remove hardcoded width in tests 2022-12-07 14:01:52 +05:30
Sidharth Vinod
69e84b6731 Fix viewport size 2022-12-07 14:01:35 +05:30
Sidharth Vinod
58dca0afe3 add snapshots to repo 2022-12-07 13:26:33 +05:30
Sidharth Vinod
af1a7bea1f add snapshots to repo 2022-12-07 13:26:08 +05:30
Knut Sveidqvist
033201ff1f Merge pull request #3889 from huynhicode/docs/theming
docs: refactor Theming doc
2022-12-07 08:55:00 +01:00
Sidharth Vinod
af212331ef Merge remote-tracking branch 'origin/develop' into pr/BD103/3890
* origin/develop:
  fix: Fail docs:verify on non push events
2022-12-07 11:58:33 +05:30
Sidharth Vinod
59fdaa3b53 fix: Fail docs:verify on non push events 2022-12-07 11:58:09 +05:30
Sidharth Vinod
f2a85eafac Merge remote-tracking branch 'origin/develop' into pr/BD103/3890
* origin/develop:
  chore: Update cspell
  Update docs
  fix: docs build command
  chore: Rebuild docs if linting fails
  chore: Format Mermaid.vue
  Made mermaidConfig a local variable so that it cannot be shared cross rendering.
  Fixed an issue that diagrams disappear from docs pages when switching themes or reloading pages
  Fixed the issue that theme-switch does not work on docs.
  Get base sha from PR
  Run doc lint only if files changed
  Run doc lint only if files changed
  Run doc lint only if files changed
  split lint docs action
  split lint docs action
  fix: File location
  fix(docs): Test auto commit
  fix(docs): Test auto commit
  fix(docs): Test auto commit
  chore: Update docs path
  chore: Auto build docs if only src/docs is changed
2022-12-07 11:50:45 +05:30
Sidharth Vinod
9b547edbe9 Merge pull request #3547 from mermaid-js/sidv/autoBuildDocs
chore(docs): Auto build docs
2022-12-07 11:49:29 +05:30
Sidharth Vinod
48518a56c7 Merge branch 'sidv/autoBuildDocs' of https://github.com/mermaid-js/mermaid into sidv/autoBuildDocs
* 'sidv/autoBuildDocs' of https://github.com/mermaid-js/mermaid:
  Update docs
2022-12-07 11:48:56 +05:30
Sidharth Vinod
1a767ee492 chore: Update cspell 2022-12-07 11:48:51 +05:30
sidharthv96
b2489523f2 Update docs 2022-12-07 06:13:07 +00:00
Sidharth Vinod
7553827985 fix: docs build command 2022-12-07 11:40:17 +05:30
Sidharth Vinod
792c1a8320 chore: Rebuild docs if linting fails 2022-12-07 11:19:44 +05:30
Sidharth Vinod
963a1f1eb1 Merge remote-tracking branch 'origin/develop' into sidv/autoBuildDocs
* origin/develop: (564 commits)
  chore: Format Mermaid.vue
  Made mermaidConfig a local variable so that it cannot be shared cross rendering.
  Fix for issue #3882 moving the label when the path has been modified
  Small fix for issue #3881
  Fixed an issue that diagrams disappear from docs pages when switching themes or reloading pages
  Fixed the issue that theme-switch does not work on docs.
  chore: Fix mindmap link
  chore: Switch back from unpkg to jsdelivr
  delete functions not used in diagrams/c4 code (dead code)
  Minor change
  feat: Add @include support to docs
  feat: Add @include example to docs
  feat: Add @include support to docs
  cleanup
  fix lines
  fix Async rendering
  Revert "sync"
  chore(deps): update pnpm to v7.17.1
  chore(deps): remove dependency on `graphlib`
  test(e2e): make gitgraph snapshots consistent
  ...
2022-12-07 11:11:45 +05:30
Sidharth Vinod
fdf261bda3 chore: Format Mermaid.vue 2022-12-06 15:53:36 +05:30
Sidharth Vinod
f2ee20fdf5 Merge pull request #3880 from ZenUml/defects/issue-3878
Defects/issue 3878
2022-12-06 15:52:15 +05:30
MrCoder
7a086890fd Made mermaidConfig a local variable so that it cannot be shared cross rendering. 2022-12-06 19:44:14 +11:00
BD103
49ca2e3588 feat: add links to theme listing 2022-12-05 17:41:30 -05:00
Knut Sveidqvist
c5653156d9 Merge pull request #3883 from mermaid-js/3882_edge_labels
3882 edge labels
2022-12-05 08:15:15 +01:00
steph
2cce562bc4 fix cspell 2022-12-04 22:10:33 -08:00
steph
f0aea0e6af fix cspell 2022-12-04 22:04:20 -08:00
steph
24560b7d13 fix lint 2022-12-04 21:51:29 -08:00
steph
d451a0c508 refactor theming doc 2022-12-04 21:20:09 -08:00
Ashley Engelund (weedySeaDragon @ github)
96996d0fba Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-descBy-roledescription-mocks 2022-12-03 12:13:12 -08:00
Knut Sveidqvist
4124d186d0 Fix for issue #3882 moving the label when the path has been modified 2022-12-03 13:21:10 +01:00
Knut Sveidqvist
b68fee7e65 Small fix for issue #3881 2022-12-03 11:41:29 +01:00
MrCoder
a1e4ffb3f0 Fixed an issue that diagrams disappear from docs pages when switching themes or reloading pages 2022-12-03 19:30:09 +11:00
MrCoder
c7471f1755 Fixed the issue that theme-switch does not work on docs. 2022-12-03 19:10:05 +11:00
Sidharth Vinod
abc6ee049d Merge pull request #3873 from mermaid-js/sidv/jsdelivr
Switch back to jsdelivr
2022-12-02 13:31:22 +05:30
Ashley Engelund (weedySeaDragon @ github)
bfe3f309d2 remove typeof 2022-12-01 10:09:43 -08:00
Ashley Engelund (weedySeaDragon @ github)
f036d58ec3 Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-descBy-roledescription-mocks
# Conflicts:
#	cypress/integration/rendering/gantt.spec.js
#	cypress/integration/rendering/requirement.spec.js
#	docs/config/setup/modules/mermaidAPI.md
#	packages/mermaid/src/accessibility.js
2022-12-01 10:08:44 -08:00
Sidharth Vinod
bcbf68b7e1 Merge pull request #3871 from weedySeaDragon/chore/c4-remove-unused-code
chore: delete functions not used in diagrams/c4 code (dead code)
2022-12-01 23:07:29 +05:30
Sidharth Vinod
1e30e33ad3 chore: Fix mindmap link 2022-12-01 13:51:50 +05:30
Sidharth Vinod
4b5021c0cc Merge branch 'develop' into sidv/jsdelivr
* develop:
2022-12-01 11:39:52 +05:30
Sidharth Vinod
41033008ec Merge branch 'master' into develop
* master:
  doc: Add mindmap integration docs
  fix: Fetch depth
  fix: Fetch depth
  fix: Fetch depth
  fix: Add commit count to release preview
  fix: Add commit count to release preview
  chore: Add working directory
  fix: release-preview-publish.yml
  Fix #3799: Remove `type` from package.json
2022-12-01 11:39:28 +05:30
Sidharth Vinod
cd0eae2807 chore: Switch back from unpkg to jsdelivr 2022-12-01 11:23:50 +05:30
Sidharth Vinod
8cb6fbfab0 Merge branch 'master' into sidv/jsdelivr
* master:
  doc: Add mindmap integration docs
  fix: Fetch depth
  fix: Fetch depth
  fix: Fetch depth
  fix: Add commit count to release preview
  fix: Add commit count to release preview
  chore: Add working directory
  fix: release-preview-publish.yml
  Fix #3799: Remove `type` from package.json
2022-12-01 11:20:16 +05:30
Ashley Engelund (weedySeaDragon @ github)
6f2b0c43cb delete functions not used in diagrams/c4 code (dead code) 2022-11-30 12:43:27 -08:00
Knut Sveidqvist
650ee31cd1 Merge pull request #3845 from mermaid-js/sidv/eslintCleanup
Housekeeping with eslint-unicorn
2022-11-30 11:53:16 +01:00
Knut Sveidqvist
931d56947a Minor change 2022-11-30 11:27:13 +01:00
Sidharth Vinod
36cf7e0601 Merge pull request #3863 from mermaid-js/sidv/includeMD
Add support for @include in docs
2022-11-30 00:51:29 +05:30
Knut Sveidqvist
ff1d56e9b5 Merge pull request #3846 from mermaid-js/sidv/mermaidDocs
Use current mermaid version in docs.
2022-11-29 17:13:52 +01:00
Knut Sveidqvist
5e98e99f86 Merge pull request #3829 from DanInProgress/fix/stylis-add-idselector
Use stylis to prepend idSelector
2022-11-29 17:10:27 +01:00
Sidharth Vinod
316f612bde feat: Add @include support to docs 2022-11-29 00:54:01 +05:30
Sidharth Vinod
2a5c2b58de feat: Add @include example to docs 2022-11-29 00:34:57 +05:30
Sidharth Vinod
e8703a59ec feat: Add @include support to docs 2022-11-29 00:34:29 +05:30
Sidharth Vinod
3a6dd61f65 cleanup 2022-11-28 16:26:10 +05:30
Sidharth Vinod
bfbb7996e9 fix lines 2022-11-28 16:21:05 +05:30
Sidharth Vinod
1f147b6b63 Merge branch 'develop' into sidv/mermaidDocs
* develop:
  chore(deps): update pnpm to v7.17.1
  chore(deps): remove dependency on `graphlib`
  test(e2e): make gitgraph snapshots consistent
2022-11-28 16:13:27 +05:30
Sidharth Vinod
e302ee383a fix Async rendering 2022-11-28 16:11:24 +05:30
Sidharth Vinod
527a3df083 Revert "sync"
This reverts commit a88a467d45.
2022-11-28 15:44:19 +05:30
Sidharth Vinod
b949da9ae4 Merge pull request #3860 from aloisklink/test/make-git-graph-test-consistent
Make gitgraph snapshots consistent in E2E tests
2022-11-28 15:42:20 +05:30
renovate[bot]
2984e4fc57 chore(deps): update pnpm to v7.17.1 2022-11-28 07:35:36 +00:00
Ashley Engelund (weedySeaDragon @ github)
2bf753a769 use camelCase 2022-11-27 19:17:37 -08:00
Ashley Engelund (weedySeaDragon @ github)
6044e9e9e8 make test title clearer 2022-11-27 19:17:17 -08:00
Ashley Engelund (weedySeaDragon @ github)
e9d4372c41 Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-descBy-roledescription-mocks 2022-11-27 19:10:28 -08:00
Sidharth Vinod
3b91846d0c Merge pull request #3861 from aloisklink/chore/remove-dependency-on-graphlib
chore(deps): remove dependency on `graphlib`
2022-11-28 07:41:50 +05:30
Alois Klink
05b25db5eb chore(deps): remove dependency on graphlib
`graphlib` has recently been replaced with the ESM version of
graphlib bundled with
[`dagre-d3-es`](https://www.npmjs.com/package/dagre-d3-es), in commit
f687abb1 (chore: Use `graphlib` from `dagre-d3-es`, 2022-11-20)

This means we can safely remove it from our dependencies list.

Fixes: f687abb165
2022-11-27 19:13:53 +00:00
Alois Klink
51119f22df test(e2e): make gitgraph snapshots consistent
Add a commit id to 'should render a simple gitgraph with a title',
as otherwise the gitgraph renderer picks a random commit ID, and so
image snapshots will be different.
2022-11-27 18:54:41 +00:00
Ashley Engelund (weedySeaDragon @ github)
2030885fd3 update /docs 2022-11-27 10:46:43 -08:00
Ashley Engelund (weedySeaDragon @ github)
6e486d3c49 add test for multi-line accDescr 2022-11-27 10:32:25 -08:00
Ashley Engelund (weedySeaDragon @ github)
f1bc2deafd use MockedD3, spies in util insertTitle spec (remove MockD3) 2022-11-27 10:14:11 -08:00
Ashley Engelund (weedySeaDragon @ github)
7508cd796d (minor) fix comment, comment typo 2022-11-27 10:13:32 -08:00
Ashley Engelund (weedySeaDragon @ github)
626a4741c0 Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-descBy-roledescription-mocks 2022-11-25 11:30:44 -08:00
Sidharth Vinod
f425a02cf9 Merge branch 'develop' into sidv/mermaidDocs
* develop:
  chore: Fix lint
  test: Update vitest
  Add official vim plugin to list in integrations
  chore: Add lodash-eslint rule
  chore: Add lodash-eslint rule
  feat: Spellcheck docs when building
  fix: Enable extending lintstagedrc.
  fix: lintstagedrc `lint:jison`
  Fix lodash import
  Formatting
  Update .vite/build.ts
  fix Lint
  Add docs back
  fix: Core build externals
  chore: Update dagre-d3-es
  chore: Use `graphlib` from `dagre-d3-es`
  fix: Add types to memoized functions
  chore: Replace lodash with lodash-es
  Cleanup
2022-11-25 16:21:05 +05:30
Sidharth Vinod
3e4dc306d4 Merge pull request #3847 from craigmac/patch-1
Add official vim plugin to list in integrations
2022-11-25 12:01:32 +05:30
Sidharth Vinod
4a4eff55c1 chore: Fix lint 2022-11-25 12:00:31 +05:30
Sidharth Vinod
5e330a6d78 test: Update vitest 2022-11-24 16:33:42 +05:30
C.D. MacEachern
ecf1273c82 Add official vim plugin to list in integrations
364438d1e8 added recognition of Mermaid files to Vim. Link here is to the upstream source from which it comes.
2022-11-23 15:25:06 -05:00
Sidharth Vinod
a4fec411bd Merge branch 'develop' into sidv/eslintCleanup
* develop:
  chore: Add lodash-eslint rule
  chore: Add lodash-eslint rule
  feat: Spellcheck docs when building
  fix: Enable extending lintstagedrc.
  fix: lintstagedrc `lint:jison`
2022-11-23 20:52:36 +05:30
Knut Sveidqvist
50aab56177 Merge pull request #3844 from mermaid-js/sidv/fixLintStaged
fix: LintStaged
2022-11-23 13:52:40 +01:00
Knut Sveidqvist
79c63e9ff4 Merge pull request #3825 from mermaid-js/sidv/optimizeSize
Reduce mermaid size by 31%
2022-11-23 13:52:24 +01:00
Sidharth Vinod
7201c014e3 chore: Cleanup package.json 2022-11-23 16:10:36 +05:30
Sidharth Vinod
cc1c98325c chore: Cleanup package.json 2022-11-23 16:08:41 +05:30
Sidharth Vinod
f8b05f7d75 chore: Cleanup package.json 2022-11-23 16:07:58 +05:30
Sidharth Vinod
6faf54cf6f fix lock 2022-11-23 16:04:38 +05:30
Sidharth Vinod
01a24296b6 Docs 2022-11-23 15:57:50 +05:30
Sidharth Vinod
ab81b508ce Merge branch 'develop' into sidv/mermaidDocs
* develop: (79 commits)
  chore: docs:build
  chore: docs:build
  tiny fix and change: "The/y cannot" -> "Cannot..."
  remove 'horz' from  cSpell.json
  update demos/state.html to includ examples; formatting
  add 'horz' to cSpell (in pieDetector.ts commented out barChart work)
  refine - what is not done yet
  remove 'horz' from  cSpell.json
  Revert "Added pie"
  chore: Fix cSpell in pieRenderer
  update demos/state.html to includ examples; formatting
  add 'horz' to cSpell (in pieDetector.ts commented out barChart work)
  refine - what is not done yet
  remove console stmt
  #3831 Re-enabling themes for er diagrams
  #3835 Adding path to list of elements to be styled
  #3882 fix for issues with mindmaps  with only a single node
  chore(deps): update pnpm to v7.17.0
  docs: Remove warning in readme
  chore(deps): update lycheeverse/lychee-action action to v1.5.4
  ...
2022-11-23 15:57:06 +05:30
Sidharth Vinod
ed6fb15c38 Fix: array concat 2022-11-23 13:39:15 +05:30
Sidharth Vinod
2cefb0fb8f chore: Add lodash-eslint rule 2022-11-23 03:03:19 +05:30
Sidharth Vinod
1dae3a000d chore: Add lodash-eslint rule 2022-11-23 03:03:14 +05:30
Sidharth Vinod
7f4368415d chore: Add eslint-unicorn & fix 2022-11-23 01:05:08 +05:30
Sidharth Vinod
8116c8b40d chore: Add lodash-eslint rule 2022-11-23 00:26:50 +05:30
Sidharth Vinod
32cf349d12 chore: Add lodash-eslint rule 2022-11-23 00:26:37 +05:30
Sidharth Vinod
9da29da63b Merge branch 'develop' into sidv/optimizeSize
* develop: (21 commits)
  chore: docs:build
  chore: docs:build
  tiny fix and change: "The/y cannot" -> "Cannot..."
  remove 'horz' from  cSpell.json
  update demos/state.html to includ examples; formatting
  add 'horz' to cSpell (in pieDetector.ts commented out barChart work)
  refine - what is not done yet
  remove 'horz' from  cSpell.json
  Revert "Added pie"
  chore: Fix cSpell in pieRenderer
  update demos/state.html to includ examples; formatting
  add 'horz' to cSpell (in pieDetector.ts commented out barChart work)
  refine - what is not done yet
  remove console stmt
  #3831 Re-enabling themes for er diagrams
  #3835 Adding path to list of elements to be styled
  #3882 fix for issues with mindmaps  with only a single node
  Integrations added - Visual Studio Code [Polyglot Interactive Notebooks]
  Fix typos
  #3778 Adding a hexgon shape
  ...
2022-11-22 23:49:39 +05:30
Sidharth Vinod
f2ed255137 Merge pull request #3821 from dfinke/develop
Integrations added - Visual Studio Code [Polyglot Interactive Notebooks]
2022-11-22 23:22:19 +05:30
Sidharth Vinod
49348a82e0 chore: docs:build 2022-11-22 23:21:27 +05:30
Sidharth Vinod
d81a922a4f Merge pull request #3841 from weedySeaDragon/feat/1952-state--classDef-documentation
(feat) state  classDef documentation
2022-11-22 23:19:15 +05:30
Sidharth Vinod
1ca49c696a Merge branch 'develop' into feat/1952-state--classDef-documentation
* develop:
  chore: docs:build
  Fix typos
2022-11-22 23:17:33 +05:30
Sidharth Vinod
8e8259934e Merge pull request #3820 from endolith/typos
Fix typos
2022-11-22 23:17:11 +05:30
Sidharth Vinod
66bb19f91a chore: docs:build 2022-11-22 23:17:00 +05:30
Sidharth Vinod
183dee89c2 feat: Spellcheck docs when building
docs.yml is removed as `docs:verify` will cover spellchecks now.
2022-11-22 23:06:12 +05:30
Sidharth Vinod
009a32d20b fix: Enable extending lintstagedrc. 2022-11-22 23:05:27 +05:30
Ashley Engelund (weedySeaDragon @ github)
338d83d4a5 Merge branch 'feat/1952-state--classDef-documentation' of github.com:weedySeaDragon/mermaid into feat/1952-state--classDef-documentation
 Conflicts:
	docs/syntax/stateDiagram.md
	packages/mermaid/src/diagrams/pie/pieDetector.ts
	packages/mermaid/src/docs/syntax/stateDiagram.md
2022-11-22 09:09:40 -08:00
Ashley Engelund (weedySeaDragon @ github)
c3e054c155 tiny fix and change: "The/y cannot" -> "Cannot..." 2022-11-22 08:58:55 -08:00
Ashley Engelund
a09ec69a96 remove 'horz' from cSpell.json
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2022-11-22 08:56:04 -08:00
Ashley Engelund (weedySeaDragon @ github)
7f5b48920c update demos/state.html to includ examples; formatting 2022-11-22 08:56:04 -08:00
Ashley Engelund (weedySeaDragon @ github)
4703523d6b add 'horz' to cSpell (in pieDetector.ts commented out barChart work) 2022-11-22 08:56:04 -08:00
Ashley Engelund (weedySeaDragon @ github)
8066aaeeb0 refine - what is not done yet 2022-11-22 08:55:56 -08:00
Ashley Engelund
828e99d4b9 remove 'horz' from cSpell.json
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2022-11-22 08:49:08 -08:00
Sidharth Vinod
5967289172 fix: lintstagedrc lint:jison 2022-11-22 14:47:49 +05:30
Sidharth Vinod
4143032b66 Merge pull request #3842 from mermaid-js/per/revert-1d9fefe7ac65990e4dd06a7e0e29976a873db844
Revert "Added pie"
2022-11-22 14:39:51 +05:30
Per Brolin
9eb506f6c5 Revert "Added pie"
This reverts commit 1d9fefe7ac.
2022-11-22 10:04:28 +01:00
Sidharth Vinod
231965d36c Merge pull request #3840 from weedySeaDragon/chore/fix-lint-pie-console-stmt
(chore) remove console stmt in pieDetector
2022-11-22 10:53:06 +05:30
Sidharth Vinod
31380368e1 chore: Fix cSpell in pieRenderer 2022-11-22 10:49:45 +05:30
Ashley Engelund (weedySeaDragon @ github)
e2e604a76a update demos/state.html to includ examples; formatting 2022-11-21 17:00:54 -08:00
Ashley Engelund (weedySeaDragon @ github)
98e4b6f338 add 'horz' to cSpell (in pieDetector.ts commented out barChart work) 2022-11-21 17:00:54 -08:00
Ashley Engelund (weedySeaDragon @ github)
e1c2b1ddb5 refine - what is not done yet 2022-11-21 17:00:54 -08:00
Ashley Engelund (weedySeaDragon @ github)
22993e8b6c remove console stmt 2022-11-21 16:35:02 -08:00
Per Brolin
fdbc4ce0ed Merge branch 'develop' of github.com:mermaid-js/mermaid into develop 2022-11-21 14:45:25 +01:00
pbrolin47
96d7666d8e Merge pull request #3837 from mermaid-js/3831_er_theme
#3831 Re-enabling themes for er diagrams
2022-11-21 14:43:41 +01:00
pbrolin47
0e3a558b02 Merge pull request #3836 from mermaid-js/3835_handling_classes_to_paths
Fix for #3835, makes it possible to style path elements
2022-11-21 14:40:10 +01:00
Knut Sveidqvist
f9222a3bf4 #3831 Re-enabling themes for er diagrams 2022-11-21 14:30:06 +01:00
Knut Sveidqvist
78b7941f2d #3835 Adding path to list of elements to be styled 2022-11-21 14:06:09 +01:00
pbrolin47
0d27b1aa65 Merge pull request #3834 from mermaid-js/3778_adding_more_mindmap_shapes
#3778 Adding a hexgon shape
2022-11-21 13:50:53 +01:00
Sidharth Vinod
9b01a07b9d Fix lodash import 2022-11-21 18:13:35 +05:30
pbrolin47
32db43069d Merge pull request #3833 from mermaid-js/3832_mindmaps_single_node
#3882 fix for issues with mindmaps  with only a single node
2022-11-21 13:39:16 +01:00
Sidharth Vinod
89488b60a4 Formatting 2022-11-21 18:06:53 +05:30
Sidharth Vinod
a686255d9e Merge branch 'develop' into sidv/optimizeSize
* develop:
  chore(deps): update pnpm to v7.17.0
  docs: Remove warning in readme
  chore(deps): update lycheeverse/lychee-action action to v1.5.4
  chore: Add size shield in readme
  Fix example for Git diagrams
  Fix TS errors
  Add interface for DiagramDb and other minor changes
  Disallow leading whitespace before delimiter
  Add title support using YAML frontmatter
2022-11-21 18:06:30 +05:30
Knut Sveidqvist
ffb95b4fa9 Merge pull request #3823 from mermaid-js/sidv/viz
Add package visualizations
2022-11-21 13:32:19 +01:00
Knut Sveidqvist
29a02d1ab5 Merge pull request #3809 from aloisklink/use-dagre-d3-es
Replace `dagre`/`dagre-d3` with `dagre-d3-es`
2022-11-21 13:31:35 +01:00
Knut Sveidqvist
564414ecac #3882 fix for issues with mindmaps with only a single node 2022-11-21 13:23:25 +01:00
Knut Sveidqvist
050574f60f Merge pull request #3706 from MasonM/feature/1433_title_support
feat: Title support via front matter for ER, state, class, git, and graph diagrams
2022-11-21 11:44:26 +01:00
renovate[bot]
b9f0c7c807 chore(deps): update pnpm to v7.17.0 2022-11-21 10:05:15 +00:00
Sidharth Vinod
ed6ad77fd9 docs: Remove warning in readme 2022-11-21 11:52:57 +05:30
Dan Fallon
1f64302ae2 Use stylis to prepend idSelector
code previously manually inserted idSelector before the generated CSS.
This could produce incorrect CSS.

Adding & in front of rules will ensure that it behaves properly.
Stylis seems permissive about the lack of nesting selector, but fails
if there is no selector at all. (e.g. "{...props...}")

We should probably do this for each diagram's style.ts files as well
2022-11-20 23:11:05 -06:00
renovate[bot]
a8c5f6d517 chore(deps): update lycheeverse/lychee-action action to v1.5.4 2022-11-21 04:51:51 +00:00
Sidharth Vinod
de99cdfb4c chore: Add size shield in readme
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-11-21 08:22:10 +05:30
Sidharth Vinod
b75ce7af45 Update .vite/build.ts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-11-21 08:18:08 +05:30
Sidharth Vinod
de8ce77f37 fix Lint 2022-11-21 08:16:16 +05:30
Sidharth Vinod
bdace6a4d6 Add docs back 2022-11-21 08:16:16 +05:30
Sidharth Vinod
0e34caa1b0 fix: Core build externals 2022-11-21 08:16:15 +05:30
Sidharth Vinod
13ef403921 chore: Update dagre-d3-es 2022-11-21 08:16:15 +05:30
Sidharth Vinod
f687abb165 chore: Use graphlib from dagre-d3-es 2022-11-21 08:16:08 +05:30
Sidharth Vinod
931661ed67 fix: Add types to memoized functions 2022-11-21 08:13:44 +05:30
Sidharth Vinod
7d3a0577d2 chore: Replace lodash with lodash-es 2022-11-21 08:13:44 +05:30
Sidharth Vinod
4411aa9905 Cleanup 2022-11-21 08:13:44 +05:30
Sidharth Vinod
4890999206 Merge branch 'sidv/viz' into sidv/dagre-es-viz
* sidv/viz:
  Fix Lodash import
  fix: Viz build
  feat: Add package visualization
  Ignore stats.html
  feat: Add bundle visualization
  style(docs): use `github-dark` hightlight theme
  refactor(docs): use default vitepress highlighter
  fix: Move redirection to router
  chore: Add docs to redirect.ts
  feat: Redirect old documentation links.
  comments in states are skipped now
  Remove extra arrow and adjust cross position
2022-11-21 08:13:43 +05:30
Ashley Engelund (weedySeaDragon @ github)
a9c337302a export D3Element from mermaidAPI; use in accessibility 2022-11-20 12:27:29 -08:00
Ashley Engelund
2a98791ec9 use optional chaining check for get acc title and get acc description
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-11-20 12:17:21 -08:00
Sidharth Vinod
8a2d3a400c Fix Lodash import 2022-11-20 19:12:52 +05:30
Sidharth Vinod
29342ea726 fix: Viz build 2022-11-20 17:16:09 +05:30
Sidharth Vinod
4ad99a25d0 feat: Add package visualization 2022-11-20 14:16:22 +05:30
Sidharth Vinod
fc859528e4 Ignore stats.html 2022-11-20 12:13:03 +05:30
Sidharth Vinod
49a931f712 feat: Add bundle visualization 2022-11-20 12:13:00 +05:30
Mason Malone
bdf8b01185 Fix example for Git diagrams 2022-11-19 13:20:12 -08:00
Mason Malone
1b201bf462 Fix TS errors 2022-11-19 13:01:21 -08:00
Mason Malone
3316aa5f4f Add interface for DiagramDb and other minor changes 2022-11-19 12:52:49 -08:00
Mason Malone
a11ab3d5ea Disallow leading whitespace before delimiter 2022-11-19 12:52:49 -08:00
Doug Finke
2a0f6d4cc9 Integrations added - Visual Studio Code [Polyglot Interactive Notebooks] 2022-11-19 11:20:13 -05:00
endolith
e3b9dbdf13 Fix typos 2022-11-19 09:33:01 -05:00
Mason Malone
70f024735b Add title support using YAML frontmatter 2022-11-18 20:42:54 -08:00
Alois Klink
fd76e0e270 chore: replace dagre/dagre-d3 with dagre-d3-es
Replace the dagre and dagre-d3 libraries with dagre-d3-es.

Both dagre and dagre-d3 are deprecated and unmaintained,
and haven't been updated for more than 3 years.

Since dagre-d3 still requires an old version of d3, this causes
a bunch of security warnings,
e.g. https://github.com/advisories/GHSA-36jr-mh4h-2g58

The [dagre-d3-es](https://github.com/tbo47/dagre-es) package is a fork
that contains support for `"d3": "^7.6.1"`. Also, it's ESM, so we will
hopefully get smaller bundle sizes too. The only issue is that this
fork isn't very well used (only has 3000 weekly downloads),
compared to `dagre-d3`'s 250,000 weekly downloads.

(although to be fair, a large proportion of dagre-d3's downloads
 probably come from mermaid)

Since it's is a less popular package,
**I've pinned `dagre-d3-es` to `"7.0.2"` instead of `"^7.0.2"`**.
This does mean if there is a bug in `dagre-d3-es`, we will have to
manually bump it ourselves, but it also means we won't accidentally
be sending a buggy version of `dagre-d3-es` out to users in cases
something changes (it might be worth disabling renovate for this
if we're feeling paranoid!)
2022-11-18 18:33:05 +00:00
Alois Klink
537a627b75 test(e2e): test for mindmap before snapshot
Sometimes, the mindmap e2e tests take a snapshot when the mindmap
SVG has been created, but hasn't yet been fully rendered.

This adds a quick check for a mindmap section root, so that the
snapshot is only taken after the mindmap diagram has started
rendering.

I was also running into JSDoc ESLint warnings, so I moved the file
into a TypeScript file to fix those warnings.
2022-11-18 18:31:14 +00:00
Alois Klink
57edcfe87d test(e2e): remove unused mermaid.spec.js file
All tests have been moved to `mindmap.spec.js` in a previous commit.
2022-11-18 18:07:40 +00:00
Alois Klink
b9dcdb00a5 test(e2e): move mindmap tests to mindmap.spec.js
Currently, we have mindmap tests in the
cypress/integration/rendering/mermaid.spec.js which is a bit
odd. They should probably all be in the mindmap.spec.js file.
2022-11-18 17:58:17 +00:00
Sidharth Vinod
09ed41b7d2 Merge pull request #3807 from aloisklink/docs/update-code-highlighting-theme
Use `github-dark` to highlight fence blocks in vitepress docs
2022-11-18 23:09:59 +05:30
Alois Klink
6e234f135d docs: create some basic mermaid mindmap demos 2022-11-18 17:32:23 +00:00
pbrolin47
e2a0c434cc Merge pull request #3810 from mermaid-js/sidv/doc/mindmap
Mindmap integration docs
2022-11-18 11:01:38 +01:00
pbrolin47
804a23595d Merge pull request #3797 from mermaid-js/sidv/redirectOldDocs
feat: Redirect old documentation links.
2022-11-18 10:46:34 +01:00
Knut Sveidqvist
8655db371e Merge pull request #3762 from avijit1258/bug/3728_comments_not_ignored_composite_states
comments in states are skipped now
2022-11-18 10:45:01 +01:00
Knut Sveidqvist
9b8d5c1b3b Merge pull request #3641 from ishuen/bug/3637_extra_arrow
Remove extra arrow and adjust cross position
2022-11-18 10:38:57 +01:00
Sidharth Vinod
e9f8ba6915 doc: Add mindmap integration docs 2022-11-18 11:28:29 +05:30
Ashley Engelund (weedySeaDragon @ github)
67a015c71d re-re-fixed the contributing doc 2022-11-17 16:58:18 -08:00
Ashley Engelund (weedySeaDragon @ github)
69526402e2 format .md files 2022-11-17 16:51:23 -08:00
Ashley Engelund (weedySeaDragon @ github)
b51759d36e set describeby to accessible description element id 2022-11-17 15:50:52 -08:00
Ashley Engelund (weedySeaDragon @ github)
68b1805c40 (minor) fix typo, whitespace formatting 2022-11-17 15:49:37 -08:00
Ashley Engelund (weedySeaDragon @ github)
9cc862b951 doc: adding diagrams: revise a11y section 2022-11-17 15:48:17 -08:00
Ashley Engelund (weedySeaDragon @ github)
4fb4aa417c doc: revise A11y: fix multi-line ex, +describedby, alpha sort examples 2022-11-17 15:47:22 -08:00
Ashley Engelund (weedySeaDragon @ github)
0adc6a6112 remove a11y from individual diagrams; now happens in mermaidAPI render 2022-11-17 12:28:11 -08:00
Ashley Engelund (weedySeaDragon @ github)
29efc116f3 put a11y into mermaidAPI render; add render spec (mock diagram renderers etc) 2022-11-17 12:27:17 -08:00
Ashley Engelund (weedySeaDragon @ github)
f62c5d9698 add diagram renderer mocks 2022-11-17 12:25:14 -08:00
Ashley Engelund (weedySeaDragon @ github)
1ad537bc4d d3 mock: use MockedD3; remove sequence specific mock code 2022-11-17 12:24:58 -08:00
Ashley Engelund (weedySeaDragon @ github)
1fc02940ae move mocks specific to only seq spec files out of global d3 mock 2022-11-17 12:24:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
8a3c4f64b2 MockedD3: node() return Element; add selectAll() 2022-11-17 12:23:01 -08:00
Ashley Engelund (weedySeaDragon @ github)
4d7496b8dd add error checking (empty diagramType, title, desc) to a11y methods 2022-11-17 12:21:45 -08:00
Ashley Engelund (weedySeaDragon @ github)
03a11e103e (minor) fix typo 2022-11-17 12:19:31 -08:00
Ashley Engelund (weedySeaDragon @ github)
c3313050ce Merge remote-tracking branch 'MERMAID/develop' into feat/3626-aria-roledescription-for-svg 2022-11-17 11:17:18 -08:00
Alois Klink
c30aa6f9cf style(docs): use github-dark hightlight theme
Use the `github-dark` highlight theme for fence blocks in vitepress,
instead of the default `material-palenight` theme.

This increases the contrast ratio of `#comments` from 2.75:1 to 4.43:1,
which is a lot more visible.

It still doesn't reach WCAG 2.0 level AA contrast standards,
which requires 4.5:1 as a minimum constrast ratio, but 4.43:1 is
pretty close, and we don't need to manually modify the theme's colours.
2022-11-17 19:05:41 +00:00
Alois Klink
6da6edfc01 refactor(docs): use default vitepress highlighter
Use the default vitepress highlighter instead of making our own
highlighter using shiki.

The benefits are:
  - We don't need to directly depend on shiki
  - `mermaid-example` code-blocks will use the same highlighting
    as other languages (e.g. `html`/`js`).
  - We can control the theme from the global `vitepress` config.
  - Darkmode/lightmode themes are supported
  - Escaping is already handled by the default highlight function
2022-11-17 19:05:38 +00:00
Sidharth Vinod
461236030c Merge pull request #3798 from weedySeaDragon/bug/1952-stateDiagram--classDef-fix-classes-type
bug: State diagram  fix classes type
2022-11-17 22:01:09 +05:30
Sidharth Vinod
8cc291162f Merge pull request #3735 from aloisklink/ci/disable-pinning-dependencies
CI: disable pinning dependencies
2022-11-17 21:59:06 +05:30
Sidharth Vinod
b83ba4d293 fix: Move redirection to router 2022-11-17 11:14:15 +05:30
Alois Klink
c2bd6a490f ci(renovate): disable pinning dependencies
We shouldn't pin dependencies unless we have to.

This is for two reasons:

- If a dependency has a security issue, users should be able to
  easily update the dependency, before `mermaid` makes a new release
- If using `mermaid.core.js` in an app, using a dependency range
  means that users can bundle less dependencies.
  E.g. they won't need to bundle `lodash@4.17.y` just becasue mermaid
  needs `lodash@4.17.x`.

For development/CI, our dependencies are pinned by pnpm-lock.yaml
file anyway.
2022-11-16 20:00:17 +00:00
Alois Klink
476917bda9 Revert "chore(deps): pin dependencies"
This reverts commit 17b72d565d.
2022-11-16 20:00:16 +00:00
pbrolin47
432d4f41f6 Merge pull request #3802 from mermaid-js/release/9.2.3
Fix #3799: Remove `type` from package.json
2022-11-16 09:29:03 +01:00
Sidharth Vinod
2092330eec fix: Fetch depth 2022-11-16 11:30:58 +05:30
Sidharth Vinod
e05e0f8ae3 fix: Fetch depth 2022-11-16 10:31:49 +05:30
Sidharth Vinod
52ee234c0f fix: Fetch depth 2022-11-16 10:31:07 +05:30
Sidharth Vinod
1d828fe8be fix: Add commit count to release preview 2022-11-16 10:27:42 +05:30
Sidharth Vinod
503114c0eb fix: Add commit count to release preview 2022-11-16 10:22:37 +05:30
Sidharth Vinod
653682a4b8 Merge pull request #3804 from weedySeaDragon/bug/3803_vitepress-config-shiki-import-fix
bug: change shiki getHighlighter import
2022-11-16 10:16:04 +05:30
Sidharth Vinod
1ad63d5b0b chore: Add working directory 2022-11-16 09:49:41 +05:30
Ashley Engelund (weedySeaDragon @ github)
d99707641b add "roledescription" to cSpell list of words (as in 'aria-roledescription') 2022-11-15 13:49:05 -08:00
Ashley Engelund (weedySeaDragon @ github)
0d9566dd71 diagrams: use a11y title,desc specific method (was renamed) 2022-11-15 13:48:35 -08:00
Ashley Engelund (weedySeaDragon @ github)
8d96518092 accessibility.js -> ts; + set aria-roledescription; add spec 2022-11-15 13:47:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
717aca6824 change shiki getHighlighter import 2022-11-15 13:09:16 -08:00
Ashley Engelund (weedySeaDragon @ github)
2cbf6110a6 create separate spec for stateRenderer-v2 2022-11-15 12:30:10 -08:00
Sidharth Vinod
3358406e68 fix: release-preview-publish.yml 2022-11-16 00:06:47 +05:30
Sidharth Vinod
d05fd25339 Fix #3799: Remove type from package.json 2022-11-15 23:59:17 +05:30
Ashley Engelund (weedySeaDragon @ github)
fcec9adbcd diagramStates should not be global; pass it into functions; minor comment fixes 2022-11-15 09:19:27 -08:00
Ashley Engelund (weedySeaDragon @ github)
13f3008f82 diagramClasses no longer needs to be cached; mermaidAPI no longer calls it repeatedly 2022-11-15 09:18:10 -08:00
Ashley Engelund (weedySeaDragon @ github)
6090a1f65a (minor) import expectTypeOf in spec 2022-11-15 09:14:00 -08:00
Ashley Engelund (weedySeaDragon @ github)
1ecd4a551d (minor) fix JSdoc tag 2022-11-15 09:13:27 -08:00
Ashley Engelund (weedySeaDragon @ github)
c6db0524bd + spec stateRenderer-v2.js getClasses() to verify it returns a {} 2022-11-15 09:01:34 -08:00
Ashley Engelund (weedySeaDragon @ github)
d3f5474f38 (minor) fix JSdoc types in comments 2022-11-15 08:59:01 -08:00
Ashley Engelund (weedySeaDragon @ github)
9996e53e24 (minor) add comments, remove duplicated line 2022-11-15 08:50:20 -08:00
Knut Sveidqvist
3b79ee35e0 Merge pull request #3780 from mermaid-js/sidv/mergeMaster
chore: Merge master to develop
2022-11-15 12:47:32 +01:00
Sidharth Vinod
b202b539bf Merge pull request #3765 from spier/feature/check-links-in-docs
Add GHA that will check links + Fix broken links
2022-11-15 14:17:18 +05:30
Sidharth Vinod
e27966c15f chore: Add master to link checker 2022-11-15 14:16:41 +05:30
Sidharth Vinod
18c27c6f1d chore: Add docs to redirect.ts 2022-11-15 11:13:54 +05:30
Ashley Engelund (weedySeaDragon @ github)
345eaade22 stateDB classes must be a {} not [] 2022-11-14 11:39:58 -08:00
Sidharth Vinod
82f63b056f feat: Redirect old documentation links. 2022-11-15 01:06:04 +05:30
Ashley Engelund (weedySeaDragon @ github)
ccd55a0bde add stateDiagram-v2 to list of graphs with classDefs 2022-11-14 11:24:59 -08:00
Sidharth Vinod
846a03663c fix(docs): ClassDiagram table 2022-11-14 22:15:34 +05:30
Sidharth Vinod
a88a467d45 sync 2022-11-14 22:14:27 +05:30
Sidharth Vinod
beab2278d8 feat: Async mermaid docs 2022-11-14 22:06:26 +05:30
Per Brolin
51a84eeb90 Merge branch 'develop' of github.com:mermaid-js/mermaid into develop 2022-11-14 16:34:57 +01:00
Sidharth Vinod
ad6eba452c Merge branch 'develop' into sidv/mergeMaster
* develop:
  fix(deps): update dependency rollup to v3
2022-11-14 16:44:57 +05:30
Sidharth Vinod
eae88c51d2 Cleanup 2022-11-14 16:42:08 +05:30
Sidharth Vinod
752cc3a527 Merge pull request #3674 from mermaid-js/renovate/rollup-3.x
fix(deps): update dependency rollup to v3
2022-11-14 16:41:09 +05:30
Sidharth Vinod
051b4271d3 Cleanup docs 2022-11-14 15:24:47 +05:30
Sidharth Vinod
4decaf0308 chore: Fix tsdoc 2022-11-14 15:17:13 +05:30
Sidharth Vinod
9144fa390f cleanup 2022-11-14 15:05:58 +05:30
Sidharth Vinod
c354d9e1e3 Merge remote-tracking branch 'origin/master' into sidv/mergeMaster
* origin/master: (76 commits)
  fix: `use-inline-specifiers-lockfile-format` to pnpm
  Hacky fix for pnpm issue
  chore: Cleanup pakage.json, fix jisonLint
  feat: Switch CDN
  Updated README-files
  Updated URL
  Updated release
  Increased package version to 9.2.2
  Added registerExternalDiagram for Mindmap
  fix: Remove registerDiagram export
  fix versions
  feat: Add config validator MVP
  Apply suggestions from code review
  fix: Import path in viewer.js
  Cleanup package.json
  Restore package and lock from master
  fix pnpm lock
  Fix pnpm-lock
  Fixing applitools batches
  Fix pnpm
  ...
2022-11-14 14:57:08 +05:30
Sidharth Vinod
77a326dedf Merge Master 2022-11-14 14:51:23 +05:30
Sidharth Vinod
2d9bdedaf5 Merge branch 'develop' into sidv/mergeMaster
* develop:
  chore(deps): update all non-major dependencies
  fix(deps): update all non-major dependencies
  fix: `sourceLinkTemplate` in typedoc
  only call getClasses if the diagram renderer supports it
  fix typo
  merge fix: get classDefs only if diagram is in CLASSDEF_DIAGRAMS
  use lodash isEmpty instead of method defined in utils
  chore: Fix cspell
  fix: Type of DiagramStyleClassDef, general cleanup
  change spec descriptions to active voice (= shorter b/c 'should' isn't needed)
  functions and specs: removeExistingElements
  functions and specs: createUserstyles; minor changes
  functions and specs: createCssStyles, appendDivSvgG,cleanUpSvgCode, putIntoIFrame [for render]
  add MockedD3.ts
  const isSandboxed, isLooseSecurityLevel, fontFamily; a few more CONSTs
  more meaningful var names; move related lines together; const idSelector
  comment the main steps (prepare to break into functions that can be tested)
  render: define const iFrameId, enclosingDivID and _selector to use in function
  specs: encodeEntities, decodeEntities
  render: constants
2022-11-14 13:57:09 +05:30
renovate[bot]
04a99a7cd3 fix(deps): update dependency rollup to v3 2022-11-14 07:51:09 +00:00
Sidharth Vinod
0763590c24 Merge pull request #3791 from mermaid-js/renovate/all-minor-patch
chore(deps): update all non-major dependencies (minor)
2022-11-14 13:18:10 +05:30
Knut Sveidqvist
dfb1440ae0 Merge pull request #3684 from weedySeaDragon/chore/3648-mermaidAPI-render--dry-cleanup-specs
chore: clean up code in mermaidAPI render() and write specs/tests
2022-11-14 08:42:25 +01:00
renovate[bot]
a1e2df8466 chore(deps): update all non-major dependencies 2022-11-14 05:28:23 +00:00
renovate[bot]
20613beb8a fix(deps): update all non-major dependencies 2022-11-14 05:25:07 +00:00
Knut Sveidqvist
292cbd75a8 Merge pull request #3783 from mermaid-js/sidv/cleanupPackage.json
chore: Housekeeping
2022-11-11 09:21:43 +01:00
Sidharth Vinod
88d3fdfb8f fix: use-inline-specifiers-lockfile-format to pnpm 2022-11-11 13:29:59 +05:30
Sidharth Vinod
1f68ea4058 Hacky fix for pnpm issue 2022-11-11 02:41:03 +05:30
Sidharth Vinod
ab92b5c100 chore: Cleanup pakage.json, fix jisonLint 2022-11-11 01:54:29 +05:30
Alois Klink
195f3a5feb ci(lint-checker): lock down permissions
Lock down the GITHUB_TOKEN permissions.

lychee only needs `GITHUB_TOKEN` to read public
data without hitting rate-limits, so having read-only
access to contents should be fine.
2022-11-10 18:23:03 +00:00
Knut Sveidqvist
dcab2c552f Merge pull request #3777 from mermaid-js/sidv/fixCDN
Switch CDN to unpkg.com
2022-11-10 09:58:58 +01:00
Sidharth Vinod
a83f88bdf1 chore: Merge master to develop 2022-11-10 13:51:53 +05:30
Knut Sveidqvist
c781545a40 #3778 Adding a hexgon shape 2022-11-09 20:10:31 +01:00
Sidharth Vinod
791dbe01a2 fix: sourceLinkTemplate in typedoc 2022-11-09 23:48:26 +05:30
Alois Klink
fcd93794ce chore(docs): sync generated markdown docs
Sync generated markdown docs by running
`pnpm --filter mermaid run docs:build`
2022-11-09 17:12:36 +00:00
Sidharth Vinod
0af36f12b7 feat: Switch CDN 2022-11-09 22:38:21 +05:30
Per Brolin
dd5d99eacc Merge branch 'release/9.2.2' 2022-11-09 16:46:44 +01:00
Ashley Engelund (weedySeaDragon @ github)
750029f557 merge MERMAID/develop 2022-11-09 07:45:22 -08:00
Per Brolin
ccfaea8e3f Updated README-files 2022-11-09 16:34:31 +01:00
Per Brolin
0b9b2cfadc Updated URL 2022-11-09 16:26:53 +01:00
Per Brolin
526113517b Updated release 2022-11-09 16:20:28 +01:00
Per Brolin
fb8149b2ca Increased package version to 9.2.2 2022-11-09 16:02:49 +01:00
Sebastian Spier
7350b63e40 Remove unnecesary comment 2022-11-08 13:53:41 +01:00
Sebastian Spier
6543ece92c Fix display label/path for explaining where the docs are located 2022-11-08 13:53:18 +01:00
Sebastian Spier
62f3c4baa6 Revert "Running 'pnpm --filter mermaid run docs:build' as suggested by the previously failing 'lint' GHA"
This reverts commit 66c543cb8f.
2022-11-07 23:07:04 +01:00
Sebastian Spier
66c543cb8f Running 'pnpm --filter mermaid run docs:build' as suggested by the previously failing 'lint' GHA 2022-11-07 23:00:40 +01:00
Sebastian Spier
a19622c807 Revert content of /docs to what is on the develop branch 2022-11-07 22:48:44 +01:00
Sebastian Spier
013ff182c9 Run Prettier 2022-11-07 20:35:00 +01:00
Sebastian Spier
b5d335711f Fixing link to d3 time formatting 2022-11-07 20:23:24 +01:00
Sebastian Spier
5e41b68a3a Remove link to chrome web store app that doesn't exist any more 2022-11-07 17:46:26 +01:00
Sebastian Spier
3b901c4459 More consistent linking: Use the full filename README.md (in config/setup) 2022-11-07 17:00:54 +01:00
Sebastian Spier
f8234369c7 Don't check files that are generated during the build via 'pnpm docs:code' 2022-11-07 16:59:11 +01:00
Sidharth Vinod
0d8f09cec5 Merge pull request #3755 from mermaid-js/sidv/docsDev
Live edits for Docs
2022-11-07 21:22:25 +05:30
Sebastian Spier
23fe5ebddb [docs] To run the docs locally I needed to cd into packages/mermaid. 'docs:dev' is defined in packages/mermaid/package.json 2022-11-07 11:05:02 +01:00
Sebastian Spier
4a45112344 Replace links to '_sidebar.md' with '.vitepress/config.ts' 2022-11-07 10:43:46 +01:00
Sidharth Vinod
91bbab9e2d Lint 2022-11-07 14:30:20 +05:30
Sidharth Vinod
c6287b640d Merge remote-tracking branch 'origin/develop' into sidv/docsDev
* origin/develop:
  chore(deps): update all non-major dependencies
  chore(deps): update all non-major dependencies
  docs: Fix relative links to documentation files
  docs: Update references to default config in directives page
  Fixing applitools batches
  chore: Sync docs
  Fix link to CSS classes
2022-11-07 14:11:06 +05:30
Knut Sveidqvist
c5fe23c26f Merge pull request #3753 from mermaid-js/sidv/cspell
Fix CSpell
2022-11-07 09:40:23 +01:00
Sidharth Vinod
1304e8b00b chore: Move from bin to scripts. 2022-11-07 14:06:35 +05:30
renovate[bot]
603b537ee1 chore(deps): update all non-major dependencies 2022-11-07 07:48:40 +00:00
renovate[bot]
2a45d71efd chore(deps): update all non-major dependencies 2022-11-07 05:36:39 +00:00
Sebastian Spier
5d935c44e7 Add newline 2022-11-06 22:48:31 +01:00
Sebastian Spier
e653d656b3 Fix links that the link checker could not test (for various reasons) 2022-11-06 22:37:47 +01:00
Sebastian Spier
46fc13a5bc Add GHA that checks links (using lychee). Incl list of links to ignore. 2022-11-06 22:35:45 +01:00
Alois Klink
f3d8ada0ca Merge pull request #3760 from spier/patch-1
Fix link relative links to documentation files
2022-11-06 16:28:02 +00:00
Sebastian Spier
705d88360e docs: Fix relative links to documentation files
I noticed that the link to `Tutorials.md` was broken in this README.
While fixing this I found some other broken links in the same section
of the README, that I tried to fix as well.
(I suspect these files were moved at some point)
2022-11-06 16:21:23 +00:00
avijit1258
9e3601ae48 comments in states are skipped now 2022-11-06 01:50:29 -07:00
Sidharth Vinod
3aa2885692 Merge pull request #3738 from raptor0929/patch-1
docs: Update references to default config in directives page
2022-11-04 23:19:27 +05:30
flaura
c56854941e docs: Update references to default config in directives page 2022-11-04 12:54:29 -04:00
Knut Sveidqvist
357a928cce Fixing applitools batches 2022-11-04 13:05:46 +01:00
Per Brolin
1d9fefe7ac Added pie 2022-11-04 12:44:13 +01:00
Sidharth Vinod
d4cc366e86 chore: fix lint 2022-11-04 11:46:48 +05:30
Sidharth Vinod
3d7883f021 Merge pull request #3752 from hugovk/patch-1
Fix link to CSS classes
2022-11-04 11:46:04 +05:30
Sidharth Vinod
41f228c3ff chore: Sync docs 2022-11-04 11:45:20 +05:30
Sidharth Vinod
da447ae5d0 Merge remote-tracking branch 'origin/develop' into sidv/docsDev
* origin/develop: (24 commits)
  chore: fix cSpell word entry misspelling "mermiad" -> "mermaid" (#3751)
  chore: Remove Security from config
  Add Security Policy
  chore: cSpell
  Update contributors
  chore(docs): Update live editor links
  update user story link
  chore: lint
  feat(gantt): Add option 'tickInterval' for custom tick interval
  Convert attr to classed
  Convert attr to style
  Discussions are now available
  Make colors required
  make setup not required
  Update theme_proposal.yml
  Update syntaxt_proposal.yml
  Update diagram_proposal.yml
  Update bug_report.yml
  Delete question.md
  Create syntaxt_proposal.yml
  ...
2022-11-04 11:29:49 +05:30
Sidharth Vinod
f295424087 Merge remote-tracking branch 'origin/develop' into sidv/cspell
* origin/develop:
  chore: fix cSpell word entry misspelling "mermiad" -> "mermaid" (#3751)
2022-11-04 02:13:28 +05:30
Sidharth Vinod
daa85b4279 rename file 2022-11-04 02:09:14 +05:30
Sidharth Vinod
e7369acaea jq -> node 2022-11-04 02:05:50 +05:30
Sidharth Vinod
3ad17b79a6 CSpell format 2022-11-04 01:41:03 +05:30
Hugo van Kemenade
6879a15834 Fix link to CSS classes 2022-11-03 21:48:49 +02:00
Ashley Engelund (weedySeaDragon @ github)
607fe88d43 Merge remote-tracking branch 'MERMAID/develop' into chore/3648-mermaidAPI-render--dry-cleanup-specs
# Conflicts:
#	cSpell.json
2022-11-03 12:15:22 -07:00
Ashley Engelund
b63828f88d chore: fix cSpell word entry misspelling "mermiad" -> "mermaid" (#3751)
* fix misspelled "mermiad" -> 'mermaid' in cSpell.json

* correct misspelled word caught by cspell
2022-11-03 20:03:52 +01:00
Ashley Engelund (weedySeaDragon @ github)
794b642ff8 merge develop into branch. update cSpell.json; run pnpm install 2022-11-03 10:44:04 -07:00
Sidharth Vinod
4870d37027 chore: Remove Security from config 2022-11-03 11:17:24 +05:30
Sidharth Vinod
fb855bfcfa Merge branch 'pr/Andre601/2739' into develop
* pr/Andre601/2739:
  Add Security Policy
  chore: lint
  Discussions are now available
  Make colors required
  make setup not required
  Update theme_proposal.yml
  Update syntaxt_proposal.yml
  Update diagram_proposal.yml
  Update bug_report.yml
  Delete question.md
  Create syntaxt_proposal.yml
  Create theme_proposal.yml
  Create diagram_proposal.yml
  Switch to bug_report.yml
  Create config.yml
2022-11-03 11:15:35 +05:30
Sidharth Vinod
c46a3b09b1 Add Security Policy 2022-11-03 10:53:15 +05:30
Sidharth Vinod
549c2b8d04 Merge pull request #3678 from emersonbottero/develop
Improved New Documentation
2022-11-02 14:27:16 +05:30
Sidharth Vinod
05fd856d62 chore: cSpell 2022-11-02 13:47:42 +05:30
Ashley Engelund (weedySeaDragon @ github)
6d2441dff6 only call getClasses if the diagram renderer supports it 2022-11-01 12:08:59 -07:00
Ashley Engelund (weedySeaDragon @ github)
46ee4e426f fix typo 2022-11-01 10:19:17 -07:00
Ashley Engelund (weedySeaDragon @ github)
469d0f87be merge fix: get classDefs only if diagram is in CLASSDEF_DIAGRAMS 2022-11-01 10:12:48 -07:00
Ashley Engelund (weedySeaDragon @ github)
b20602672e use lodash isEmpty instead of method defined in utils 2022-11-01 10:12:08 -07:00
Ashley Engelund (weedySeaDragon @ github)
6563c0292a merge upstream/develop into branch 2022-11-01 09:53:41 -07:00
Sidharth Vinod
86f835cfc8 Merge branch 'develop' into pr/emersonbottero/3678
* develop:
  chore(docs): Update live editor links
  update user story link
  feat(gantt): Add option 'tickInterval' for custom tick interval
  Convert attr to classed
  Convert attr to style
2022-11-01 21:01:58 +05:30
Sidharth Vinod
4699ba3e71 Update contributors 2022-11-01 20:59:35 +05:30
Sidharth Vinod
7c07bc02af Merge pull request #3741 from 6footGeek/bug/3740_update_user_story_link_in_readme
update user story link for #3740
2022-11-01 19:08:56 +05:30
Sidharth Vinod
1a0d333e2c chore(docs): Update live editor links 2022-11-01 19:07:13 +05:30
Knut Sveidqvist
cd9fac78b8 Merge pull request #3722 from CalebUsadi/fix/convert_attr_to_style
Fix/convert attr to style in er graph
2022-11-01 13:55:27 +01:00
Knut Sveidqvist
4c779beda9 Merge pull request #3729 from DarkNami/feature/1598_add_tick_interval
feat(gantt): Add option 'tickInterval' for custom tick interval
2022-11-01 13:50:38 +01:00
Andy Barlow
114262d353 update user story link 2022-11-01 11:31:10 +00:00
Sidharth Vinod
015e22acf8 feat: Add live updates to docs. 2022-11-01 12:04:34 +05:30
Sidharth Vinod
70ec91d0db docs: Change yarn to pnpm 2022-11-01 10:34:45 +05:30
Sidharth Vinod
61b7033c65 fix: Lint 2022-10-31 22:18:57 +05:30
Sidharth Vinod
a9234785ab chore: Configure typedoc source links 2022-10-31 22:15:07 +05:30
Sidharth Vinod
b735c21a33 chore: Remove test branch 2022-10-31 22:08:04 +05:30
Sidharth Vinod
83fb0f446f Fix base 2022-10-31 22:02:47 +05:30
Sidharth Vinod
78565d16c1 Add pnpm 2022-10-31 21:54:57 +05:30
Sidharth Vinod
2c5a2072b8 Fix lint 2022-10-31 21:51:56 +05:30
Sidharth Vinod
56c2fe3eb1 Publish 2022-10-31 21:46:48 +05:30
Sidharth Vinod
f36e0ef941 chore: Add actions deploy 2022-10-31 21:44:09 +05:30
Sidharth Vinod
c72bdc83c8 chore: Cleanup lintStaged 2022-10-31 20:30:05 +05:30
Sidharth Vinod
3b7463e5ed Precommit Test 2022-10-31 20:27:43 +05:30
Sidharth Vinod
1e410de4cd Precommit Test 2022-10-31 19:54:30 +05:30
Sidharth Vinod
d08701e5c4 Precommit Test 2022-10-31 19:52:57 +05:30
Sidharth Vinod
359a570d77 Precommit Test 2022-10-31 19:51:41 +05:30
Sidharth Vinod
24198ed63e Merge remote-tracking branch 'origin/develop' into pr/emersonbottero/3678
* origin/develop:
  chore(deps): update all non-major dependencies
  chore(deps): update all non-major dependencies
  chore: Update bug report template
2022-10-31 19:43:53 +05:30
renovate[bot]
77782fdbc7 chore(deps): update all non-major dependencies 2022-10-31 12:56:18 +00:00
renovate[bot]
a15b228d3f chore(deps): update all non-major dependencies 2022-10-31 06:48:56 +00:00
Sidharth Vinod
450c308e4f Update packages/mermaid/.lintstagedrc.json
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-10-31 12:04:01 +05:30
Sidharth Vinod
d1e235a08b chore: Ignore packages/mermaid/src/docs/config/setup 2022-10-31 12:01:56 +05:30
Sidharth Vinod
85444dbee9 Merge branch 'develop' of https://github.com/emersonbottero/mermaid into pr/emersonbottero/3678
* 'develop' of https://github.com/emersonbottero/mermaid:
  Apply suggestions from code review
2022-10-31 11:57:58 +05:30
Sidharth Vinod
01ac770037 chore: Review comments 2022-10-31 11:57:50 +05:30
Sidharth Vinod
3675682674 Apply suggestions from code review
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-10-31 11:56:17 +05:30
Sidharth Vinod
a7c9fe77c5 Update packages/mermaid/src/docs.mts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-10-31 11:50:03 +05:30
Emerson Bottero
f87d1630d1 chore: fix most of aloisklink reviews 2022-10-30 21:22:38 -03:00
Sidharth Vinod
ec10316346 chore: lint 2022-10-30 00:07:12 +05:30
Sidharth Vinod
449dfe8b8e Merge remote-tracking branch 'origin/develop' into pr/Andre601/2739
* origin/develop: (1249 commits)
  docs(git): Regenerate
  docs(git): Add a quoted branch name example
  chore: Update bug report template
  fix(git): Support quoted branch names
  Ensure example code and rendered output are synced
  Change fill attribute to style.
  chore(deps): update all non-major dependencies
  chore(deps): pin dependencies
  fix typo
  Update sequenceDiagram.md
  style: fix eslint-plugin-tsdoc linting issues
  style: lint typescript with eslint-plugin-tsdoc
  ran linter
  Update packages/mermaid/src/dagre-wrapper/mermaid-graphlib.js
  Ran linter (npm run lint:fix)
  added curly rule to eslintrc
  fix: Add default arg to options
  Theme update from release 9.2
  testcode
  Delete dependabot.yml
  ...
2022-10-30 00:03:33 +05:30
Sidharth Vinod
4adf79451e Merge remote-tracking branch 'origin/master' into develop
* origin/master:
  chore: Update bug report template
2022-10-29 23:54:05 +05:30
Sidharth Vinod
fed32607de chore: Update docs build vitepress command 2022-10-29 01:14:11 +05:30
Sidharth Vinod
8f5fe38212 chore: format blockquote 2022-10-29 00:56:01 +05:30
Sidharth Vinod
f3cf6d638d chore: Add prettier to docs:code 2022-10-29 00:49:18 +05:30
Sidharth Vinod
e1d9d0b990 chore: Fix doc links 2022-10-29 00:46:25 +05:30
Sidharth Vinod
6e5adbf0ba Merge remote-tracking branch 'origin/develop' into pr/emersonbottero/3678
* origin/develop:
  fix: relative paths
  Update packages/mermaid/src/docs.mts
  docs: Fix docs path in Contributing.md
  docs: Add link to docs source
2022-10-29 00:46:10 +05:30
Sidharth Vinod
38fb926ea8 Merge pull request #3612 from mermaid-js/sidv/linkDocsSource
docs: Add link to docs source
2022-10-29 00:23:12 +05:30
Sidharth Vinod
61e20ce48a chore: update cspell.json 2022-10-29 00:20:54 +05:30
Sidharth Vinod
b0b4cccc96 fix: Team members 2022-10-29 00:16:59 +05:30
Sidharth Vinod
13e5c5ba72 chore: Fix vitepress build 2022-10-28 23:33:57 +05:30
ishuen
81d1dd7465 Remove extra arrow and adjust cross position 2022-10-28 17:01:57 +08:00
Sidharth Vinod
b7d24c8325 chore: Fix favicon 2022-10-28 14:28:57 +05:30
Sidharth Vinod
d7bf92b39f fix: Use AST to replace notes & warnings. 2022-10-28 14:13:24 +05:30
Sidharth Vinod
6b3892baf1 Merge remote-tracking branch 'origin/develop' into pr/emersonbottero/3678
* origin/develop:
  docs(git): Regenerate
  docs(git): Add a quoted branch name example
  fix(git): Support quoted branch names
  Ensure example code and rendered output are synced
  Fill inheritance arrow with background color
2022-10-28 13:02:52 +05:30
Sidharth Vinod
c1529bb7fc Merge pull request #3726 from gibson042/gh-3725-gitgraph-quoted-branch-names
fix(git): Support quoted branch names
2022-10-28 12:44:03 +05:30
Richard Gibson
033f88e8bb docs(git): Regenerate 2022-10-27 23:41:07 -04:00
Richard Gibson
6293a583a4 docs(git): Add a quoted branch name example 2022-10-27 23:35:25 -04:00
Emerson Bottero
ec5568b943 chore: more revision fixes 2022-10-27 19:58:39 -03:00
Sidharth Vinod
f1bfdd4506 Merge pull request #3721 from marcjansen/patch-1
Ensure example code and rendered output are synced
2022-10-27 23:25:11 +05:30
DarkNami
3166f689f9 feat(gantt): Add option 'tickInterval' for custom tick interval
See issue #1598
2022-10-27 16:47:42 +08:00
Ashish Jain
264edddc71 Merge pull request #3543 from vallsv/empty-aroow-for-inheritance
Fill inheritance arrow with background color
2022-10-26 23:13:38 +02:00
Richard Gibson
caf95dec86 fix(git): Support quoted branch names
Fixes #3725
2022-10-26 16:58:09 -04:00
Emerson Bottero
289ac52900 fix : CQ 2022-10-26 17:51:54 -03:00
Emerson Bottero
455839c0b9 fix: Merge conflicts 2022-10-26 16:51:22 -03:00
Emerson Bottero
47e1f611d8 fix: lint and spell errors 2022-10-26 16:24:06 -03:00
Knut Sveidqvist
fb9127ecc6 Merge pull request #3644 from weedySeaDragon/feat/1952-state--classDef-states
feat: [State diagram] Add classDefs and classes to states
2022-10-26 21:22:58 +02:00
Caleb Usadi
a59f49c04f Convert attr to classed 2022-10-26 00:17:20 -04:00
Caleb Usadi
58d692e6f5 Convert attr to style 2022-10-26 00:16:43 -04:00
Emerson Bottero
b62873a195 sync last changes 2022-10-25 17:54:07 -03:00
Marc Jansen
6eb2ce2706 Ensure example code and rendered output are synced 2022-10-25 21:14:13 +02:00
Ashley Engelund (weedySeaDragon @ github)
c413119064 merge MERMAID/develop into branch; fix ts/es lint errors 2022-10-25 08:38:57 -07:00
Ashley Engelund (weedySeaDragon @ github)
599d035daf merge MERMAID/develop into branch 2022-10-25 07:42:57 -07:00
Knut Sveidqvist
10ba3b612e Merge pull request #3719 from CalebUsadi/fix/3711_er_fill_attribute
Change fill attribute to style
2022-10-25 15:01:35 +02:00
Knut Sveidqvist
3dca7d10d5 Merge pull request #3668 from mermaid-js/3659_height_handling
#3659 Adding height when not using maxWidth
2022-10-25 14:48:50 +02:00
Knut Sveidqvist
84628134ed Merge pull request #3652 from uttk/bug/3651_git_graph_option
fix: Fix useMaxWidth option for git graph
2022-10-25 14:48:18 +02:00
Knut Sveidqvist
f4bb978a87 Merge pull request #3649 from DKurilo/feat/3247-statements-aliases
add statement aliases for ER diagram
2022-10-25 14:46:29 +02:00
Knut Sveidqvist
27a68819bc Merge pull request #3647 from DKurilo/feat/1414-notes-to-class-diagram
add the way to add notes to class diagram
2022-10-25 14:45:03 +02:00
Knut Sveidqvist
427eaebd79 Merge pull request #3636 from maiermic/bug/3263-border_attribute_does_not_work_in_a_certain_writing_style
fix: border attribute does not work in a certain writing style
2022-10-25 14:30:29 +02:00
Knut Sveidqvist
3603cc883c Merge pull request #3609 from jasmaa/feature/3593_pie_slice_ordering
Order pie chart slices clockwise by order of entries
2022-10-25 14:24:44 +02:00
Caleb Usadi
fc24373667 Change fill attribute to style. 2022-10-24 23:41:34 -04:00
Knut Sveidqvist
2e571a18bd Merge remote-tracking branch 'origin/develop' into develop 2022-10-24 10:38:45 +02:00
renovate[bot]
728d022f52 chore(deps): update all non-major dependencies 2022-10-24 07:36:58 +00:00
Knut Sveidqvist
fc829a4bde Merge branch 'release_9.2.0_buggfixes' into develop 2022-10-24 08:43:01 +02:00
renovate[bot]
663edabb14 chore(deps): pin dependencies 2022-10-24 04:32:21 +00:00
Sidharth Vinod
22587b9959 Merge pull request #3708 from aloisklink/style/use-eslint-plugin-tsdoc
Use `eslint-plugin-tsdoc` for TypeScript files instead of `eslint-plugin-jsdoc`
2022-10-23 18:16:42 +05:30
Alois Klink
b9f0fb9cd2 Merge pull request #3707 from imgss/patch-1
Update sequenceDiagram.md
2022-10-23 12:59:32 +01:00
shuaisguo
f788ab54f3 fix typo 2022-10-23 10:34:26 +08:00
IMGSS
a1c6d76a15 Update sequenceDiagram.md 2022-10-22 22:43:53 +08:00
Alois Klink
7e5689d0b9 style: fix eslint-plugin-tsdoc linting issues
Mostly, fixing these eslint-plugin-tsdoc style issues involved:
- Moving types from JSDoc to TypeScript types
- Making sure that all `@param paramName - description`
  had both a `-` and a description.

Occasionally, for some functions, if the JSDoc was completely
empty, I just deleted it, since there was no point in keeping it.
2022-10-22 13:30:50 +01:00
Emerson Bottero
563aff2d72 fix: gh pages workflow 2022-10-20 23:03:17 -03:00
Alois Klink
e6f19ff461 style: lint typescript with eslint-plugin-tsdoc 2022-10-20 20:23:28 +01:00
Knut Sveidqvist
f2279d48d8 Merge pull request #3698 from jeroenekkelkamp/chore/3697-eslint-curly
Chore/3697 eslint curly
2022-10-20 13:06:38 +02:00
Jeroen Ekkelkamp
52c5ae6d8e ran linter 2022-10-20 09:14:38 +02:00
Emerson Bottero
870cfdc44c docs: transform custom blocks, warning notes jison 2022-10-20 02:13:18 -03:00
Emerson Bottero
4b64775fde docs: small fixes 2022-10-20 00:13:46 -03:00
Emerson Bottero
4cd1e9a462 docs: contribute with vitepress 2022-10-20 00:06:46 -03:00
Jeroen Ekkelkamp
55d2c928ee Update packages/mermaid/src/dagre-wrapper/mermaid-graphlib.js
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
2022-10-19 21:00:40 +02:00
Jeroen Ekkelkamp
0c4edd332c Ran linter (npm run lint:fix) 2022-10-19 20:06:54 +02:00
Jeroen Ekkelkamp
3d140a7411 added curly rule to eslintrc 2022-10-19 20:04:45 +02:00
Sidharth Vinod
2d11192c3a Merge pull request #3688 from isinek/bug/3655_gantt_demo_diagrams_fail
fix: gantt demo diagrams (#3655)
2022-10-19 23:04:52 +05:30
Sidharth Vinod
3e76edcbac chore: Fix cspell 2022-10-19 22:55:19 +05:30
Sidharth Vinod
f4fa68031e Merge branch 'develop' into pr/weedySeaDragon/3684
* develop: (21 commits)
  Theme update from release 9.2
  testcode
  Delete dependabot.yml
  changed cspell config in eslint from warn to error
  Update .eslintrc.json
  fix cypress tests for erDiagram, add eslint-plugin-no-only-tests plugin because of this comment: https://github.com/mermaid-js/mermaid/pull/3647#issuecomment-1281163858
  chore: Add CORS to vite dev
  configured 3 more words in cspell.json
  removed eslint-ignore statements
  chore(deps): pin dependencies
  chore(deps): update all non-major dependencies (#3671)
  style(sequence): rename lineStarty to lineStartY
  style: fix @cspell/eslint warnings
  test(gantt): remove incorrect comment
  added words to cspell ignore words list, removed mywords.txt
  update: open graph image
  fix: prettier
  remove id attribute
  feat(issue#3675): added open graph meta tags
  updated eslint config and fixed cspell warnings
  ...
2022-10-19 22:48:57 +05:30
Sidharth Vinod
377b22e82b fix: Type of DiagramStyleClassDef, general cleanup 2022-10-19 22:31:37 +05:30
Knut Sveidqvist
4838d63455 Theme update from release 9.2 2022-10-19 14:37:48 +02:00
Knut Sveidqvist
904c011baf Merge remote-tracking branch 'origin/develop' into develop 2022-10-19 14:33:55 +02:00
Knut Sveidqvist
352dd5dcf7 testcode 2022-10-19 14:32:28 +02:00
Sidharth Vinod
c1f51175a1 Delete dependabot.yml 2022-10-19 00:21:52 +05:30
Sidharth Vinod
06b5c192b4 Merge pull request #3604 from devcer/feat/3601-cspell-configuration
Added and configured cspell plugin to eslint
2022-10-19 00:18:06 +05:30
devcer
6f19af2371 changed cspell config in eslint from warn to error 2022-10-18 23:38:30 +05:30
Santosh Viswanatham
c230ff04cb Update .eslintrc.json 2022-10-18 21:03:18 +05:30
Santosh Viswanatham
c71b6e31f7 Merge branch 'develop' into feat/3601-cspell-configuration 2022-10-18 21:02:38 +05:30
Sidharth Vinod
017fc483e7 Merge branch 'develop' of https://github.com/emersonbottero/mermaid into pr/emersonbottero/3678
* 'develop' of https://github.com/emersonbottero/mermaid:
  docs: fix layout problem
  docs: added warning and notes
  docs: added warning and notes
  docs: added warning and notes
  docs: small improvements
2022-10-18 12:29:03 +05:30
Sidharth Vinod
f2571e9930 fix: Live editor links 2022-10-18 12:28:48 +05:30
Sidharth Vinod
111354dd10 Merge pull request #3690 from DKurilo/test-it-only-rule
add eslint-plugin-no-only-tests plugin
2022-10-18 09:26:24 +05:30
Emerson Bottero
66ea491aff docs: fix layout problem 2022-10-18 00:26:36 -03:00
Emerson Bottero
e95eaddf8a docs: added warning and notes 2022-10-18 00:07:14 -03:00
Emerson Bottero
d296049d19 docs: added warning and notes 2022-10-18 00:05:27 -03:00
Emerson Bottero
c45bf055b6 docs: added warning and notes 2022-10-17 23:58:51 -03:00
Emerson Bottero
c8b377bf74 docs: small improvements 2022-10-17 19:32:47 -03:00
Dima Kurilo
20751a6496 fix cypress tests for erDiagram, add eslint-plugin-no-only-tests plugin because of this comment: https://github.com/mermaid-js/mermaid/pull/3647#issuecomment-1281163858 2022-10-17 13:20:17 -04:00
Sidharth Vinod
f6c167db84 Merge pull request #3679 from danangtomo/feat/3675_added_opengraph_meta
Added Open Graph meta tags
2022-10-17 22:15:35 +05:30
Dima Kurilo
75e11b1fde add basic render (cypress) test for classDiagram-v2 too 2022-10-17 12:33:23 -04:00
Dima Kurilo
cead1f36f4 add basic render (cypress test for notes 2022-10-17 12:13:22 -04:00
Dima Kurilo
3108e896b6 add renedering (cypress) tests 2022-10-17 12:03:51 -04:00
Dima Kurilo
d41efa413c add more docs 2022-10-17 09:58:04 -04:00
Dima Kurilo
5803d0abaf update docs 2022-10-17 09:46:10 -04:00
Ivan Sinek
53bc747e9d fix: gantt demo diagrams (#3655) 2022-10-17 14:42:48 +02:00
Sidharth Vinod
2fd94db686 chore: Add CORS to vite dev 2022-10-17 14:01:44 +05:30
devcer
8b64ad971a configured 3 more words in cspell.json 2022-10-17 09:41:59 +05:30
devcer
338e7e83cd removed eslint-ignore statements 2022-10-17 09:33:01 +05:30
devcer
fde3964b50 removed eslint-ignore statements 2022-10-17 09:31:58 +05:30
devcer
aad53f9e61 merged with master 2022-10-17 09:27:42 +05:30
renovate[bot]
17b72d565d chore(deps): pin dependencies 2022-10-17 03:12:28 +00:00
uttk
319f925bdd fix: Fixed git graph to use global setting if useMaxWidth option is not set 2022-10-17 03:07:10 +00:00
renovate[bot]
541de12690 chore(deps): update all non-major dependencies (#3671)
Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
2022-10-16 22:58:11 +02:00
Ashley Engelund (weedySeaDragon @ github)
ea86ef3995 change spec descriptions to active voice (= shorter b/c 'should' isn't needed) 2022-10-16 11:14:57 -07:00
Ashley Engelund (weedySeaDragon @ github)
fcba29f774 functions and specs: removeExistingElements 2022-10-16 11:08:01 -07:00
Ashley Engelund (weedySeaDragon @ github)
166dca55f2 functions and specs: createUserstyles; minor changes 2022-10-16 09:39:31 -07:00
Alois Klink
aa43cfb5ac style(sequence): rename lineStarty to lineStartY
Fixes @cspell/eslint warnings.
2022-10-16 10:24:36 +01:00
Alois Klink
989d716c36 style: fix @cspell/eslint warnings
Ignores some names of contributors, and adjusts some capitilization
spacing to fix all cspell warnings.
2022-10-16 10:23:23 +01:00
Alois Klink
720849a55e test(gantt): remove incorrect comment
This comment seems to have been accidentally added 7 years ago
in 6f96b5dd14
2022-10-16 10:01:36 +01:00
Ashley Engelund (weedySeaDragon @ github)
a3b8c301e2 functions and specs: createCssStyles, appendDivSvgG,cleanUpSvgCode, putIntoIFrame [for render] 2022-10-15 19:15:59 -07:00
Ashley Engelund (weedySeaDragon @ github)
d106d3d1b1 add MockedD3.ts 2022-10-15 19:14:56 -07:00
Ashley Engelund (weedySeaDragon @ github)
a26673c59a const isSandboxed, isLooseSecurityLevel, fontFamily; a few more CONSTs 2022-10-15 13:58:24 -07:00
Ashley Engelund (weedySeaDragon @ github)
5aff154740 more meaningful var names; move related lines together; const idSelector 2022-10-15 13:43:40 -07:00
Ashley Engelund (weedySeaDragon @ github)
2e86031f00 comment the main steps (prepare to break into functions that can be tested) 2022-10-15 13:27:15 -07:00
Ashley Engelund (weedySeaDragon @ github)
978bf4e0ff render: define const iFrameId, enclosingDivID and _selector to use in function 2022-10-15 13:19:58 -07:00
Ashley Engelund (weedySeaDragon @ github)
8aaa7b1ba3 specs: encodeEntities, decodeEntities 2022-10-15 13:14:01 -07:00
Ashley Engelund (weedySeaDragon @ github)
d248952d9e render: constants 2022-10-15 11:11:54 -07:00
Santosh Viswanatham
1f642ca9b6 Merge branch 'develop' into feat/3601-cspell-configuration 2022-10-15 19:48:08 +05:30
devcer
478c387491 added words to cspell ignore words list, removed mywords.txt 2022-10-15 19:43:07 +05:30
Danang Estutomoaji
f532843665 update: open graph image 2022-10-15 17:13:36 +07:00
Danang Estutomoaji
9ba1f7c1f6 fix: prettier 2022-10-15 17:04:12 +07:00
Danang Estutomoaji
b78dc246ec remove id attribute 2022-10-15 11:56:50 +07:00
Danang Estutomoaji
9251176f5e feat(issue#3675): added open graph meta tags 2022-10-15 11:48:02 +07:00
Emerson Bottero
0da56a1249 docs: new Documentation 2022-10-15 00:50:57 -03:00
Emerson Bottero
cbcf7f8a11 docs: new Documentation 2022-10-15 00:50:11 -03:00
renovate[bot]
9ac3992fd2 chore(deps): update all non-major dependencies (minor) (#3632)
* chore(deps): update all non-major dependencies

* chore: add `auto-install-peers` to `.npmrc`

* chore: Update lockfile

* Update docs/index.html

Co-authored-by: Matthieu MOREL <matthieu.morel35@gmail.com>

* Update packages/mermaid/src/docs/index.html

Co-authored-by: Matthieu MOREL <matthieu.morel35@gmail.com>

* Define integrity, crossorigin and referrerpolicy

* Define integrity, crossorigin and referrerpolicy

* chore: format

Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Co-authored-by: Sidharth Vinod <sidharthv96@gmail.com>
Co-authored-by: Matthieu MOREL <matthieu.morel35@gmail.com>
2022-10-14 13:18:19 +02:00
Sidharth Vinod
069951a748 fix: docs 2022-10-14 13:03:27 +05:30
Sidharth Vinod
c913fc8407 Merge pull request #3643 from Some-Dood/refactor-handle-error
feat: make `parseError` function more type-safe
2022-10-14 10:02:23 +05:30
Knut Sveidqvist
4be66554b3 #3659 Adding height when not using maxWidth 2022-10-13 14:26:05 +02:00
Sidharth Vinod
d62c2d1e22 fix: relative paths 2022-10-13 13:51:27 +05:30
Sidharth Vinod
30a3a9ee53 Merge branch 'sidv/linkDocsSource' of https://github.com/mermaid-js/mermaid into sidv/linkDocsSource
* 'sidv/linkDocsSource' of https://github.com/mermaid-js/mermaid:
  Update packages/mermaid/src/docs.mts
2022-10-13 13:49:27 +05:30
Sidharth Vinod
0d5664cc9b Merge branch 'develop' into sidv/linkDocsSource
* develop: (36 commits)
  chore(deps): update actions/setup-node action to v3
  Remove inconsistent and deprecated semicolons
  chore(deps): update actions/checkout action to v3
  docs: Fix initial install step
  docs: Update twitter link
  chore: renovate lint
  Update renovate.json
  chore: Bump node to v18
  chore: Set node v16
  chore: Add volta
  chore(deps): add renovate.json
  Contrbution steps updated
  refactor: use `posix.join()` instead of replacing `\`
  Link added for local setup
  contribution.md updated
  fix: Fix eslint warnings
  fix: docs path in windows
  docs: Add twitter
  docs: Add version to doc index.html
  Update packages/mermaid/src/docs/n00b-gettingStarted.md
  ...
2022-10-13 13:48:36 +05:30
Sidharth Vinod
d03fdfdbca Update packages/mermaid/src/docs.mts
Co-authored-by: Alois Klink <alois@aloisklink.com>
2022-10-13 13:48:00 +05:30
Sidharth Vinod
57b883c7dd Merge pull request #3605 from arpansaha13/sidv/fixWindowsPath
Fix windows paths for `docs:build`
2022-10-13 12:59:07 +05:30
Sidharth Vinod
af0f0ca526 Merge pull request #3657 from revolter/patch-1
Remove inconsistent and deprecated semicolons
2022-10-13 11:29:43 +05:30
Alois Klink
bc9ed8e1bd Merge pull request #3646 from mermaid-js/renovate/actions-setup-node-3.x
chore(deps): update actions/setup-node action to v3
2022-10-13 00:00:09 +01:00
renovate[bot]
673a2e8228 chore(deps): update actions/setup-node action to v3 2022-10-12 22:52:41 +00:00
Alois Klink
75c67ed948 Merge pull request #3645 from mermaid-js/renovate/actions-checkout-3.x
chore(deps): update actions/checkout action to v3
2022-10-12 23:51:51 +01:00
Iulian Onofrei
353895dceb Remove inconsistent and deprecated semicolons 2022-10-12 23:01:29 +03:00
uttk
627ddc0774 fix: Fix useMaxWidth option for git graph 2022-10-12 02:14:56 +00:00
Dima Kurilo
4fc3cc7aff add aliases '0+', '1+' and '1' 2022-10-11 21:57:00 -04:00
Dima Kurilo
3e1b235055 add tests 2022-10-11 19:37:05 -04:00
Dima Kurilo
44706bc32e add statement aliases for ER diagram 2022-10-11 19:02:43 -04:00
renovate[bot]
e5c85cbc64 chore(deps): update actions/checkout action to v3 2022-10-11 20:56:31 +00:00
Ashley Engelund (weedySeaDragon @ github)
589dd70356 common consts; add consts in stateRenderer-v2 (will esp. make theme usage easier) 2022-10-11 13:03:55 -07:00
Ashley Engelund (weedySeaDragon @ github)
85ba4549fb (minor) add "V2" to top level of v2 diagram spec 2022-10-11 13:02:49 -07:00
devcer
adf7702211 updated eslint config and fixed cspell warnings 2022-10-11 22:52:49 +05:30
Ashley Engelund (weedySeaDragon @ github)
ba71afcce5 diagram-v2: store results of stateDb.extract(), apply class to state; code cleanup 2022-10-11 10:19:28 -07:00
Ashley Engelund (weedySeaDragon @ github)
3c0727c744 diagram-v2 spec: added tests for labels, composite; fix typos, 2022-10-11 10:16:57 -07:00
Basti Ortiz
7391baae34 fix: ensure that ParseErrorFunction type alias is compile-time only 2022-10-12 01:14:09 +08:00
Basti Ortiz
4b31112bcb fix: apply new types to the Mermaid API 2022-10-12 01:07:17 +08:00
Basti Ortiz
17ff584d15 feat: account for the fact that an error may be a DetailedError 2022-10-12 01:06:31 +08:00
Ashley Engelund (weedySeaDragon @ github)
79f4eb2e32 stateDb: methods for classDef, (style) classes; update extract(); code cleanup + DRY 2022-10-11 09:53:45 -07:00
Basti Ortiz
e8cd3c0baf fix: use ParseErrorFunction alias for mocks 2022-10-12 00:53:10 +08:00
Basti Ortiz
15f31f9d95 feat: make parseError function more type-safe 2022-10-12 00:32:41 +08:00
Ashley Engelund (weedySeaDragon @ github)
370806365f parser: idStatement returns stmt: 'state'...; add classDef, class statements 2022-10-11 08:36:04 -07:00
Ashley Engelund (weedySeaDragon @ github)
15dd60ab85 state demo: add more diagrams, add explanatory text 2022-10-11 08:34:30 -07:00
Ashley Engelund (weedySeaDragon @ github)
d1f3b889d6 add cypress tests for classDefs and applying classes to states 2022-10-11 08:33:43 -07:00
Ashley Engelund (weedySeaDragon @ github)
7b7db4f60e (minor) API: removed unused flowRenderer import; add comment 2022-10-11 08:33:43 -07:00
Ashley Engelund (weedySeaDragon @ github)
965eae5f45 add spec for stateDB addStyleClass 2022-10-11 08:33:43 -07:00
Ashley Engelund (weedySeaDragon @ github)
278a19f87a state demo add classDefs to example with explanations; add some headers; update composite from docs 2022-10-11 08:33:43 -07:00
Ashley Engelund (weedySeaDragon @ github)
56f3fa6495 API: getClasses() with the diagram renderer (not flowchart renderer); add const 2022-10-11 08:33:43 -07:00
Dima Kurilo
f05f07e44f add the way to add notes to class diagram 2022-10-10 20:53:09 -04:00
Michael Maier
7e8631dd19 fix: vertex property props is overwritten instead of being merged with new value
Fixes #3263
2022-10-10 17:59:29 +02:00
jasmaa
98f4c2d3ae Update pie docs to reflect label order change 2022-10-09 22:20:59 -04:00
lemontreejs
2bb0cf17d1 refactor: use posix.join() instead of replacing \ 2022-10-09 21:03:57 +05:30
Sidharth Vinod
d3de78ffce Merge branch 'develop' into sidv/linkDocsSource
* develop:
  docs: Fix docs path in Contributing.md
2022-10-09 22:30:04 +08:00
Sidharth Vinod
8e93ffffc6 docs: Fix docs path in Contributing.md 2022-10-09 21:11:22 +08:00
Sidharth Vinod
c55add73f6 docs: Add link to docs source 2022-10-09 21:00:02 +08:00
jasmaa
053c966d5f Order pie chart slices clockwise by order of entries 2022-10-08 16:51:11 -04:00
Valentin Valls
1fa84a30c9 Fill inheritance arrow with background color 2022-10-08 19:05:27 +02:00
lemontreejs
622b441eb0 fix: docs path in windows 2022-10-08 20:06:57 +05:30
devcer
4d0da7fba0 Added and configured cspell plugin to eslint 2022-10-08 14:38:41 +05:30
Sidharth Vinod
6f05d4b05a fix: docs path in windows 2022-10-08 12:16:39 +08:00
Sidharth Vinod
ab5111e84f fix: Remove hard coded Path separator 2022-10-08 12:16:24 +08:00
Sidharth Vinod
563c51d431 Get base sha from PR 2022-10-03 14:49:35 +08:00
Sidharth Vinod
455c61b2cf Run doc lint only if files changed 2022-10-03 14:41:52 +08:00
Sidharth Vinod
0a547e524e Run doc lint only if files changed 2022-10-03 14:30:46 +08:00
Sidharth Vinod
9c5c85d34a Run doc lint only if files changed 2022-10-03 14:24:51 +08:00
Sidharth Vinod
8d6af3dfed split lint docs action 2022-10-03 14:21:54 +08:00
Sidharth Vinod
3bae25fe6b split lint docs action 2022-10-03 14:15:28 +08:00
Sidharth Vinod
1d8d677d81 fix: File location 2022-10-03 14:03:44 +08:00
Sidharth Vinod
75db08a60c fix(docs): Test auto commit 2022-10-03 12:05:48 +08:00
Sidharth Vinod
d367e832be fix(docs): Test auto commit 2022-10-03 12:00:59 +08:00
Sidharth Vinod
8d9800c727 fix(docs): Test auto commit 2022-10-03 11:57:19 +08:00
Sidharth Vinod
058f1c2edf chore: Update docs path 2022-10-03 11:55:33 +08:00
Sidharth Vinod
9425b8adc2 Merge remote-tracking branch 'upstream/develop' into sidv/autoBuildDocs
* upstream/develop: (81 commits)
  style(docs): fix prettier issues (extra newline)
  Corrected theme variables reference table layout
  Fix typos in README.md
  build: lint-staged docs in packages/mermaid/src/…
  chore(docs): run `pnpm run docs:build`
  build(docs): fix `pnpm run docs:{build,verify}`
  docs: replace `yarn` with `pnpm` in dev guide
  build: re-enable `prepare` script for husky setup
  build: update pre-commit rules to use `pnpm`
  Arrow tip aligned to edge of box
  updated pnpm-lock file
  ci(e2e): Skip pnpm cache if skipping cypress run
  ci(e2e): remove `headless` arg from cypress run
  build(dev): Fix dev server not showing mermaid.js
  Fixed sample test
  Adding example diagram as a template for a new diagram
  Removed test folder
  Returning the borders to the e2e tests
  Fix for tests
  Updated version
  ...
2022-10-03 11:51:14 +08:00
Sidharth Vinod
21caa3eb72 chore: Auto build docs if only src/docs is changed 2022-10-03 11:50:42 +08:00
Andre_601
fe9a1c59cb Discussions are now available 2022-09-15 01:39:57 +02:00
Andre_601
612a57bdf7 Make colors required 2022-09-15 01:28:59 +02:00
Andre_601
979a376855 make setup not required 2022-09-15 01:28:20 +02:00
Andre_601
13286f66fd Update theme_proposal.yml 2022-02-16 22:18:47 +01:00
Andre_601
9e0c5d1d14 Update syntaxt_proposal.yml 2022-02-16 22:17:54 +01:00
Andre_601
0f092acec3 Update diagram_proposal.yml 2022-02-16 22:16:13 +01:00
Andre_601
56c2f23393 Update bug_report.yml 2022-02-16 22:14:21 +01:00
Andre_601
33903bbf6d Delete question.md 2022-02-16 22:10:24 +01:00
Andre_601
96395c44e0 Create syntaxt_proposal.yml 2022-02-16 22:08:43 +01:00
Andre_601
036dc802dc Create theme_proposal.yml 2022-02-16 22:07:25 +01:00
Andre_601
15ac2f87a3 Create diagram_proposal.yml 2022-02-16 22:01:00 +01:00
Andre_601
8a5d9bbad3 Switch to bug_report.yml 2022-02-16 21:51:02 +01:00
Andre_601
2bcae96d0a Create config.yml 2022-02-16 21:35:33 +01:00
801 changed files with 15493 additions and 34663 deletions

View File

@@ -16,26 +16,27 @@
"extends": [
"eslint:recommended",
"plugin:@typescript-eslint/recommended",
"plugin:jsdoc/recommended",
"plugin:json/recommended",
"plugin:markdown/recommended",
"plugin:@cspell/recommended",
"prettier"
],
"plugins": ["@typescript-eslint", "html", "jest", "jsdoc", "json"],
"plugins": [
"@typescript-eslint",
"no-only-tests",
"html",
"jest",
"jsdoc",
"json",
"@cspell",
"lodash",
"unicorn"
],
"rules": {
"curly": "error",
"no-console": "error",
"no-prototype-builtins": "off",
"no-unused-vars": "off",
"jsdoc/check-indentation": "off",
"jsdoc/check-alignment": "off",
"jsdoc/check-line-alignment": "off",
"jsdoc/multiline-blocks": "off",
"jsdoc/newline-after-description": "off",
"jsdoc/tag-lines": "off",
"jsdoc/require-param-description": "off",
"jsdoc/require-param-type": "off",
"jsdoc/require-returns": "off",
"jsdoc/require-returns-description": "off",
"cypress/no-async-tests": "off",
"@typescript-eslint/ban-ts-comment": [
"error",
@@ -48,7 +49,44 @@
}
],
"json/*": ["error", "allowComments"],
"no-empty": ["error", { "allowEmptyCatch": true }]
"@cspell/spellchecker": [
"error",
{
"checkIdentifiers": false,
"checkStrings": false,
"checkStringTemplates": false
}
],
"no-empty": [
"error",
{
"allowEmptyCatch": true
}
],
"no-only-tests/no-only-tests": "error",
"lodash/import-scope": ["error", "method"],
"unicorn/better-regex": "error",
"unicorn/no-abusive-eslint-disable": "error",
"unicorn/no-array-push-push": "error",
"unicorn/no-for-loop": "error",
"unicorn/no-instanceof-array": "error",
"unicorn/no-typeof-undefined": "error",
"unicorn/no-unnecessary-await": "error",
"unicorn/no-unsafe-regex": "warn",
"unicorn/no-useless-promise-resolve-reject": "error",
"unicorn/prefer-array-find": "error",
"unicorn/prefer-array-flat-map": "error",
"unicorn/prefer-array-index-of": "error",
"unicorn/prefer-array-some": "error",
"unicorn/prefer-default-parameters": "error",
"unicorn/prefer-includes": "error",
"unicorn/prefer-negative-index": "error",
"unicorn/prefer-object-from-entries": "error",
"unicorn/prefer-string-starts-ends-with": "error",
"unicorn/prefer-string-trim-start-end": "error",
"unicorn/string-content": "error",
"unicorn/prefer-spread": "error",
"unicorn/no-lonely-if": "error"
},
"overrides": [
{
@@ -57,6 +95,29 @@
"no-console": "off"
}
},
{
"files": ["*.{js,jsx,mjs,cjs}"],
"extends": ["plugin:jsdoc/recommended"],
"rules": {
"jsdoc/check-indentation": "off",
"jsdoc/check-alignment": "off",
"jsdoc/check-line-alignment": "off",
"jsdoc/multiline-blocks": "off",
"jsdoc/newline-after-description": "off",
"jsdoc/tag-lines": "off",
"jsdoc/require-param-description": "off",
"jsdoc/require-param-type": "off",
"jsdoc/require-returns": "off",
"jsdoc/require-returns-description": "off"
}
},
{
"files": ["*.{ts,tsx}"],
"plugins": ["tsdoc"],
"rules": {
"tsdoc/syntax": "error"
}
},
{
"files": ["*.spec.{ts,js}", "cypress/**", "demos/**", "**/docs/**"],
"rules": {

View File

@@ -3,9 +3,6 @@ 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: Security Vulnerability
url: https://github.com/mermaid-js/.github/blob/main/SECURITY.md
about: Report security issues confidentially.
- 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.

View File

@@ -1,18 +0,0 @@
version: 2
updates:
- package-ecosystem: npm
open-pull-requests-limit: 10
directory: /
target-branch: develop
versioning-strategy: increase
schedule:
interval: weekly
day: monday
time: '07:00'
- package-ecosystem: github-actions
directory: /
target-branch: develop
schedule:
interval: weekly
day: monday
time: '07:00'

View File

@@ -1,28 +0,0 @@
name: Documentation Checks
on:
push:
branches:
- develop
paths:
- 'packages/mermaid/src/docs/**/*'
pull_request:
branches:
- develop
paths:
- 'packages/mermaid/src/docs/**/*'
jobs:
spellcheck:
name: 'Docs: Spellcheck'
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v2
name: Check out the code
- uses: actions/setup-node@v1
name: Setup node
with:
node-version: '16'
- run: npm install -g cspell
name: Install cSpell
- run: cspell --config ./cSpell.json "packages/mermaid/src/docs/**/*.md" --no-progress
name: Run cSpell

View File

@@ -3,7 +3,7 @@ name: E2E
on: [push, pull_request]
permissions:
contents: read
contents: write
jobs:
build:
@@ -28,15 +28,28 @@ jobs:
cache: pnpm
node-version: ${{ matrix.node-version }}
# Experiment with this step if we cannot check-in the snapshots to the repo.
# - name: Cache snapshots
# id: cache-snapshot
# uses: actions/cache@v3
# with:
# # npm cache files are stored in `~/.npm` on Linux/macOS
# path: ./cypress/snapshots
# key: ${{ runner.os }}-build-${env.GITHUB_REF}
# restore-keys: |
# ${{ runner.os }}-build-develop
# Install NPM dependencies, cache them correctly
# and run all Cypress tests
- name: Cypress run
id: cypress
uses: cypress-io/github-action@v4
# If CYPRESS_RECORD_KEY is set, run in parallel on all containers
# Otherwise (e.g. if running from fork), we run on a single container only
if: ${{ ( env.CYPRESS_RECORD_KEY != '' ) || ( matrix.containers == 1 ) }}
with:
start: pnpm run dev
browser: chrome
wait-on: 'http://localhost:9000'
# Disable recording if we don't have an API key
# e.g. if this action was run from a fork
@@ -44,3 +57,18 @@ jobs:
parallel: ${{ secrets.CYPRESS_RECORD_KEY != '' }}
env:
CYPRESS_RECORD_KEY: ${{ secrets.CYPRESS_RECORD_KEY }}
- name: Upload Artifacts
uses: actions/upload-artifact@v3
if: ${{ failure() && steps.cypress.conclusion == 'failure' }}
with:
name: error-snapshots
path: cypress/snapshots/**/__diff_output__/*
- name: Commit changes
uses: EndBug/add-and-commit@v9
if: ${{ github.event_name == 'push' }}
with:
message: 'Update snapshots'
add: 'cypress/snapshots/*'
pull: '--rebase --autostash'

45
.github/workflows/link-checker.yml vendored Normal file
View File

@@ -0,0 +1,45 @@
# This Link Checker is run on all documentation files once per week.
# references:
# - https://github.com/lycheeverse/lychee-action
# - https://github.com/lycheeverse/lychee
name: Link Checker
on:
push:
branches:
- develop
- master
pull_request:
branches:
- develop
- master
schedule:
# * is a special character in YAML so you have to quote this string
- cron: '30 8 * * 5'
jobs:
linkChecker:
runs-on: ubuntu-latest
permissions:
# lychee only uses the GITHUB_TOKEN to avoid rate-limiting
contents: read
steps:
- uses: actions/checkout@v3
- name: Restore lychee cache
uses: actions/cache@v3
with:
path: .lycheecache
key: cache-lychee-${{ github.sha }}
restore-keys: cache-lychee-
- name: Link Checker
uses: lycheeverse/lychee-action@v1.5.4
with:
args: --verbose --no-progress --cache --max-cache-age 1d packages/mermaid/src/docs/**/*.md README.md README.zh-CN.md
fail: true
jobSummary: true
env:
GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

View File

@@ -7,9 +7,10 @@ on:
- opened
- synchronize
- ready_for_review
workflow_dispatch:
permissions:
contents: read
contents: write
jobs:
lint:
@@ -39,4 +40,19 @@ jobs:
run: pnpm run lint
- name: Verify Docs
id: verifyDocs
working-directory: ./packages/mermaid
continue-on-error: ${{ github.event_name == 'push' }}
run: pnpm run docs:verify
- name: Rebuild Docs
if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }}
working-directory: ./packages/mermaid
run: pnpm run docs:build
- name: Commit changes
uses: EndBug/add-and-commit@v9
if: ${{ steps.verifyDocs.outcome == 'failure' && github.event_name == 'push' }}
with:
message: 'Update docs'
add: 'docs/*'

62
.github/workflows/publish-docs.yml vendored Normal file
View File

@@ -0,0 +1,62 @@
name: Deploy Vitepress docs to Pages
on:
# Runs on pushes targeting the default branch
push:
branches:
- master
# Allows you to run this workflow manually from the Actions tab
workflow_dispatch:
# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
permissions:
contents: read
pages: write
id-token: write
# Allow one concurrent deployment
concurrency:
group: 'pages'
cancel-in-progress: true
jobs:
# Build job
build:
runs-on: ubuntu-latest
steps:
- name: Checkout
uses: actions/checkout@v3
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v3
with:
cache: pnpm
node-version: 18
- name: Install Packages
run: pnpm install --frozen-lockfile
- name: Setup Pages
uses: actions/configure-pages@v2
- name: Run Build
run: pnpm --filter mermaid run docs:build:vitepress
- name: Upload artifact
uses: actions/upload-pages-artifact@v1
with:
path: packages/mermaid/src/vitepress/.vitepress/dist
# Deployment job
deploy:
environment:
name: github-pages
runs-on: ubuntu-latest
needs: build
steps:
- name: Deploy to GitHub Pages
id: deployment
uses: actions/deploy-pages@v1

View File

@@ -10,22 +10,30 @@ jobs:
runs-on: ubuntu-latest
steps:
- uses: actions/checkout@v3
with:
fetch-depth: 0
- uses: pnpm/action-setup@v2
- name: Setup Node.js
uses: actions/setup-node@v3
with:
cache: pnpm
node-version: 18.x
- name: Install Yarn
run: npm i yarn --global
- name: Install Packages
run: |
pnpm install --frozen-lockfile
env:
CYPRESS_CACHE_FOLDER: .cache/Cypress
- name: Install Json
run: npm i json --global
- name: Install Packages
run: yarn install --frozen-lockfile
- name: Publish
working-directory: ./packages/mermaid
run: |
PREVIEW_VERSION=8
PREVIEW_VERSION=$(git log --oneline "origin/$GITHUB_REF_NAME" ^"origin/master" | wc -l)
VERSION=$(echo ${{github.ref}} | tail -c +20)-preview.$PREVIEW_VERSION
echo $VERSION
npm version --no-git-tag-version --allow-same-version $VERSION

5
.gitignore vendored
View File

@@ -26,12 +26,13 @@ Gemfile.lock
/.vs
cypress/screenshots/
cypress/snapshots/
cypress/snapshots-dev/
# eslint --cache file
.eslintcache
.tsbuildinfo
tsconfig.tsbuildinfo
knsv*.html
knsv*.html
local*.html
stats/

View File

@@ -1,6 +0,0 @@
{
"packages/mermaid/src/docs/**": ["pnpm run docs:build --git"],
"packages/mermaid/src/docs.mts": ["pnpm run docs:build --git"],
"*.{ts,js,json,html,md,mts}": ["eslint --fix", "prettier --write"],
"*.jison": ["pnpm run lint:jison"]
}

5
.lintstagedrc.mjs Normal file
View File

@@ -0,0 +1,5 @@
export default {
'!(docs/**/*)*.{ts,js,json,html,md,mts}': ['eslint --fix', 'prettier --write'],
'cSpell.json': ['ts-node-esm scripts/fixCSpell.ts'],
'**/*.jison': ['pnpm -w run lint:jison'],
};

13
.lycheeignore Normal file
View File

@@ -0,0 +1,13 @@
# These links are ignored by our link checker https://github.com/lycheeverse/lychee
# The file allows you to list multiple regular expressions for exclusion (one pattern per line).
# Network error: Forbidden
https://codepen.io
# Network error: The certificate was not trusted
https://mkdocs.org/
https://osawards.com/javascript/#nominees
https://osawards.com/javascript/2019
# Don't check files that are generated during the build via `pnpm docs:code`
packages/mermaid/src/docs/config/setup/*

3
.npmrc
View File

@@ -1,2 +1,3 @@
auto-install-peers=true
strict-peer-dependencies=false
strict-peer-dependencies=false
use-inline-specifiers-lockfile-format=true

View File

@@ -3,4 +3,5 @@ cypress/platform/xss3.html
.cache
coverage
# Autogenerated by PNPM
pnpm-lock.yaml
pnpm-lock.yaml
stats

View File

@@ -1,10 +1,12 @@
import { build, InlineConfig } from 'vite';
import { build, InlineConfig, type PluginOption } from 'vite';
import { resolve } from 'path';
import { fileURLToPath } from 'url';
import jisonPlugin from './jisonPlugin.js';
import pkg from '../package.json' assert { type: 'json' };
import { readFileSync } from 'fs';
import { visualizer } from 'rollup-plugin-visualizer';
import type { TemplateType } from 'rollup-plugin-visualizer/dist/plugin/template-types.js';
const { dependencies } = pkg;
const visualize = process.argv.includes('--visualize');
const watch = process.argv.includes('--watch');
const mermaidOnly = process.argv.includes('--mermaid');
const __dirname = fileURLToPath(new URL('.', import.meta.url));
@@ -14,6 +16,20 @@ type OutputOptions = Exclude<
undefined
>['output'];
const visualizerOptions = (packageName: string, core = false): PluginOption[] => {
if (packageName !== 'mermaid' || !visualize) {
return [];
}
return ['network', 'treemap', 'sunburst'].map((chartType) =>
visualizer({
filename: `./stats/${chartType}${core ? '.core' : ''}.html`,
template: chartType as TemplateType,
gzipSize: true,
brotliSize: true,
})
);
};
const packageOptions = {
mermaid: {
name: 'mermaid',
@@ -40,7 +56,7 @@ interface BuildOptions {
}
export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions): InlineConfig => {
const external = ['require', 'fs', 'path'];
const external: (string | RegExp)[] = ['require', 'fs', 'path'];
console.log(entryName, packageOptions[entryName]);
const { name, file, packageName } = packageOptions[entryName];
let output: OutputOptions = [
@@ -59,9 +75,14 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
];
if (core) {
const { dependencies } = JSON.parse(
readFileSync(resolve(__dirname, `../packages/${packageName}/package.json`), 'utf-8')
);
// Core build is used to generate file without bundled dependencies.
// This is used by downstream projects to bundle dependencies themselves.
external.push(...Object.keys(dependencies));
// Ignore dependencies and any dependencies of dependencies
// Adapted from the RegEx used by `rollup-plugin-node`
external.push(new RegExp('^(?:' + Object.keys(dependencies).join('|') + ')(?:/.+)?$'));
// This needs to be an array. Otherwise vite will build esm & umd with same name and overwrite esm with umd.
output = [
{
@@ -93,7 +114,7 @@ export const getBuildConfig = ({ minify, core, watch, entryName }: BuildOptions)
resolve: {
extensions: ['.jison', '.js', '.ts', '.json'],
},
plugins: [jisonPlugin()],
plugins: [jisonPlugin(), ...visualizerOptions(packageName, core)],
};
if (watch && config.build) {
@@ -119,10 +140,7 @@ const buildPackage = async (entryName: keyof typeof packageOptions) => {
const main = async () => {
const packageNames = Object.keys(packageOptions) as (keyof typeof packageOptions)[];
for (const pkg of packageNames) {
if (mermaidOnly && pkg !== 'mermaid') {
continue;
}
for (const pkg of packageNames.filter((pkg) => !mermaidOnly || pkg === 'mermaid')) {
await buildPackage(pkg);
}
};
@@ -133,6 +151,9 @@ if (watch) {
build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-mindmap' }));
// build(getBuildConfig({ minify: false, watch, entryName: 'mermaid-example-diagram' }));
}
} else if (visualize) {
await build(getBuildConfig({ minify: false, core: true, entryName: 'mermaid' }));
await build(getBuildConfig({ minify: false, core: false, entryName: 'mermaid' }));
} else {
void main();
}

View File

@@ -1,6 +0,0 @@
{
"extends": "../tsconfig.json",
"compilerOptions": {
"module": "ES2022"
}
}

11
.vscode/launch.json vendored
View File

@@ -12,6 +12,17 @@
"args": ["run", "${relativeFile}"],
"smartStep": true,
"console": "integratedTerminal"
},
{
"name": "Docs generation",
"type": "node",
"request": "launch",
"args": ["src/docs.mts"],
"runtimeArgs": ["--loader", "ts-node/esm"],
"cwd": "${workspaceRoot}/packages/mermaid",
"skipFiles": ["<node_internals>/**", "**/node_modules/**"],
"smartStep": true,
"internalConsoleOptions": "openOnSessionStart"
}
]
}

View File

@@ -32,7 +32,7 @@ We make all changes via pull requests. As we have many pull requests from develo
- Large changes reviewed by knsv or other developer asked to review by knsv
- Smaller low-risk changes like dependencies, documentation, etc. can be merged by active collaborators
- Documentation (updates to the `src/docs` folder is also allowed via direct commits)
- Documentation (updates to the `package/mermaid/src/docs` folder is also allowed via direct commits)
To commit code, create a branch, let it start with the type like feature or bug followed by the issue number for reference and some describing text.
@@ -67,31 +67,22 @@ flowchart LR
### The official documentation site
**[The mermaid documentation site](https://mermaid-js.github.io/mermaid/) is powered by [Docsify](https://docsify.js.org), a simple documentation site generator.**
**[The mermaid documentation site](https://mermaid-js.github.io/mermaid/) is powered by [Vitepress](https://vitepress.vuejs.org/), a simple documentation site generator.**
If you want to preview the whole documentation site on your machine, you need to install `docsify-cli`:
If you want to preview the whole documentation site on your machine:
```sh
$ npm i docsify-cli -g
cd packages/mermaid
pnpm i
pnpm docs:dev
```
If you are more familiar with Yarn, you can use the following command:
You can now build and serve the documentation site:
```sh
$ yarn global add docsify-cli
pnpm docs:serve
```
The above command will install `docsify-cli` globally.
If the installation is successful, the command `docsify` will be available in your `PATH`.
You can now run the following command to serve the documentation site:
```sh
$ docsify serve docs
```
Once the local HTTP server is listening, you can point your browser at http://localhost:3000.
## Branching
Going forward we will use a git flow inspired approach to branching. So development is done in develop, to do the development in the develop.
@@ -152,7 +143,7 @@ The source files for documentation are in `/packages/mermaid/src/docs` and are w
#### Adding to or changing the documentation organization
If you want to add a new section or change the organization (structure), then you need to make sure to **change the side navigation** in `src/docs/_sidebar.md`.
If you want to add a new section or change the organization (structure), then you need to make sure to **change the side navigation** in `mermaid/src/docs/.vitepress/config.js`.
When changes are committed and then released, they become part of the `master` branch and become part of the published documentation on https://mermaid-js.github.io/mermaid/

View File

@@ -1,23 +1,6 @@
# mermaid
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](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/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
# Whoa, what's going on here?
We are transforming the Mermaid repository to a so called mono-repo. This is a part of the effort to decouple the diagrams from the core of mermaid. This will:
- Make it possible to select which diagrams to include on your site
- Open up for lazy loading
- Make it possible to add diagrams from outside of the Mermaid repository
- Separate the release flow between different diagrams and the Mermaid core
As such be aware of some changes..
# We use pnpm now
# The source code has moved
It is now located in the src folder for each respective package located as subfolders in packages.
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](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/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
English | [简体中文](./README.zh-CN.md)
@@ -43,12 +26,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/Tutorials.md) has video tutorials.
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/integrations.md).
[Tutorials](./docs/config/Tutorials.md) has video tutorials.
Use Mermaid with your favorite applications, check out the list of [Integrations and Usages of Mermaid](./docs/misc/integrations.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/integrations.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/misc/integrations.md).
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/n00b-overview.md), [Usage](./docs/usage.md) and [Tutorials](./docs/Tutorials.md).
For a more detailed introduction to Mermaid and some of its more basic uses, look to the [Beginner's Guide](./docs/community/n00b-overview.md), [Usage](./docs/config/usage.md) and [Tutorials](./docs/config/Tutorials.md).
🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [Documentation](https://mermaidjs.github.io) | 🙌 [Contribution](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | 📜 [Changelog](./docs/CHANGELOG.md)
@@ -354,7 +337,11 @@ To report a vulnerability, please e-mail security@mermaid.live with a descriptio
A quick note from Knut Sveidqvist:
> _Many thanks to the [d3](https://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!_ >_Thanks also to the [js-sequence-diagram](https://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering._ >_Thank you to [Tyler Long](https://github.com/tylerlong) who has been a collaborator since April 2017._
> _Many thanks to the [d3](https://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!_
>
> _Thanks also to the [js-sequence-diagram](https://bramp.github.io/js-sequence-diagrams) project for usage of the grammar for the sequence diagrams. Thanks to Jessica Peter for inspiration and starting point for gantt rendering._
>
> _Thank you to [Tyler Long](https://github.com/tylerlong) who has been a collaborator since April 2017._
>
> _Thank you to the ever-growing list of [contributors](https://github.com/knsv/mermaid/graphs/contributors) that brought the project this far!_

View File

@@ -1,6 +1,6 @@
# mermaid
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](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/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
[![Build CI Status](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml/badge.svg)](https://github.com/mermaid-js/mermaid/actions/workflows/build.yml) [![NPM](https://img.shields.io/npm/v/mermaid)](https://www.npmjs.com/package/mermaid) [![npm minified gzipped bundle size](https://img.shields.io/bundlephobia/minzip/mermaid)](https://bundlephobia.com/package/mermaid) [![Coverage Status](https://coveralls.io/repos/github/mermaid-js/mermaid/badge.svg?branch=master)](https://coveralls.io/github/mermaid-js/mermaid?branch=master) [![CDN Status](https://img.shields.io/jsdelivr/npm/hm/mermaid)](https://www.jsdelivr.com/package/npm/mermaid) [![NPM](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/twitter/follow/mermaidjs_?style=social)](https://twitter.com/mermaidjs_)
[English](./README.md) | 简体中文
@@ -24,9 +24,9 @@ Mermaid 是一个基于 Javascript 的图表绘制工具,通过解析类 Markd
Mermaid 通过允许用户创建便于修改的图表来解决这一难题,它也可以作为生产脚本(或其他代码)的一部分。<br/>
<br/>
Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://mermaid.live/) 轻松创建详细的图表。<br/>
你可以访问 [教程](./docs/Tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/integrations.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
你可以访问 [教程](./docs/config/Tutorials.md) 来查看 Live Editor 的视频教程,也可以查看 [Mermaid 的集成和使用](./docs/misc/integrations.md) 这个清单来检查你的文档工具是否已经集成了 Mermaid 支持。
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/n00b-overview.md), [用法](./docs/usage.md) 和 [教程](./docs/Tutorials.md).
如果想要查看关于 Mermaid 更详细的介绍及基础使用方式,可以查看 [入门指引](./docs/community/n00b-overview.md), [用法](./docs/config/usage.md) 和 [教程](./docs/config/Tutorials.md).
🌐 [CDN](https://unpkg.com/mermaid/) | 📖 [文档](https://mermaidjs.github.io) | 🙌 [贡献](https://github.com/mermaid-js/mermaid/blob/develop/CONTRIBUTING.md) | 📜 [更新日志](./docs/CHANGELOG.md)
@@ -39,7 +39,7 @@ Mermaid 甚至能让非程序员也能通过 [Mermaid Live Editor](https://merma
<table>
<!-- <Flowchart> -->
### 流程图 [<a href="https://mermaid-js.github.io/mermaid/#/flowchart">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
### 流程图 [<a href="https://mermaid-js.github.io/mermaid/#/flowchart">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ3JhcGggVERcbiAgICBBW0hhcmRdIC0tPnxUZXh0fCBCKFJvdW5kKVxuICAgIEIgLS0-IEN7RGVjaXNpb259XG4gICAgQyAtLT58T25lfCBEW1Jlc3VsdCAxXVxuICAgIEMgLS0-fFR3b3wgRVtSZXN1bHQgMl0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
```
flowchart LR
@@ -57,7 +57,7 @@ C -->|One| D[Result 1]
C -->|Two| E[Result 2]
```
### 时序图 [<a href="https://mermaid-js.github.io/mermaid/#/sequenceDiagram">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5BbGljZS0-PkpvaG46IEhlbGxvIEpvaG4sIGhvdyBhcmUgeW91P1xubG9vcCBIZWFsdGhjaGVja1xuICAgIEpvaG4tPj5Kb2huOiBGaWdodCBhZ2FpbnN0IGh5cG9jaG9uZHJpYVxuZW5kXG5Ob3RlIHJpZ2h0IG9mIEpvaG46IFJhdGlvbmFsIHRob3VnaHRzIVxuSm9obi0tPj5BbGljZTogR3JlYXQhXG5Kb2huLT4-Qm9iOiBIb3cgYWJvdXQgeW91P1xuQm9iLS0-PkpvaG46IEpvbGx5IGdvb2QhIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
### 时序图 [<a href="https://mermaid-js.github.io/mermaid/#/sequenceDiagram">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoic2VxdWVuY2VEaWFncmFtXG5BbGljZS0-PkpvaG46IEhlbGxvIEpvaG4sIGhvdyBhcmUgeW91P1xubG9vcCBIZWFsdGhjaGVja1xuICAgIEpvaG4tPj5Kb2huOiBGaWdodCBhZ2FpbnN0IGh5cG9jaG9uZHJpYVxuZW5kXG5Ob3RlIHJpZ2h0IG9mIEpvaG46IFJhdGlvbmFsIHRob3VnaHRzIVxuSm9obi0tPj5BbGljZTogR3JlYXQhXG5Kb2huLT4-Qm9iOiBIb3cgYWJvdXQgeW91P1xuQm9iLS0-PkpvaG46IEpvbGx5IGdvb2QhIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
```
sequenceDiagram
@@ -83,7 +83,7 @@ John->>Bob: How about you?
Bob-->>John: Jolly good!
```
### 甘特图 [<a href="https://mermaid-js.github.io/mermaid/#/gantt">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ2FudHRcbnNlY3Rpb24gU2VjdGlvblxuQ29tcGxldGVkIDpkb25lLCAgICBkZXMxLCAyMDE0LTAxLTA2LDIwMTQtMDEtMDhcbkFjdGl2ZSAgICAgICAgOmFjdGl2ZSwgIGRlczIsIDIwMTQtMDEtMDcsIDNkXG5QYXJhbGxlbCAxICAgOiAgICAgICAgIGRlczMsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAyICAgOiAgICAgICAgIGRlczQsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAzICAgOiAgICAgICAgIGRlczUsIGFmdGVyIGRlczMsIDFkXG5QYXJhbGxlbCA0ICAgOiAgICAgICAgIGRlczYsIGFmdGVyIGRlczQsIDFkIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
### 甘特图 [<a href="https://mermaid-js.github.io/mermaid/#/gantt">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ2FudHRcbnNlY3Rpb24gU2VjdGlvblxuQ29tcGxldGVkIDpkb25lLCAgICBkZXMxLCAyMDE0LTAxLTA2LDIwMTQtMDEtMDhcbkFjdGl2ZSAgICAgICAgOmFjdGl2ZSwgIGRlczIsIDIwMTQtMDEtMDcsIDNkXG5QYXJhbGxlbCAxICAgOiAgICAgICAgIGRlczMsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAyICAgOiAgICAgICAgIGRlczQsIGFmdGVyIGRlczEsIDFkXG5QYXJhbGxlbCAzICAgOiAgICAgICAgIGRlczUsIGFmdGVyIGRlczMsIDFkXG5QYXJhbGxlbCA0ICAgOiAgICAgICAgIGRlczYsIGFmdGVyIGRlczQsIDFkIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
```
gantt
@@ -107,7 +107,7 @@ gantt
Parallel 4 : des6, after des4, 1d
```
### 类图 [<a href="https://mermaid-js.github.io/mermaid/#/classDiagram">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiY2xhc3NEaWFncmFtXG5DbGFzczAxIDx8LS0gQXZlcnlMb25nQ2xhc3MgOiBDb29sXG48PGludGVyZmFjZT4-IENsYXNzMDFcbkNsYXNzMDkgLS0-IEMyIDogV2hlcmUgYW0gaT9cbkNsYXNzMDkgLS0qIEMzXG5DbGFzczA5IC0tfD4gQ2xhc3MwN1xuQ2xhc3MwNyA6IGVxdWFscygpXG5DbGFzczA3IDogT2JqZWN0W10gZWxlbWVudERhdGFcbkNsYXNzMDEgOiBzaXplKClcbkNsYXNzMDEgOiBpbnQgY2hpbXBcbkNsYXNzMDEgOiBpbnQgZ29yaWxsYVxuY2xhc3MgQ2xhc3MxMCB7XG4gID4-c2VydmljZT4-XG4gIGludCBpZFxuICBzaXplKClcbn0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
### 类图 [<a href="https://mermaid-js.github.io/mermaid/#/classDiagram">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiY2xhc3NEaWFncmFtXG5DbGFzczAxIDx8LS0gQXZlcnlMb25nQ2xhc3MgOiBDb29sXG48PGludGVyZmFjZT4-IENsYXNzMDFcbkNsYXNzMDkgLS0-IEMyIDogV2hlcmUgYW0gaT9cbkNsYXNzMDkgLS0qIEMzXG5DbGFzczA5IC0tfD4gQ2xhc3MwN1xuQ2xhc3MwNyA6IGVxdWFscygpXG5DbGFzczA3IDogT2JqZWN0W10gZWxlbWVudERhdGFcbkNsYXNzMDEgOiBzaXplKClcbkNsYXNzMDEgOiBpbnQgY2hpbXBcbkNsYXNzMDEgOiBpbnQgZ29yaWxsYVxuY2xhc3MgQ2xhc3MxMCB7XG4gID4-c2VydmljZT4-XG4gIGludCBpZFxuICBzaXplKClcbn0iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
```
classDiagram
@@ -147,7 +147,7 @@ class Class10 {
}
```
### 状态图 [[<a href="https://mermaid-js.github.io/mermaid/#/stateDiagram">docs</a> - <a href="https://mermaid.live/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtLXYyXG4gICAgWypdIC0tPiBTdGlsbFxuICAgIFN0aWxsIC0tPiBbKl1cbiAgICBTdGlsbCAtLT4gTW92aW5nXG4gICAgTW92aW5nIC0tPiBTdGlsbFxuICAgIE1vdmluZyAtLT4gQ3Jhc2hcbiAgICBDcmFzaCAtLT4gWypdIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQiLCJ0aGVtZVZhcmlhYmxlcyI6eyJiYWNrZ3JvdW5kIjoid2hpdGUiLCJwcmltYXJ5Q29sb3IiOiIjRUNFQ0ZGIiwic2Vjb25kYXJ5Q29sb3IiOiIjZmZmZmRlIiwidGVydGlhcnlDb2xvciI6ImhzbCg4MCwgMTAwJSwgOTYuMjc0NTA5ODAzOSUpIiwicHJpbWFyeUJvcmRlckNvbG9yIjoiaHNsKDI0MCwgNjAlLCA4Ni4yNzQ1MDk4MDM5JSkiLCJzZWNvbmRhcnlCb3JkZXJDb2xvciI6ImhzbCg2MCwgNjAlLCA4My41Mjk0MTE3NjQ3JSkiLCJ0ZXJ0aWFyeUJvcmRlckNvbG9yIjoiaHNsKDgwLCA2MCUsIDg2LjI3NDUwOTgwMzklKSIsInByaW1hcnlUZXh0Q29sb3IiOiIjMTMxMzAwIiwic2Vjb25kYXJ5VGV4dENvbG9yIjoiIzAwMDAyMSIsInRlcnRpYXJ5VGV4dENvbG9yIjoicmdiKDkuNTAwMDAwMDAwMSwgOS41MDAwMDAwMDAxLCA5LjUwMDAwMDAwMDEpIiwibGluZUNvbG9yIjoiIzMzMzMzMyIsInRleHRDb2xvciI6IiMzMzMiLCJtYWluQmtnIjoiI0VDRUNGRiIsInNlY29uZEJrZyI6IiNmZmZmZGUiLCJib3JkZXIxIjoiIzkzNzBEQiIsImJvcmRlcjIiOiIjYWFhYTMzIiwiYXJyb3doZWFkQ29sb3IiOiIjMzMzMzMzIiwiZm9udEZhbWlseSI6IlwidHJlYnVjaGV0IG1zXCIsIHZlcmRhbmEsIGFyaWFsIiwiZm9udFNpemUiOiIxNnB4IiwibGFiZWxCYWNrZ3JvdW5kIjoiI2U4ZThlOCIsIm5vZGVCa2ciOiIjRUNFQ0ZGIiwibm9kZUJvcmRlciI6IiM5MzcwREIiLCJjbHVzdGVyQmtnIjoiI2ZmZmZkZSIsImNsdXN0ZXJCb3JkZXIiOiIjYWFhYTMzIiwiZGVmYXVsdExpbmtDb2xvciI6IiMzMzMzMzMiLCJ0aXRsZUNvbG9yIjoiIzMzMyIsImVkZ2VMYWJlbEJhY2tncm91bmQiOiIjZThlOGU4IiwiYWN0b3JCb3JkZXIiOiJoc2woMjU5LjYyNjE2ODIyNDMsIDU5Ljc3NjUzNjMxMjglLCA4Ny45MDE5NjA3ODQzJSkiLCJhY3RvckJrZyI6IiNFQ0VDRkYiLCJhY3RvclRleHRDb2xvciI6ImJsYWNrIiwiYWN0b3JMaW5lQ29sb3IiOiJncmV5Iiwic2lnbmFsQ29sb3IiOiIjMzMzIiwic2lnbmFsVGV4dENvbG9yIjoiIzMzMyIsImxhYmVsQm94QmtnQ29sb3IiOiIjRUNFQ0ZGIiwibGFiZWxCb3hCb3JkZXJDb2xvciI6ImhzbCgyNTkuNjI2MTY4MjI0MywgNTkuNzc2NTM2MzEyOCUsIDg3LjkwMTk2MDc4NDMlKSIsImxhYmVsVGV4dENvbG9yIjoiYmxhY2siLCJsb29wVGV4dENvbG9yIjoiYmxhY2siLCJub3RlQm9yZGVyQ29sb3IiOiIjYWFhYTMzIiwibm90ZUJrZ0NvbG9yIjoiI2ZmZjVhZCIsIm5vdGVUZXh0Q29sb3IiOiJibGFjayIsImFjdGl2YXRpb25Cb3JkZXJDb2xvciI6IiM2NjYiLCJhY3RpdmF0aW9uQmtnQ29sb3IiOiIjZjRmNGY0Iiwic2VxdWVuY2VOdW1iZXJDb2xvciI6IndoaXRlIiwic2VjdGlvbkJrZ0NvbG9yIjoicmdiYSgxMDIsIDEwMiwgMjU1LCAwLjQ5KSIsImFsdFNlY3Rpb25Ca2dDb2xvciI6IndoaXRlIiwic2VjdGlvbkJrZ0NvbG9yMiI6IiNmZmY0MDAiLCJ0YXNrQm9yZGVyQ29sb3IiOiIjNTM0ZmJjIiwidGFza0JrZ0NvbG9yIjoiIzhhOTBkZCIsInRhc2tUZXh0TGlnaHRDb2xvciI6IndoaXRlIiwidGFza1RleHRDb2xvciI6IndoaXRlIiwidGFza1RleHREYXJrQ29sb3IiOiJibGFjayIsInRhc2tUZXh0T3V0c2lkZUNvbG9yIjoiYmxhY2siLCJ0YXNrVGV4dENsaWNrYWJsZUNvbG9yIjoiIzAwMzE2MyIsImFjdGl2ZVRhc2tCb3JkZXJDb2xvciI6IiM1MzRmYmMiLCJhY3RpdmVUYXNrQmtnQ29sb3IiOiIjYmZjN2ZmIiwiZ3JpZENvbG9yIjoibGlnaHRncmV5IiwiZG9uZVRhc2tCa2dDb2xvciI6ImxpZ2h0Z3JleSIsImRvbmVUYXNrQm9yZGVyQ29sb3IiOiJncmV5IiwiY3JpdEJvcmRlckNvbG9yIjoiI2ZmODg4OCIsImNyaXRCa2dDb2xvciI6InJlZCIsInRvZGF5TGluZUNvbG9yIjoicmVkIiwibGFiZWxDb2xvciI6ImJsYWNrIiwiZXJyb3JCa2dDb2xvciI6IiM1NTIyMjIiLCJlcnJvclRleHRDb2xvciI6IiM1NTIyMjIiLCJjbGFzc1RleHQiOiIjMTMxMzAwIiwiZmlsbFR5cGUwIjoiI0VDRUNGRiIsImZpbGxUeXBlMSI6IiNmZmZmZGUiLCJmaWxsVHlwZTIiOiJoc2woMzA0LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTMiOiJoc2woMTI0LCAxMDAlLCA5My41Mjk0MTE3NjQ3JSkiLCJmaWxsVHlwZTQiOiJoc2woMTc2LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTUiOiJoc2woLTQsIDEwMCUsIDkzLjUyOTQxMTc2NDclKSIsImZpbGxUeXBlNiI6ImhzbCg4LCAxMDAlLCA5Ni4yNzQ1MDk4MDM5JSkiLCJmaWxsVHlwZTciOiJoc2woMTg4LCAxMDAlLCA5My41Mjk0MTE3NjQ3JSkifX0sInVwZGF0ZUVkaXRvciI6ZmFsc2V9">live editor</a>]
### 状态图 [[<a href="https://mermaid-js.github.io/mermaid/#/stateDiagram">docs</a> - <a href="https://mermaid.live/edit#pako:eNpdkLsOwjAMRX-l8ojahTEDCzB26kgYrMYtkfJAqVMJVf13QiIKqqfr44d8vUDvFYGAiZHponEMaJv5KF2V4na4V01zqjrWxhSUZYapuEetn7UbCy16P_5HzwGnR6FZfpdCDZaCRa3SWcunQQI_yJIEkaSiAaNhCdKtqRUj--7lehAcItUQn-pnBMSAZtroVWn2YYOU07b4z29Y37gJVYk">live editor</a>]
```
stateDiagram-v2
@@ -169,7 +169,7 @@ Moving --> Crash
Crash --> [*]
```
### 饼图 [<a href="https://mermaid-js.github.io/mermaid/#/pie">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoicGllXG5cIkRvZ3NcIiA6IDQyLjk2XG5cIkNhdHNcIiA6IDUwLjA1XG5cIlJhdHNcIiA6IDEwLjAxIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
### 饼图 [<a href="https://mermaid-js.github.io/mermaid/#/pie">文档</a> - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoicGllXG5cIkRvZ3NcIiA6IDQyLjk2XG5cIkNhdHNcIiA6IDUwLjA1XG5cIlJhdHNcIiA6IDEwLjAxIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
```
pie
@@ -185,9 +185,9 @@ pie
"Rats" : 15
```
### Git 图 [实验特性 - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoiZ2l0R3JhcGg6XG5vcHRpb25zXG57XG4gICAgXCJub2RlU3BhY2luZ1wiOiAxNTAsXG4gICAgXCJub2RlUmFkaXVzXCI6IDEwXG59XG5lbmRcbmNvbW1pdFxuYnJhbmNoIG5ld2JyYW5jaFxuY2hlY2tvdXQgbmV3YnJhbmNoXG5jb21taXRcbmNvbW1pdFxuY2hlY2tvdXQgbWFzdGVyXG5jb21taXRcbmNvbW1pdFxubWVyZ2UgbmV3YnJhbmNoXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
### Git 图 [实验特性 - <a href="https://mermaid.live/edit#base64:eyJjb2RlIjoiZ2l0R3JhcGg6XG5vcHRpb25zXG57XG4gICAgXCJub2RlU3BhY2luZ1wiOiAxNTAsXG4gICAgXCJub2RlUmFkaXVzXCI6IDEwXG59XG5lbmRcbmNvbW1pdFxuYnJhbmNoIG5ld2JyYW5jaFxuY2hlY2tvdXQgbmV3YnJhbmNoXG5jb21taXRcbmNvbW1pdFxuY2hlY2tvdXQgbWFzdGVyXG5jb21taXRcbmNvbW1pdFxubWVyZ2UgbmV3YnJhbmNoXG4iLCJtZXJtYWlkIjp7InRoZW1lIjoiZGVmYXVsdCJ9fQ">live editor</a>]
### 用户体验旅程图 [<a href="https://mermaid-js.github.io/mermaid/#/user-journey">文档</a> - <a href="https://mermaidjs.github.io/mermaid-live-editor/#/edit/eyJjb2RlIjoic3RhdGVEaWFncmFtXG4gICAgWypdIC0tPiBTdGlsbFxuICAgIFN0aWxsIC0tPiBbKl1cbiAgICBTdGlsbCAtLT4gTW92aW5nXG4gICAgTW92aW5nIC0tPiBTdGlsbFxuICAgIE1vdmluZyAtLT4gQ3Jhc2hcbiAgICBDcmFzaCAtLT4gWypdIiwibWVybWFpZCI6eyJ0aGVtZSI6ImRlZmF1bHQifX0">live editor</a>]
### 用户体验旅程图 [<a href="https://mermaid-js.github.io/mermaid/#/user-journey">文档</a> - <a href="https://mermaid.live/edit#pako:eNpljzEPgkAMhf9K05nFGJdbJXFiYmVpuKIncDVHL4QQ_ruHaILaqXnf63vpjLVYRoMAd4nB81R5SKNOO4ZiglFC6_wVLL3JwLU68XARUHnhTQcoqGVQJgMnAwV_5GSMj0HJhcHAcU_y7d7AYVUzOJP-ddyk3ydZGf0n66uldPqCPxWYYc-hJ2fTj_OqVqg3Tplo0mq5odhphZVfkpWiSjn5Go2GyBnGhyXl3NE1UI-moW7g5QkSoF5m">live editor</a>]
```
journey

21
__mocks__/c4Renderer.js Normal file
View File

@@ -0,0 +1,21 @@
/**
* Mocked C4Context diagram renderer
*/
import { vi } from 'vitest';
export const drawPersonOrSystemArray = vi.fn();
export const drawBoundary = vi.fn();
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
drawPersonOrSystemArray,
drawBoundary,
setConf,
draw,
};

View File

@@ -0,0 +1,16 @@
/**
* Mocked class diagram v2 renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
draw,
};

View File

@@ -0,0 +1,13 @@
/**
* Mocked class diagram renderer
*/
import { vi } from 'vitest';
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
draw,
};

View File

@@ -1,67 +1,14 @@
// @ts-nocheck TODO: Fix TS
import { vi } from 'vitest';
const NewD3 = function () {
/**
*
*/
function returnThis() {
return this;
}
return {
append: function () {
return NewD3();
},
lower: returnThis,
attr: returnThis,
style: returnThis,
text: returnThis,
0: {
0: {
getBBox: function () {
return {
height: 10,
width: 20,
};
},
},
},
};
};
import { MockedD3 } from '../packages/mermaid/src/tests/MockedD3';
export const select = function () {
return new NewD3();
return new MockedD3();
};
export const selectAll = function () {
return new NewD3();
return new MockedD3();
};
export const curveBasis = 'basis';
export const curveLinear = 'linear';
export const curveCardinal = 'cardinal';
export const MockD3 = (name, parent) => {
const children = [];
const elem = {
get __children() {
return children;
},
get __name() {
return name;
},
get __parent() {
return parent;
},
};
elem.append = (name) => {
const mockElem = MockD3(name, elem);
children.push(mockElem);
return mockElem;
};
elem.lower = vi.fn(() => elem);
elem.attr = vi.fn(() => elem);
elem.text = vi.fn(() => elem);
elem.style = vi.fn(() => elem);
return elem;
};

16
__mocks__/erRenderer.js Normal file
View File

@@ -0,0 +1,16 @@
/**
* Mocked er diagram renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
draw,
};

View File

@@ -0,0 +1,24 @@
/**
* Mocked flow (flowchart) diagram v2 renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const addVertices = vi.fn();
export const addEdges = vi.fn();
export const getClasses = vi.fn().mockImplementation(() => {
return {};
});
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
addVertices,
addEdges,
getClasses,
draw,
};

View File

@@ -0,0 +1,16 @@
/**
* Mocked gantt diagram renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
draw,
};

View File

@@ -0,0 +1,13 @@
/**
* Mocked git (graph) diagram renderer
*/
import { vi } from 'vitest';
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
draw,
};

View File

@@ -0,0 +1,15 @@
/**
* Mocked pie (picChart) diagram renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
draw,
};

13
__mocks__/pieRenderer.js Normal file
View File

@@ -0,0 +1,13 @@
/**
* Mocked pie (picChart) diagram renderer
*/
import { vi } from 'vitest';
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
draw,
};

View File

@@ -0,0 +1,13 @@
/**
* Mocked requirement diagram renderer
*/
import { vi } from 'vitest';
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
draw,
};

View File

@@ -0,0 +1,23 @@
/**
* Mocked sequence diagram renderer
*/
import { vi } from 'vitest';
export const bounds = vi.fn();
export const drawActors = vi.fn();
export const drawActorsPopup = vi.fn();
export const setConf = vi.fn();
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
bounds,
drawActors,
drawActorsPopup,
setConf,
draw,
};

View File

@@ -0,0 +1,22 @@
/**
* Mocked state diagram v2 renderer
*/
import { vi } from 'vitest';
export const setConf = vi.fn();
export const getClasses = vi.fn().mockImplementation(() => {
return {};
});
export const stateDomId = vi.fn().mockImplementation(() => {
return 'mocked-stateDiagram-stateDomId';
});
export const draw = vi.fn().mockImplementation(() => {
return '';
});
export default {
setConf,
getClasses,
draw,
};

View File

@@ -2,50 +2,101 @@
"version": "0.2",
"language": "en",
"words": [
"customizability",
"Gantt",
"jison",
"knsv",
"Knut",
"mindmap",
"Mindmaps",
"mitigations",
"sandboxed",
"Sveidqvist",
"verdana",
"Visio"
],
"ignoreWords": [
"Adamiecki",
"acyclicer",
"adamiecki",
"alois",
"antiscript",
"applitools",
"Asciidoctor",
"Astah",
"Bisheng",
"asciidoctor",
"ashish",
"astah",
"bbox",
"bilkent",
"bisheng",
"braintree",
"brolin",
"brotli",
"classdef",
"codedoc",
"Docsy",
"Doku",
"Gitea",
"Gitgraph",
"Grav",
"Inkdrop",
"Jaoude",
"colour",
"cpettitt",
"customizability",
"cuzon",
"cytoscape",
"dagre",
"descr",
"docsify",
"docsy",
"doku",
"dompurify",
"edgechromium",
"faber",
"flatmap",
"ftplugin",
"gantt",
"gitea",
"gitgraph",
"globby",
"graphlib",
"grav",
"greywolf",
"inkdrop",
"jaoude",
"jison",
"kaufmann",
"khroma",
"klemm",
"klink",
"knsv",
"knut",
"laganeckas",
"lintstagedrc",
"lucida",
"mansalva",
"matthieu",
"mdbook",
"mermerd",
"mindaugas",
"mindmap",
"mindmaps",
"mitigations",
"mkdocs",
"orlandoni",
"phpbb",
"Plantuml",
"Playfair's",
"Podlite",
"plantuml",
"playfair",
"pnpm",
"podlite",
"ranksep",
"rect",
"rects",
"redmine",
"roledescription",
"sandboxed",
"setupgraphviewbox",
"shiki",
"sidharth",
"sphinxcontrib",
"Tuleap"
"ssim",
"statediagram",
"stylis",
"substate",
"sveidqvist",
"techn",
"treemap",
"ts-nocheck",
"tuleap",
"unist",
"verdana",
"viewports",
"vinod",
"visio",
"vitepress",
"xlink",
"yash"
],
"patterns": [
{
"name": "Markdown links",
"pattern": "\\((.*)\\)",
"description": ""
},
{ "name": "Markdown links", "pattern": "\\((.*)\\)", "description": "" },
{
"name": "Markdown code blocks",
"pattern": "/^(\\s*`{3,}).*[\\s\\S]*?^\\1/gmx",
@@ -56,25 +107,14 @@
"pattern": "\\`([^\\`\\r\\n]+?)\\`",
"description": "https://stackoverflow.com/questions/41274241/how-to-capture-inline-markdown-code-but-not-a-markdown-code-fence-with-regex"
},
{
"name": "Link contents",
"pattern": "\\<a(.*)\\>",
"description": ""
},
{
"name": "Snippet references",
"pattern": "-- snippet:(.*)",
"description": ""
},
{ "name": "Link contents", "pattern": "\\<a(.*)\\>", "description": "" },
{ "name": "Snippet references", "pattern": "-- snippet:(.*)", "description": "" },
{
"name": "Snippet references 2",
"pattern": "\\<\\[sample:(.*)",
"description": "another kind of snippet reference"
},
{
"name": "Multi-line code blocks",
"pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm"
},
{ "name": "Multi-line code blocks", "pattern": "/^\\s*```[\\s\\S]*?^\\s*```/gm" },
{
"name": "HTML Tags",
"pattern": "<[^>]*>",
@@ -91,5 +131,8 @@
"Multi-line code blocks",
"HTML Tags"
],
"ignorePaths": ["packages/mermaid/src/docs/CHANGELOG.md"]
"ignorePaths": [
"packages/mermaid/src/docs/CHANGELOG.md",
"packages/mermaid/src/docs/.vitepress/redirect.ts"
]
}

View File

@@ -5,9 +5,17 @@ const { addMatchImageSnapshotPlugin } = require('cypress-image-snapshot/plugin')
module.exports = defineConfig({
projectId: 'n2sma2',
viewportWidth: 1440,
viewportHeight: 1024,
e2e: {
specPattern: 'cypress/integration/**/*.{js,jsx,ts,tsx}',
setupNodeEvents(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;

View File

@@ -47,7 +47,6 @@ export const imgSnapshotTest = (graphStr, _options, api = false, validation) =>
options.fontSize = '16px';
}
const useAppli = Cypress.env('useAppli');
//const useAppli = false;
cy.log('Hello ' + useAppli ? 'Appli' : 'image-snapshot');
const name = (options.name || cy.state('runnable').fullTitle()).replace(/\s+/g, '-');
@@ -64,7 +63,9 @@ export const imgSnapshotTest = (graphStr, _options, api = false, validation) =>
const url = mermaidUrl(graphStr, options, api);
cy.visit(url);
if (validation) cy.get('svg').should(validation);
if (validation) {
cy.get('svg').should(validation);
}
cy.get('svg');
// Default name to test title
@@ -117,7 +118,9 @@ export const urlSnapshotTest = (url, _options, api = false, validation) => {
}
cy.visit(url);
if (validation) cy.get('svg').should(validation);
if (validation) {
cy.get('svg').should(validation);
}
cy.get('body');
// Default name to test title
@@ -133,6 +136,5 @@ export const urlSnapshotTest = (url, _options, api = false, validation) => {
export const renderGraph = (graphStr, options, api) => {
const url = mermaidUrl(graphStr, options, api);
cy.visit(url);
};

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

@@ -21,7 +21,7 @@ describe('Git Graph diagram', () => {
// // Call Open on eyes to initialize a test session
// cy.eyesOpen({
// appName: 'Demo App',
// testName: 'Ultrafast grid demo',
// testName: 'UltraFast grid demo',
// });
// // check the login page with fluent api, see more info here

View File

@@ -478,4 +478,34 @@ describe('Class diagram V2', () => {
);
cy.get('svg');
});
it('18: should render a simple class diagram with notes', () => {
imgSnapshotTest(
`
classDiagram-v2
note "I love this diagram!\nDo you love it?"
class Class10 {
<<service>>
int id
size()
}
note for Class10 "Cool class\nI said it's very cool class!"
`,
{ logLevel: 1, flowchart: { htmlLabels: false } }
);
cy.get('svg');
});
it('1433: should render a simple class with a title', () => {
imgSnapshotTest(
`---
title: simple class diagram
---
classDiagram-v2
class Class10
`,
{}
);
});
});

View File

@@ -407,4 +407,21 @@ describe('Class diagram', () => {
// // expect(svg).to.not.have.attr('style');
// });
// });
it('19: should render a simple class diagram with notes', () => {
imgSnapshotTest(
`
classDiagram
note "I love this diagram!\nDo you love it?"
class Class10 {
<<service>>
int id
size()
}
note for Class10 "Cool class\nI said it's very cool class!"
`,
{ logLevel: 1 }
);
cy.get('svg');
});
});

View File

@@ -167,7 +167,7 @@ describe('Entity Relationship Diagram', () => {
cy.get('svg');
});
it.only('should render entities with generic and array attributes', () => {
it('should render entities with generic and array attributes', () => {
renderGraph(
`
erDiagram
@@ -255,4 +255,35 @@ describe('Entity Relationship Diagram', () => {
);
cy.get('svg');
});
it('should render entities with aliases', () => {
renderGraph(
`
erDiagram
T1 one or zero to one or more T2 : test
T2 one or many optionally to zero or one T3 : test
T3 zero or more to zero or many T4 : test
T4 many(0) to many(1) T5 : test
T5 many optionally to one T6 : test
T6 only one optionally to only one T1 : test
T4 0+ to 1+ T6 : test
T1 1 to 1 T3 : test
`,
{ logLevel: 1 }
);
cy.get('svg');
});
it('1433: should render a simple ER diagram with a title', () => {
imgSnapshotTest(
`---
title: simple ER diagram
---
erDiagram
CUSTOMER ||--o{ ORDER : places
ORDER ||--|{ LINE-ITEM : contains
`,
{}
);
});
});

View File

@@ -663,4 +663,15 @@ flowchart RL
{ htmlLabels: true, flowchart: { htmlLabels: true }, securityLevel: 'loose' }
);
});
it('1433: should render a titled flowchart with titleTopMargin set to 0', () => {
imgSnapshotTest(
`---
title: Simple flowchart
---
flowchart TD
A --> B
`,
{ titleTopMargin: 0 }
);
});
});

View File

@@ -225,7 +225,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
);
});
});
@@ -269,7 +272,10 @@ describe('Gantt diagram', () => {
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');
});
});
@@ -310,35 +316,129 @@ describe('Gantt diagram', () => {
);
});
it('should render accessibility tags', function () {
const expectedTitle = 'Gantt Diagram';
const expectedAccDescription = 'Tasks for Q4';
renderGraph(
it('should render a gantt diagram with tick is 15 minutes', () => {
imgSnapshotTest(
`
gantt
accTitle: ${expectedTitle}
accDescr: ${expectedAccDescription}
dateFormat YYYY-MM-DD
section Section
A task :a1, 2014-01-01, 30d
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %H:%M
tickInterval 15minute
excludes weekends
section Section
A task : a1, 2022-10-03, 6h
Another task : after a1, 6h
section Another
Task in sec : 2022-10-03, 3h
another task : 3h
`,
{}
);
cy.get('svg').should((svg) => {
const el = svg.get(0);
const children = Array.from(el.children);
});
const titleEl = children.find(function (node) {
return node.tagName === 'title';
});
const descriptionEl = children.find(function (node) {
return node.tagName === 'desc';
});
it('should render a gantt diagram with tick is 6 hours', () => {
imgSnapshotTest(
`
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %d %H:%M
tickInterval 6hour
excludes weekends
expect(titleEl).to.exist;
expect(titleEl.textContent).to.equal(expectedTitle);
expect(descriptionEl).to.exist;
expect(descriptionEl.textContent).to.equal(expectedAccDescription);
});
section Section
A task : a1, 2022-10-03, 1d
Another task : after a1, 2d
section Another
Task in sec : 2022-10-04, 2d
another task : 2d
`,
{}
);
});
it('should render a gantt diagram with tick is 1 day', () => {
imgSnapshotTest(
`
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %m-%d
tickInterval 1day
excludes weekends
section Section
A task : a1, 2022-10-01, 30d
Another task : after a1, 20d
section Another
Task in sec : 2022-10-20, 12d
another task : 24d
`,
{}
);
});
it('should render a gantt diagram with tick is 1 week', () => {
imgSnapshotTest(
`
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %m-%d
tickInterval 1week
excludes weekends
section Section
A task : a1, 2022-10-01, 30d
Another task : after a1, 20d
section Another
Task in sec : 2022-10-20, 12d
another task : 24d
`,
{}
);
});
it('should render a gantt diagram with tick is 1 month', () => {
imgSnapshotTest(
`
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %m-%d
tickInterval 1month
excludes weekends
section Section
A task : a1, 2022-10-01, 30d
Another task : after a1, 20d
section Another
Task in sec : 2022-10-20, 12d
another task : 24d
`,
{}
);
});
it('should render a gantt diagram with tick is 1 day and topAxis is true', () => {
imgSnapshotTest(
`
gantt
title A Gantt Diagram
dateFormat YYYY-MM-DD
axisFormat %m-%d
tickInterval 1day
excludes weekends
section Section
A task : a1, 2022-10-01, 30d
Another task : after a1, 20d
section Another
Task in sec : 2022-10-20, 12d
another task : 24d
`,
{ gantt: { topAxis: true } }
);
});
});

View File

@@ -322,4 +322,15 @@ describe('Git Graph diagram', () => {
{}
);
});
it('1433: should render a simple gitgraph with a title', () => {
imgSnapshotTest(
`---
title: simple gitGraph
---
gitGraph
commit id: "1-abcdefg"
`,
{}
);
});
});

View File

@@ -1,75 +0,0 @@
import { imgSnapshotTest, renderGraph } from '../../helpers/util.js';
describe('Mindmap', () => {
it('square shape', () => {
imgSnapshotTest(
`
mindmap
root[
The root
]
`,
{}
);
cy.get('svg');
});
it('rounded rect shape', () => {
imgSnapshotTest(
`
mindmap
root((
The root
))
`,
{}
);
cy.get('svg');
});
it('circle shape', () => {
imgSnapshotTest(
`
mindmap
root(
The root
)
`,
{}
);
cy.get('svg');
});
it('default shape', () => {
imgSnapshotTest(
`
mindmap
The root
`,
{}
);
cy.get('svg');
});
it('adding children', () => {
imgSnapshotTest(
`
mindmap
The root
child1
child2
`,
{}
);
cy.get('svg');
});
it('adding grand children', () => {
imgSnapshotTest(
`
mindmap
The root
child1
child2
child3
`,
{}
);
cy.get('svg');
});
});

View File

@@ -1,115 +0,0 @@
import { imgSnapshotTest, renderGraph } from '../../helpers/util.js';
describe('Mindmaps', () => {
it('Only a root', () => {
imgSnapshotTest(
`mindmap
root
`,
{}
);
});
it('a root with a shape', () => {
imgSnapshotTest(
`mindmap
root[root]
`,
{}
);
});
it('a root with wrapping text and a shape', () => {
imgSnapshotTest(
`mindmap
root[A root with a long text that wraps to keep the node size in check]
`,
{}
);
});
it('a root with an icon', () => {
imgSnapshotTest(
`mindmap
root[root]
::icon(mdi mdi-fire)
`,
{}
);
});
it('Blang and cloud shape', () => {
imgSnapshotTest(
`mindmap
root))bang((
::icon(mdi mdi-fire)
a))Another bang((
::icon(mdi mdi-fire)
a)A cloud(
::icon(mdi mdi-fire)
`,
{}
);
});
it('Blang and cloud shape with icons', () => {
imgSnapshotTest(
`mindmap
root))bang((
a))Another bang((
a)A cloud(
`,
{}
);
});
it('braches', () => {
imgSnapshotTest(
`mindmap
root
child1
grandchild 1
grandchild 2
child2
grandchild 3
grandchild 4
child3
grandchild 5
grandchild 6
`,
{}
);
});
it('braches with shapes and labels', () => {
imgSnapshotTest(
`mindmap
root
child1((Circle))
grandchild 1
grandchild 2
child2(Round rectangle)
grandchild 3
grandchild 4
child3[Square]
grandchild 5
::icon(mdi mdi-fire)
gc6((grand<br/>child 6))
::icon(mdi mdi-fire)
`,
{}
);
});
it('text shouhld wrap with icon', () => {
imgSnapshotTest(
`mindmap
root
Child3(A node with an icon and with a long text that wraps to keep the node size in check)
`,
{}
);
});
/* The end */
});

View File

@@ -0,0 +1,233 @@
import { imgSnapshotTest, renderGraph } from '../../helpers/util.js';
/**
* Check whether the SVG Element has a Mindmap root
*
* Sometimes, Cypress takes a snapshot before the mermaid mindmap has finished
* generating the SVG.
*
* @param $p - The element to check.
*/
function shouldHaveRoot($p: JQuery<SVGSVGElement>) {
// get HTML Element from jquery element
const svgElement = $p[0];
expect(svgElement.nodeName).equal('svg');
const sectionRoots = svgElement.getElementsByClassName('mindmap-node section-root');
// mindmap should have at least one root section
expect(sectionRoots).to.have.lengthOf.at.least(1);
}
describe('Mindmaps', () => {
it('Only a root', () => {
imgSnapshotTest(
`mindmap
root
`,
{},
undefined,
shouldHaveRoot
);
});
it('a root with a shape', () => {
imgSnapshotTest(
`mindmap
root[root]
`,
{},
undefined,
shouldHaveRoot
);
});
it('a root with wrapping text and a shape', () => {
imgSnapshotTest(
`mindmap
root[A root with a long text that wraps to keep the node size in check]
`,
{},
undefined,
shouldHaveRoot
);
});
it('a root with an icon', () => {
imgSnapshotTest(
`mindmap
root[root]
::icon(mdi mdi-fire)
`,
{},
undefined,
shouldHaveRoot
);
});
it('Blang and cloud shape', () => {
imgSnapshotTest(
`mindmap
root))bang((
::icon(mdi mdi-fire)
a))Another bang((
::icon(mdi mdi-fire)
a)A cloud(
::icon(mdi mdi-fire)
`,
{},
undefined,
shouldHaveRoot
);
});
it('Blang and cloud shape with icons', () => {
imgSnapshotTest(
`mindmap
root))bang((
a))Another bang((
a)A cloud(
`,
{},
undefined,
shouldHaveRoot
);
});
it('braches', () => {
imgSnapshotTest(
`mindmap
root
child1
grandchild 1
grandchild 2
child2
grandchild 3
grandchild 4
child3
grandchild 5
grandchild 6
`,
{},
undefined,
shouldHaveRoot
);
});
it('braches with shapes and labels', () => {
imgSnapshotTest(
`mindmap
root
child1((Circle))
grandchild 1
grandchild 2
child2(Round rectangle)
grandchild 3
grandchild 4
child3[Square]
grandchild 5
::icon(mdi mdi-fire)
gc6((grand<br/>child 6))
::icon(mdi mdi-fire)
`,
{},
undefined,
shouldHaveRoot
);
});
it('text shouhld wrap with icon', () => {
imgSnapshotTest(
`mindmap
root
Child3(A node with an icon and with a long text that wraps to keep the node size in check)
`,
{},
undefined,
shouldHaveRoot
);
});
it('square shape', () => {
imgSnapshotTest(
`
mindmap
root[
The root
]
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
it('rounded rect shape', () => {
imgSnapshotTest(
`
mindmap
root((
The root
))
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
it('circle shape', () => {
imgSnapshotTest(
`
mindmap
root(
The root
)
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
it('default shape', () => {
imgSnapshotTest(
`
mindmap
The root
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
it('adding children', () => {
imgSnapshotTest(
`
mindmap
The root
child1
child2
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
it('adding grand children', () => {
imgSnapshotTest(
`
mindmap
The root
child1
child2
child3
`,
{},
undefined,
shouldHaveRoot
);
cy.get('svg');
});
/* The end */
});

View File

@@ -54,7 +54,10 @@ 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(
Cypress.config().viewportWidth * 0.95,
Cypress.config().viewportWidth * 1.05
);
});
});
it('should render a pie diagram when useMaxWidth is false', () => {
@@ -68,10 +71,11 @@ describe('Pie Chart', () => {
{ pie: { useMaxWidth: false } }
);
cy.get('svg').should((svg) => {
// const height = parseFloat(svg.attr('height'));
const width = parseFloat(svg.attr('width'));
// expect(height).to.eq(450);
expect(width).to.eq(984);
expect(width).to.be.within(
Cypress.config().viewportWidth * 0.95,
Cypress.config().viewportWidth * 1.05
);
expect(svg).to.not.have.attr('style');
});
});

View File

@@ -46,69 +46,4 @@ describe('Requirement diagram', () => {
);
cy.get('svg');
});
it('should render accessibility tags', function () {
const expectedTitle = 'Gantt Diagram';
const expectedAccDescription = 'Tasks for Q4';
renderGraph(
`
requirementDiagram
accTitle: ${expectedTitle}
accDescr: ${expectedAccDescription}
requirement test_req {
id: 1
text: the test text.
risk: high
verifymethod: test
}
functionalRequirement test_req2 {
id: 1.1
text: the second test text.
risk: low
verifymethod: inspection
}
performanceRequirement test_req3 {
id: 1.2
text: the third test text.
risk: medium
verifymethod: demonstration
}
element test_entity {
type: simulation
}
element test_entity2 {
type: word doc
docRef: reqs/test_entity
}
test_entity - satisfies -> test_req2
test_req - traces -> test_req2
test_req - contains -> test_req3
test_req <- copies - test_entity2
`,
{}
);
cy.get('svg').should((svg) => {
const el = svg.get(0);
const children = Array.from(el.children);
const titleEl = children.find(function (node) {
return node.tagName === 'title';
});
const descriptionEl = children.find(function (node) {
return node.tagName === 'desc';
});
expect(titleEl).to.exist;
expect(titleEl.textContent).to.equal(expectedTitle);
expect(descriptionEl).to.exist;
expect(descriptionEl.textContent).to.equal(expectedAccDescription);
});
});
});

View File

@@ -328,7 +328,7 @@ describe('State diagram', () => {
}
);
});
it('v2 it should be possibel to use a choice', () => {
it('v2 it should be possible to use a choice', () => {
imgSnapshotTest(
`
stateDiagram-v2
@@ -521,4 +521,54 @@ stateDiagram-v2
{ logLevel: 0, fontFamily: 'courier' }
);
});
describe('classDefs and applying classes', () => {
it('v2 states can have a class applied', () => {
imgSnapshotTest(
`
stateDiagram-v2
[*] --> A
A --> B: test({ foo#colon; 'far' })
B --> [*]
classDef badBadEvent fill:#f00,color:white,font-weight:bold
class B badBadEvent
`,
{ logLevel: 0, fontFamily: 'courier' }
);
});
it('v2 can have multiple classes applied to multiple states', () => {
imgSnapshotTest(
`
stateDiagram-v2
classDef notMoving fill:white
classDef movement font-style:italic;
classDef badBadEvent fill:#f00,color:white,font-weight:bold
[*] --> Still
Still --> [*]
Still --> Moving
Moving --> Still
Moving --> Crash
Crash --> [*]
class Still notMoving
class Moving, Crash movement
class Crash badBadEvent
`,
{ logLevel: 0, fontFamily: 'courier' }
);
});
});
it('1433: should render a simple state diagram with a title', () => {
imgSnapshotTest(
`---
title: simple state diagram
---
stateDiagram-v2
[*] --> State1
State1 --> [*]
`,
{}
);
});
});

View File

@@ -25,6 +25,7 @@ describe('themeCSS balancing, it', () => {
});
});
// TODO: Delete/Rename this describe, keeping the inner contents.
describe('Pie Chart', () => {
// beforeEach(()=>{
// cy.clock((new Date('2014-06-09')).getTime());

View File

@@ -1,32 +1,8 @@
<html>
<head>
<meta charset="utf-8" />
<!-- <meta charset="iso-8859-15"/> -->
<script src="./viewer.js" type="module"></script>
<!-- <link href="https://fonts.googleapis.com/css?family=Mansalva&display=swap" rel="stylesheet" /> -->
<link
href="https://fonts.googleapis.com/css?family=Noto+Sans+SC&display=swap"
rel="stylesheet"
/>
<style>
body {
/* font-family: 'Mansalva', cursive;*/
/* font-family: 'Mansalva', cursive; */
/* font-family: 'arial'; */
/* font-family: "trebuchet ms", verdana, arial; */
}
/* div {
font-family: 'arial';
} */
/* .mermaid-main-font {
font-family: "trebuchet ms", verdana, arial;
font-family: var(--mermaid-font-family);
} */
/* :root {
--mermaid-font-family: '"trebuchet ms", verdana, arial';
--mermaid-font-family: "Comic Sans MS", "Comic Sans", cursive;
--mermaid-font-family: '"Lucida Console", Monaco, monospace';
} */
svg {
border: 2px solid darkred;
}
@@ -36,21 +12,5 @@
}
</style>
</head>
<body>
<!-- <script src="./mermaid.js"></script> -->
<script>
// Notice startOnLoad=false
// This prevents default handling in mermaid from render before the e2e logic is applied
// mermaid.initialize({
// startOnLoad: false,
// useMaxWidth: true,
// // "themeCSS": ":root { --mermaid-font-family: \"trebuchet ms\", verdana, arial;}",
// // fontFamily: '\"trebuchet ms\", verdana, arial;'
// // fontFamily: '"Comic Sans MS", "Comic Sans", cursive'
// // fontFamily: '"Mansalva", cursive',
// // fontFamily: '"Noto Sans SC", sans-serif'
// fontFamily: '"Noto Sans SC", sans-serif'
// });
</script>
</body>
<body></body>
</html>

View File

@@ -56,63 +56,65 @@
<body>
<div>Security check</div>
<pre id="diagram" class="mermaid">
classDiagram
direction LR
class Student {
-idCard : IdCard
}
class IdCard{
-id : int
-name : string
}
class Bike{
-id : int
-name : string
}
Student "1" --o "1" IdCard : carries
Student "1" --o "1" Bike : rides
flowchart LR
%% Actors
A
subgraph Sub
B --> C
end
%% Accusations
A --L --> Sub
%% Offense
B --> A
</pre>
<pre id="diagram" class="mermaid">
stateDiagram-v2
[*] --> S1
S1 --> S2: long line using<br/>should work
S1 --> S3: long line using <br>should work
S1 --> S4: long line using \\nshould work
</pre>
<pre id="diagram" class="mermaid2">
mindmap
root
child1((Circle))
grandchild 1
grandchild 2
child2(Round rectangle)
grandchild 3
grandchild 4
child3[Square]
grandchild 5
::icon(mdi mdi-fire)
gc6((grand<br/>child 6))
::icon(mdi mdi-fire)
gc7((grand<br/>grand<br/>child 8))
</pre>
<pre id="diagram" class="mermaid2">
example-diagram
gantt
title Style today marker (vertical line should be 5px wide and half-transparent blue)
dateFormat YYYY-MM-DD
axisFormat %d
todayMarker stroke-width:5px,stroke:#00f,opacity:0.5
section Section1
Today: 1, -1h
</pre>
<!-- <div id="cy"></div> -->
<!-- <script src="http://localhost:9000/packages/mermaid-mindmap/dist/mermaid-mindmap-detector.js"></script> -->
<!-- <script src="./mermaid-example-diagram-detector.js"></script> -->
<!-- <script src="//cdn.jsdelivr.net/npm/mermaid@9.1.7/dist/mermaid.min.js"></script> -->
<script src="./mermaid.js"></script>
<!-- <script src="./mermaid.js"></script> -->
<script>
<script type="module">
import mindmap from '../../packages/mermaid-mindmap/src/detector';
// import example from '../../packages/mermaid-example-diagram/src/detector';
import mermaid from '../../packages/mermaid/src/mermaid';
await mermaid.registerExternalDiagrams([mindmap]);
mermaid.parseError = function (err, hash) {
// console.error('Mermaid error: ', err);
};
mermaid.initialize({
theme: 'forest',
theme: 'default',
startOnLoad: true,
logLevel: 0,
// basePath: './packages/',
// themeVariables: { darkMode: true },
lazyLoadedDiagrams: [
'./mermaid-mindmap-detector.esm.mjs',
'./mermaid-example-diagram-detector.esm.mjs',
],
// lazyLoadedDiagrams: ['../../mermaid-mindmap/registry.ts'],
flowchart: {
useMaxWidth: false,
htmlLabels: true,
},
gantt: {
useMaxWidth: false,
},
useMaxWidth: false,
});
function callback() {
alert('It worked');
@@ -121,6 +123,10 @@ mindmap
console.error('In parse error:');
console.error(err);
};
// mermaid.test1('first_slow', 1200).then((r) => console.info(r));
// mermaid.test1('second_fast', 200).then((r) => console.info(r));
// mermaid.test1('third_fast', 200).then((r) => console.info(r));
// mermaid.test1('forth_slow', 1200).then((r) => console.info(r));
</script>
</body>
</html>

View File

@@ -54,7 +54,7 @@ function merge(current, update) {
if (
current.hasOwnProperty(key) &&
typeof current[key] === 'object' &&
!(current[key] instanceof Array)
!Array.isArray(current[key])
) {
merge(current[key], update[key]);
@@ -120,7 +120,9 @@ const contentLoadedApi = function () {
(svgCode, bindFunctions) => {
div.innerHTML = svgCode;
if (bindFunctions) bindFunctions(div);
if (bindFunctions) {
bindFunctions(div);
}
},
div
);

View File

@@ -94,7 +94,7 @@
}
// var diagram = ` graph TD
// A --> B["&lt;a href='javasc`;
// A --> B["&lt;a href='javascript`;
// diagram += `ript#colon;xssAttack()'&gt;AAA&lt;/a&gt;"]`;
let diagram = ` graph TD
A --> B["<a href='javasc`;

Binary file not shown.

After

Width:  |  Height:  |  Size: 79 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 120 KiB

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