GitHub/mermaid
1
0
Fork 0
mirror of https://github.com/mermaid-js/mermaid.git synced 2025-01-14 06:43:25 +08:00
Code Issues Projects Releases Wiki Activity

Merge branch 'develop' into sidv/contributors

Browse Source 
* develop:
  chore(deps): update all minor dependencies
  requested update
  Update packages/mermaid/src/docs/syntax/flowchart.md
  Update docs
  Docs: Flowchart - minor verbiage update
This commit is contained in:
Sidharth Vinod 2023-05-08 18:51:10 +05:30
commit 1b48c19897
No known key found for this signature in database
GPG Key ID: FB5CCD378D3907CD
4 changed files with 60 additions and 64 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
docs/syntax/flowchart.md
View File

@ -6,11 +6,10 @@
# Flowcharts - Basic Syntax
All Flowcharts are composed of **nodes**, the geometric shapes and **edges**, the arrows or lines. The mermaid code defines the way that these **nodes** and **edges** are made and interact.
Flowcharts are composed of **nodes** (geometric shapes) and **edges** (arrows or lines). The Mermaid code defines how nodes and edges are made and accommodates different arrow types, multi-directional arrows, and any linking to and from subgraphs.
It can also accommodate different arrow types, multi directional arrows, and linking to and from subgraphs.
> **Important note**: Do not type the word "end" as a Flowchart node. Capitalize all or any one the letters to keep the flowchart from breaking, i.e, "End" or "END". Or you can apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897).
> **Warning**
> If you are using the word "end" in a Flowchart node, capitalize the entire word or any of the letters (e.g., "End" or "END"), or apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897). Typing "end" in all lowercase letters will break the Flowchart.
### A node (default)

10
package.json
View File

@ -4,7 +4,7 @@
"version": "10.1.0",
"description": "Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.",
"type": "module",
"packageManager": "pnpm@8.3.1",
"packageManager": "pnpm@8.4.0",
"keywords": [
"diagram",
"markdown",
@ -71,9 +71,9 @@
"@types/rollup-plugin-visualizer": "^4.2.1",
"@typescript-eslint/eslint-plugin": "^5.59.0",
"@typescript-eslint/parser": "^5.59.0",
"@vitest/coverage-c8": "^0.30.1",
"@vitest/spy": "^0.30.1",
"@vitest/ui": "^0.30.1",
"@vitest/coverage-c8": "^0.31.0",
"@vitest/spy": "^0.31.0",
"@vitest/ui": "^0.31.0",
"concurrently": "^8.0.1",
"cors": "^2.8.5",
"coveralls": "^3.1.1",
@ -110,7 +110,7 @@
"tsx": "^3.12.7",
"typescript": "^5.0.4",
"vite": "^4.3.1",
"vitest": "^0.30.1"
"vitest": "^0.31.0"
},
"volta": {
"node": "18.16.0"

8
packages/mermaid/src/docs/syntax/flowchart.md
View File

@ -5,11 +5,11 @@ outline: 'deep' # shows all h3 headings in outline in Vitepress
# Flowcharts - Basic Syntax
All Flowcharts are composed of **nodes**, the geometric shapes and **edges**, the arrows or lines. The mermaid code defines the way that these **nodes** and **edges** are made and interact.
Flowcharts are composed of **nodes** (geometric shapes) and **edges** (arrows or lines). The Mermaid code defines how nodes and edges are made and accommodates different arrow types, multi-directional arrows, and any linking to and from subgraphs.
It can also accommodate different arrow types, multi directional arrows, and linking to and from subgraphs.
> **Important note**: Do not type the word "end" as a Flowchart node. Capitalize all or any one the letters to keep the flowchart from breaking, i.e, "End" or "END". Or you can apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897).
```warning
If you are using the word "end" in a Flowchart node, capitalize the entire word or any of the letters (e.g., "End" or "END"), or apply this [workaround](https://github.com/mermaid-js/mermaid/issues/1444#issuecomment-639528897). Typing "end" in all lowercase letters will break the Flowchart.
```
### A node (default)

99
pnpm-lock.yaml generated
View File

@ -56,14 +56,14 @@ importers:
specifier: ^5.59.0
version: 5.59.0(eslint@8.39.0)(typescript@5.0.4)
'@vitest/coverage-c8':
specifier: ^0.30.1
version: 0.30.1(vitest@0.30.1)
specifier: ^0.31.0
version: 0.31.0(vitest@0.31.0)
'@vitest/spy':
specifier: ^0.30.1
version: 0.30.1
specifier: ^0.31.0
version: 0.31.0
'@vitest/ui':
specifier: ^0.30.1
version: 0.30.1
specifier: ^0.31.0
version: 0.31.0(vitest@0.31.0)
concurrently:
specifier: ^8.0.1
version: 8.0.1
@ -173,8 +173,8 @@ importers:
specifier: ^4.3.1
version: 4.3.1(@types/node@18.16.0)
vitest:
specifier: ^0.30.1
version: 0.30.1(@vitest/ui@0.30.1)(jsdom@21.1.1)
specifier: ^0.31.0
version: 0.31.0(@vitest/ui@0.31.0)(jsdom@21.1.1)
packages/mermaid:
dependencies:
@ -3479,13 +3479,6 @@ packages:
resolution: {integrity: sha512-XPSJHWmi394fuUuzDnGz1wiKqWfo1yXecHQMRf2l6hztTO+nPru658AyDngaBe7isIxEkRsPR3FZh+s7iVa4Uw==}
dev: true
/@jridgewell/trace-mapping@0.3.15:
resolution: {integrity: sha512-oWZNOULl+UbhsgB51uuZzglikfIKSUBO/M9W2OfEjn7cmqoAiCgmv9lyACTUacZwBz0ITnJ2NqjU8Tx0DHL88g==}
dependencies:
'@jridgewell/resolve-uri': 3.1.0
'@jridgewell/sourcemap-codec': 1.4.14
dev: true
/@jridgewell/trace-mapping@0.3.17:
resolution: {integrity: sha512-MCNzAp77qzKca9+W/+I0+sEpaUnZoeasnghNeVc41VZCEKaCH73Vq3BZZ/SzWIgrqE4H4ceI+p+b6C0mHf9T4g==}
dependencies:
@ -4717,62 +4710,67 @@ packages:
vue: 3.2.47
dev: true
/@vitest/coverage-c8@0.30.1(vitest@0.30.1):
resolution: {integrity: sha512-/Wa3dtSuckpdngAmiCwowaEXXgJkqPrtfvrs9HTB9QoEfNbZWPu4E4cjEn4lJZb4qcGf4fxFtUA2f9DnDNAzBA==}
/@vitest/coverage-c8@0.31.0(vitest@0.31.0):
resolution: {integrity: sha512-h72qN1D962AO7UefQVulm9JFP5ACS7OfhCdBHioXU8f7ohH/+NTZCgAqmgcfRNHHO/8wLFxx+93YVxhodkEJVA==}
peerDependencies:
vitest: '>=0.30.0 <1'
dependencies:
'@ampproject/remapping': 2.2.1
c8: 7.13.0
magic-string: 0.30.0
picocolors: 1.0.0
std-env: 3.3.2
vitest: 0.30.1(@vitest/ui@0.30.1)(jsdom@21.1.1)
vitest: 0.31.0(@vitest/ui@0.31.0)(jsdom@21.1.1)
dev: true
/@vitest/expect@0.30.1:
resolution: {integrity: sha512-c3kbEtN8XXJSeN81iDGq29bUzSjQhjES2WR3aColsS4lPGbivwLtas4DNUe0jD9gg/FYGIteqOenfU95EFituw==}
/@vitest/expect@0.31.0:
resolution: {integrity: sha512-Jlm8ZTyp6vMY9iz9Ny9a0BHnCG4fqBa8neCF6Pk/c/6vkUk49Ls6UBlgGAU82QnzzoaUs9E/mUhq/eq9uMOv/g==}
dependencies:
'@vitest/spy': 0.30.1
'@vitest/utils': 0.30.1
'@vitest/spy': 0.31.0
'@vitest/utils': 0.31.0
chai: 4.3.7
dev: true
/@vitest/runner@0.30.1:
resolution: {integrity: sha512-W62kT/8i0TF1UBCNMRtRMOBWJKRnNyv9RrjIgdUryEe0wNpGZvvwPDLuzYdxvgSckzjp54DSpv1xUbv4BQ0qVA==}
/@vitest/runner@0.31.0:
resolution: {integrity: sha512-H1OE+Ly7JFeBwnpHTrKyCNm/oZgr+16N4qIlzzqSG/YRQDATBYmJb/KUn3GrZaiQQyL7GwpNHVZxSQd6juLCgw==}
dependencies:
'@vitest/utils': 0.30.1
'@vitest/utils': 0.31.0
concordance: 5.0.4
p-limit: 4.0.0
pathe: 1.1.0
dev: true
/@vitest/snapshot@0.30.1:
resolution: {integrity: sha512-fJZqKrE99zo27uoZA/azgWyWbFvM1rw2APS05yB0JaLwUIg9aUtvvnBf4q7JWhEcAHmSwbrxKFgyBUga6tq9Tw==}
/@vitest/snapshot@0.31.0:
resolution: {integrity: sha512-5dTXhbHnyUMTMOujZPB0wjFjQ6q5x9c8TvAsSPUNKjp1tVU7i9pbqcKPqntyu2oXtmVxKbuHCqrOd+Ft60r4tg==}
dependencies:
magic-string: 0.30.0
pathe: 1.1.0
pretty-format: 27.5.1
dev: true
/@vitest/spy@0.30.1:
resolution: {integrity: sha512-YfJeIf37GvTZe04ZKxzJfnNNuNSmTEGnla2OdL60C8od16f3zOfv9q9K0nNii0NfjDJRt/CVN/POuY5/zTS+BA==}
/@vitest/spy@0.31.0:
resolution: {integrity: sha512-IzCEQ85RN26GqjQNkYahgVLLkULOxOm5H/t364LG0JYb3Apg0PsYCHLBYGA006+SVRMWhQvHlBBCyuByAMFmkg==}
dependencies:
tinyspy: 2.1.0
dev: true
/@vitest/ui@0.30.1:
resolution: {integrity: sha512-Izz4ElDmdvX02KImSC2nCJI6CsGo9aETbKqxli55M0rbbPPAMtF0zDcJIqgEP5V6Y+4Ysf6wvsjLbLCTnaBvKw==}
/@vitest/ui@0.31.0(vitest@0.31.0):
resolution: {integrity: sha512-Dy86l6r3/dbJposgm7w+oqb/15UWJ0lDBbEQaS1ived3+0CTaMbT8OMkUf9vNBkSL47kvBHEBnZLa5fw5i9gUQ==}
peerDependencies:
vitest: '>=0.30.1 <1'
dependencies:
'@vitest/utils': 0.30.1
'@vitest/utils': 0.31.0
fast-glob: 3.2.12
fflate: 0.7.4
flatted: 3.2.7
pathe: 1.1.0
picocolors: 1.0.0
sirv: 2.0.2
vitest: 0.31.0(@vitest/ui@0.31.0)(jsdom@21.1.1)
dev: true
/@vitest/utils@0.30.1:
resolution: {integrity: sha512-/c8Xv2zUVc+rnNt84QF0Y0zkfxnaGhp87K2dYJMLtLOIckPzuxLVzAtFCicGFdB4NeBHNzTRr1tNn7rCtQcWFA==}
/@vitest/utils@0.31.0:
resolution: {integrity: sha512-kahaRyLX7GS1urekRXN2752X4gIgOGVX4Wo8eDUGUkTWlGpXzf5ZS6N9RUUS+Re3XEE8nVGqNyxkSxF5HXlGhQ==}
dependencies:
concordance: 5.0.4
loupe: 2.3.6
@ -13364,7 +13362,7 @@ packages:
uglify-js:
optional: true
dependencies:
'@jridgewell/trace-mapping': 0.3.15
'@jridgewell/trace-mapping': 0.3.17
esbuild: 0.17.18
jest-worker: 27.5.1
schema-utils: 3.1.1
@ -13449,8 +13447,8 @@ packages:
resolution: {integrity: sha512-iyziEiyFxX4kyxSp+MtY1oCH/lvjH3PxFN8PGCDeqcZWAJ/i+9y+nL85w99PxVzrIvew/GSkSbDYtiGVa85Afg==}
dev: true
/tinypool@0.4.0:
resolution: {integrity: sha512-2ksntHOKf893wSAH4z/+JbPpi92esw8Gn9N2deXX+B0EO92hexAVI9GIZZPx7P5aYo5KULfeOSt3kMOmSOy6uA==}
/tinypool@0.5.0:
resolution: {integrity: sha512-paHQtnrlS1QZYKF/GnLoOM/DN9fqaGOFbCbxzAhwniySnzl9Ebk8w73/dd34DAhe/obUbPAOldTyYXQZxnPBPQ==}
engines: {node: '>=14.0.0'}
dev: true
@ -13581,7 +13579,7 @@ packages:
'@tsconfig/node14': 1.0.3
'@tsconfig/node16': 1.0.3
'@types/node': 18.16.0
acorn: 8.8.0
acorn: 8.8.2
acorn-walk: 8.2.0
arg: 4.1.3
create-require: 1.1.1
@ -14087,8 +14085,8 @@ packages:
vfile-message: 3.1.2
dev: true
/vite-node@0.30.1(@types/node@18.16.0):
resolution: {integrity: sha512-vTikpU/J7e6LU/8iM3dzBo8ZhEiKZEKRznEMm+mJh95XhWaPrJQraT/QsT2NWmuEf+zgAoMe64PKT7hfZ1Njmg==}
/vite-node@0.31.0(@types/node@18.16.0):
resolution: {integrity: sha512-8x1x1LNuPvE2vIvkSB7c1mApX5oqlgsxzHQesYF7l5n1gKrEmrClIiZuOFbFDQcjLsmcWSwwmrWrcGWm9Fxc/g==}
engines: {node: '>=v14.18.0'}
hasBin: true
dependencies:
@ -14268,8 +14266,8 @@ packages:
- terser
dev: true
/vitest@0.30.1(@vitest/ui@0.30.1)(jsdom@21.1.1):
resolution: {integrity: sha512-y35WTrSTlTxfMLttgQk4rHcaDkbHQwDP++SNwPb+7H8yb13Q3cu2EixrtHzF27iZ8v0XCciSsLg00RkPAzB/aA==}
/vitest@0.31.0(@vitest/ui@0.31.0)(jsdom@21.1.1):
resolution: {integrity: sha512-JwWJS9p3GU9GxkG7eBSmr4Q4x4bvVBSswaCFf1PBNHiPx00obfhHRJfgHcnI0ffn+NMlIh9QGvG75FlaIBdKGA==}
engines: {node: '>=v14.18.0'}
hasBin: true
peerDependencies:
@ -14302,12 +14300,12 @@ packages:
'@types/chai': 4.3.4
'@types/chai-subset': 1.3.3
'@types/node': 18.16.0
'@vitest/expect': 0.30.1
'@vitest/runner': 0.30.1
'@vitest/snapshot': 0.30.1
'@vitest/spy': 0.30.1
'@vitest/ui': 0.30.1
'@vitest/utils': 0.30.1
'@vitest/expect': 0.31.0
'@vitest/runner': 0.31.0
'@vitest/snapshot': 0.31.0
'@vitest/spy': 0.31.0
'@vitest/ui': 0.31.0(vitest@0.31.0)
'@vitest/utils': 0.31.0
acorn: 8.8.2
acorn-walk: 8.2.0
cac: 6.7.14
@ -14319,13 +14317,12 @@ packages:
magic-string: 0.30.0
pathe: 1.1.0
picocolors: 1.0.0
source-map: 0.6.1
std-env: 3.3.2
strip-literal: 1.0.1
tinybench: 2.4.0
tinypool: 0.4.0
tinypool: 0.5.0
vite: 4.3.3(@types/node@18.16.0)
vite-node: 0.30.1(@types/node@18.16.0)
vite-node: 0.31.0(@types/node@18.16.0)
why-is-node-running: 2.2.2
transitivePeerDependencies:
- less