{"_id":"@cristinaperea/mermaid","_rev":"2-8ae3c477206680e098e64fdb6f0b5607","name":"@cristinaperea/mermaid","dist-tags":{"latest":"8.2.1"},"versions":{"8.4.2":{"name":"@cristinaperea/mermaid","version":"8.4.2","description":"Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.","main":"dist/mermaid.core.js","keywords":["diagram","markdown","flowchart","sequence diagram","gantt","class diagram","git graph"],"scripts":{"build":"webpack --progress --colors --config webpack.config.babel.js","postbuild":"documentation build src/mermaidAPI.js --shallow -f md --markdown-toc false -o docs/mermaidAPI.md","build:watch":"yarn build --watch","minify":"minify ./dist/mermaid.js > ./dist/mermaid.min.js","release":"yarn build -p --config webpack.config.prod.babel.js","lint":"eslint src","e2e:depr":"yarn lint && jest e2e --config e2e/jest.config.js","cypress":"percy exec -- cypress run","e2e":"start-server-and-test dev http://localhost:9000/ cypress","e2e-upd":"yarn lint && jest e2e -u --config e2e/jest.config.js","dev":"webpack-dev-server --config webpack.config.e2e.js","test":"yarn lint && jest src","test:watch":"jest --watch src","prepush":"yarn test"},"repository":{"type":"git","url":"git+https://github.com/knsv/mermaid.git"},"author":{"name":"Knut Sveidqvist"},"license":"MIT","standard":{"ignore":["**/parser/*.js","dist/**/*.js","cypress/**/*.js"],"globals":["page"]},"dependencies":{"@braintree/sanitize-url":"^3.1.0","crypto-random-string":"^3.0.1","d3":"^5.7.0","dagre-d3":"github:dagrejs/dagre-d3","graphlib":"^2.1.7","he":"^1.2.0","lodash":"^4.17.11","minify":"^4.1.1","moment-mini":"^2.22.1","prettier":"^1.18.2","scope-css":"^1.2.1"},"devDependencies":{"documentation":"^12.0.1","eslint":"^6.3.0","eslint-config-prettier":"^6.3.0","eslint-plugin-prettier":"^3.1.0","@babel/core":"^7.2.2","@babel/preset-env":"^7.2.0","@babel/register":"^7.0.0","@percy/cypress":"^2.0.1","babel-core":"7.0.0-bridge.0","babel-jest":"^23.6.0","babel-loader":"^8.0.4","coveralls":"^3.0.2","css-loader":"^2.0.1","css-to-string-loader":"^0.1.3","cypress":"3.4.0","husky":"^1.2.1","identity-obj-proxy":"^3.0.0","jest":"^23.6.0","jest-environment-puppeteer":"^4.2.0","jest-image-snapshot":"^2.8.2","jest-puppeteer":"^4.2.0","jison":"^0.4.18","moment":"^2.23.0","node-sass":"^4.12.0","puppeteer":"^1.17.0","sass-loader":"^7.1.0","start-server-and-test":"^1.10.0","webpack":"^4.27.1","webpack-cli":"^3.1.2","webpack-dev-server":"^3.4.1","webpack-node-externals":"^1.7.2","yarn-upgrade-all":"^0.5.0"},"yarn-upgrade-all":{"ignore":["babel-core"]},"gitHead":"bdeb5ce478200aa6a97e0b819af3f403a40764bf","bugs":{"url":"https://github.com/knsv/mermaid/issues"},"homepage":"https://github.com/knsv/mermaid#readme","_id":"@cristinaperea/mermaid@8.4.2","_nodeVersion":"10.13.0","_npmVersion":"6.11.3","dist":{"integrity":"sha512-sLm35M45b91NYKlYUlLefFjR5XGOYWxiERGxeihGfTX6B2r6RlsBhhgP0Lej0ieZK9DfQx0mKr6958aMLESHEQ==","shasum":"e4e565f1bfcf1446e22552d8fdbbf21fbfccd879","tarball":"https://registry.npmjs.org/@cristinaperea/mermaid/-/mermaid-8.4.2.tgz","fileCount":13,"unpackedSize":14264771,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzRNgCRA9TVsSAnZWagAA+3AP/jOBYBhDabnHx3jUFRP7\ndsfI7NbbWxn/N5UxgNwTFZUu0ZuDHUJzwFtcuwQAbT4RhCxMk+5L6st9AyYJ\nzsEbYmfu5MmDHehr3l4R+nPX3AW4SiFPYSkiiv7shdaj1scb2xJPnXHOe0st\nyhZ4JuzyvDdTw25e63LDXlNJEAq5HbJwoKS0md6soklB36HXbIUDaLQXwVXq\nZIO73fFv+GzuLo3W/KvN85pX5gOEalX2BzmbBgOuHbFLY+hbZdC9fcTyhJli\nPcatCeZbhRRkvpfvk932xbdi/OmqE+oEylsAI76IdnQYrOXHUtlMRZg6Z9r7\nvkFl//E4vwKX/ZySWm70vVA60BfHQ6jiVowwGbxffmV1eHI2F3VgvtvsPlsD\n56ShrlmK7j1p4IBbOSBORiczJ/QrcqAogaocsVbtVhiWEiEfYJvDRPGtgVw9\nTGtn+PteSYxpalUNVbdZslL9iIiPCL3c1cvUlPoK68ZndCjKUPTGEuks/9mq\n/OzMFx9gl0EpAuRHysOaCicD2cfhJrpNo1yidhxDrJJ+FAc9uZInDknUrZLW\ntqFmH1m/LUQ65IzfENeKBjbxwzaCsgkrqvUPnBBvjJhYnD/O80DIuccAFvFw\nCQkauAd/JaZVdCHQmbZcN8LF5bLfISWsjUnv7iwVb+6mGyh1FmplFIMxmej3\nXY/t\r\n=hiNk\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCrabYtutUw0jRX8rKgwB5ZwIKcMGX8FRHSKfN8DUiwQQIgbYtNN9fAqZirZPo8M/NoHLkEsjBRD0RC0lBJjklMEUY="}]},"maintainers":[{"name":"cristinaperea","email":"criperrui@gmail.com"}],"_npmUser":{"name":"cristinaperea","email":"criperrui@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mermaid_8.4.2_1573720927384_0.46677192095120534"},"_hasShrinkwrap":false},"8.2.1":{"name":"@cristinaperea/mermaid","version":"8.2.1","description":"Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.","main":"dist/mermaid.core.js","keywords":["diagram","markdown","flowchart","sequence diagram","gantt","class diagram","git graph"],"scripts":{"build":"webpack --progress --colors --config webpack.config.babel.js","postbuild":"documentation build src/mermaidAPI.js --shallow -f md --markdown-toc false -o docs/mermaidAPI.md","build:watch":"yarn build --watch","minify":"minify ./dist/mermaid.js > ./dist/mermaid.min.js","release":"yarn build -p --config webpack.config.prod.babel.js","lint":"standard","e2e":"yarn lint && jest e2e --config e2e/jest.config.js","e2e-upd":"yarn lint && jest e2e -u --config e2e/jest.config.js","dev":"yarn lint && webpack-dev-server --config webpack.config.e2e.js","test":"yarn lint && jest src","test:watch":"jest --watch src","jison":"node -r @babel/register node_modules/.bin/gulp jison","prepush":"yarn test"},"repository":{"type":"git","url":"git+https://github.com/knsv/mermaid.git"},"author":{"name":"Knut Sveidqvist"},"license":"MIT","standard":{"ignore":["**/parser/*.js","dist/**/*.js"],"globals":["page"]},"dependencies":{"d3":"^5.7.0","dagre-d3-renderer":"^0.5.8","dagre-layout":"^0.8.8","documentation":"^12.0.1","graphlibrary":"^2.2.0","gulp-print":"^5.0.2","he":"^1.2.0","lodash":"^4.17.11","minify":"^4.1.1","moment-mini":"^2.22.1","scope-css":"^1.2.1"},"devDependencies":{"@babel/core":"^7.2.2","@babel/preset-env":"^7.2.0","@babel/register":"^7.0.0","babel-core":"7.0.0-bridge.0","babel-jest":"^23.6.0","babel-loader":"^8.0.4","coveralls":"^3.0.2","css-loader":"^2.0.1","css-to-string-loader":"^0.1.3","gulp":"^4.0.0","gulp-jison":"^1.2.0","husky":"^1.2.1","identity-obj-proxy":"^3.0.0","jest":"^23.6.0","jest-environment-puppeteer":"^4.2.0","jest-image-snapshot":"^2.8.2","jest-puppeteer":"^4.2.0","jison":"^0.4.18","moment":"^2.23.0","node-sass":"^4.11.0","puppeteer":"^1.17.0","sass-loader":"^7.1.0","standard":"^12.0.1","webpack":"^4.27.1","webpack-cli":"^3.1.2","webpack-dev-server":"^3.4.1","webpack-node-externals":"^1.7.2","yarn-upgrade-all":"^0.5.0"},"yarn-upgrade-all":{"ignore":["babel-core"]},"gitHead":"5dd392127f1121dea2a05fb0a535101c085496b2","bugs":{"url":"https://github.com/knsv/mermaid/issues"},"homepage":"https://github.com/knsv/mermaid#readme","_id":"@cristinaperea/mermaid@8.2.1","_nodeVersion":"10.13.0","_npmVersion":"6.11.3","dist":{"integrity":"sha512-hOs4nC9ZohsG4WERMdzsfApz0nqMJefcY1d7xSkAB9USq3NMmYj6pSf8/obXfbegOKLes/4QdQis/M0toulckw==","shasum":"766d14429f528b181d9160721d15e847584497f3","tarball":"https://registry.npmjs.org/@cristinaperea/mermaid/-/mermaid-8.2.1.tgz","fileCount":11,"unpackedSize":6581237,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.4\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJdzRomCRA9TVsSAnZWagAA+P4P/jeypBREp3CLRvb1IpcR\n+GopyJTZaLD10kvxtXi77GUx+flnu2U0IZLBZWFdTa38mHhyUgaE+hGI3vIE\nikj2z7rsnD5lr/t6tvOk/N8Z6TXocPUzy5Sj0+ynkE3tNVxTNr4MgDHiVr35\nOdDogA028iQgvdTyzKJshxoWzVOGnVsI0UzGbBjc3QwLuG2znWpGTYXeRwlr\ncS/eLWHXV1c4SMS7mkIVs+eCxNBM8TweB8Hnh9ue2ybMch6HMjtWQSTw46QU\nbXGsFa3aclyD7dhZIBOiTWYjUsjTGQTZmhaVTetFnq+MzVfyStuh9LpqZ1AY\nv2rwISoCBqQw6yykYxtXT1jw3IETWfGoyXHa0Wa7k31SSftdOQcPofcnOyxb\nMie7TURc00FCNOjNb6HiIbSj8X5OOw+ibKHLGFPt507WzhSeSG6q0yVR0GYA\nfwJHV4H9pr0+/Cs4SCkOpDTBYV5IyJcp20si58mzXa/CKvEL2gT9i1wY5MxL\nrGORuFA6WSjQK1WL7xYS9mFWuVn55sbOD7wreN6eYasczX2R2hjOAJQMEGTv\nHxArQlf770r16EGzcKZ/dLvia6nu9xHWzqhdHN4V4Tui8jvBxti8PgaKfU1I\nYTa3mjybWCn5x5JgHiqheLHbWRVgZKd6eVk3ZCSCqfTTLUWBy/QLUWjid8zZ\nC6ku\r\n=TCsY\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQC/xEd0SYdO/N+rnclfTVsXv2MlkVfSvMQK9U4sKJqjoQIgDjSahI7SJiUXvq2kBsM6R0lBl/Q3h6ZnfyW23k2tWT8="}]},"maintainers":[{"name":"cristinaperea","email":"criperrui@gmail.com"}],"_npmUser":{"name":"cristinaperea","email":"criperrui@gmail.com"},"directories":{},"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mermaid_8.2.1_1573722662468_0.8962918316588528"},"_hasShrinkwrap":false}},"time":{"created":"2019-11-14T08:42:07.133Z","8.4.2":"2019-11-14T08:42:07.751Z","modified":"2022-04-05T01:50:07.939Z","8.2.1":"2019-11-14T09:11:02.639Z"},"maintainers":[{"name":"cristinaperea","email":"criperrui@gmail.com"}],"description":"Markdownish syntax for generating flowcharts, sequence diagrams, class diagrams, gantt charts and git graphs.","homepage":"https://github.com/knsv/mermaid#readme","keywords":["diagram","markdown","flowchart","sequence diagram","gantt","class diagram","git graph"],"repository":{"type":"git","url":"git+https://github.com/knsv/mermaid.git"},"author":{"name":"Knut Sveidqvist"},"bugs":{"url":"https://github.com/knsv/mermaid/issues"},"license":"MIT","readme":"[](https://travis-ci.org/knsv/mermaid)\r\n[](https://coveralls.io/github/knsv/mermaid?branch=master)\r\n[](https://gitter.im/knsv/mermaid?utm_source=badge&utm_medium=badge&utm_campaign=pr-badge&utm_content=badge)\r\n\r\n# mermaid\r\n\r\n## Special note regarding version 8.2\r\n\r\nIn version 8.2 a security improvement was introduced. A securityLevel configuration was introduced wich sets the level of trust to be used on the parsed diagrams.\r\n\r\n* **true**: (default) tags in text are encoded, click functionality is disabled\r\n* false: tags in text are allowed, click functionality is enabledClosed issues: \r\n\r\nâ ď¸ **Note** : This changes the default behaviour of mermaid so that after upgrade to 8.2, if the securityLevel is not configured, tags in flowcharts are encoded as tags and clicking is prohibited.\r\n\r\nIf your application is taking resposibility for the diagram source security you can set the securityLevel accordingly. By doing this clicks and tags are again allowed.\r\n\r\n```javascript\r\n mermaidAPI.initialize({\r\n securityLevel: 'loose'\r\n });\r\n```\r\n\r\n**đ Keep a steady pulse: mermaid needs more Collaborators [#866](https://github.com/knsv/mermaid/issues/866)**\r\n\r\n\r\n\r\nGeneration of diagrams and flowcharts from text in a similar manner as markdown.\r\n\r\nEver wanted to simplify documentation and avoid heavy tools like Visio when explaining your code?\r\n\r\nThis is why mermaid was born, a simple markdown-like script language for generating charts from text via javascript.\r\n\r\n**Mermaid was nomiated and won the JS Open Source Awards (2019) in the catory The most existing use of technology!!! Thanks to all involved, people committing pull requests, people answering questions and special thanks to Tyler Long who is helping me maintain the project.**\r\n\r\n### Flowchart\r\n\r\n```\r\ngraph TD;\r\n A-->B;\r\n A-->C;\r\n B-->D;\r\n C-->D;\r\n```\r\n\r\n\r\n\r\n### Sequence diagram\r\n\r\n```\r\nsequenceDiagram\r\n participant Alice\r\n participant Bob\r\n Alice->>John: Hello John, how are you?\r\n loop Healthcheck\r\n John->>John: Fight against hypochondria\r\n end\r\n Note right of John: Rational thoughts
prevail!\r\n John-->>Alice: Great!\r\n John->>Bob: How about you?\r\n Bob-->>John: Jolly good!\r\n```\r\n\r\n\r\n\r\n### Gantt diagram\r\n\r\n```\r\ngantt\r\ndateFormat YYYY-MM-DD\r\ntitle Adding GANTT diagram to mermaid\r\nexcludes weekdays 2014-01-10\r\n\r\nsection A section\r\nCompleted task :done, des1, 2014-01-06,2014-01-08\r\nActive task :active, des2, 2014-01-09, 3d\r\nFuture task : des3, after des2, 5d\r\nFuture task2 : des4, after des3, 5d\r\n```\r\n\r\n\r\n\r\n### Class diagram - :exclamation: experimental\r\n\r\n```\r\nclassDiagram\r\nClass01 <|-- AveryLongClass : Cool\r\nClass03 *-- Class04\r\nClass05 o-- Class06\r\nClass07 .. Class08\r\nClass09 --> C2 : Where am i?\r\nClass09 --* C3\r\nClass09 --|> Class07\r\nClass07 : equals()\r\nClass07 : Object[] elementData\r\nClass01 : size()\r\nClass01 : int chimp\r\nClass01 : int gorilla\r\nClass08 <--> C2: Cool label\r\n```\r\n\r\n\r\n\r\n### Git graph - :exclamation: experimental\r\n\r\n```\r\ngitGraph:\r\noptions\r\n{\r\n \"nodeSpacing\": 150,\r\n \"nodeRadius\": 10\r\n}\r\nend\r\ncommit\r\nbranch newbranch\r\ncheckout newbranch\r\ncommit\r\ncommit\r\ncheckout master\r\ncommit\r\ncommit\r\nmerge newbranch\r\n\r\n```\r\n\r\n\r\n\r\n\r\n## Installation\r\n\r\n### CDN\r\n\r\n```\r\nhttps://unpkg.com/mermaid@/dist/\r\n```\r\n\r\nReplace `` with expected version number.\r\n\r\nExample: https://unpkg.com/mermaid@7.1.0/dist/\r\n\r\n### Node.js\r\n\r\n```\r\nyarn add mermaid\r\n```\r\n\r\n\r\n## Documentation\r\n\r\nhttps://mermaidjs.github.io\r\n\r\n\r\n## Sibling projects\r\n\r\n- [mermaid CLI](https://github.com/mermaidjs/mermaid.cli)\r\n- [mermaid live editor](https://github.com/mermaidjs/mermaid-live-editor)\r\n- [mermaid webpack demo](https://github.com/mermaidjs/mermaid-webpack-demo)\r\n- [mermaid Parcel demo](https://github.com/mermaidjs/mermaid-parcel-demo)\r\n\r\n\r\n# Request for assistance\r\n\r\nThings are piling up and I have hard time keeping up. To remedy this\r\nit would be great if we could form a core team of developers to cooperate\r\nwith the future development mermaid.\r\n\r\nAs part of this team you would get write access to the repository and would\r\nrepresent the project when answering questions and issues.\r\n\r\nTogether we could continue the work with things like:\r\n* adding more types of diagrams like mindmaps, ert diagrams etc\r\n* improving existing diagrams\r\n\r\nDon't hesitate to contact me if you want to get involved.\r\n\r\n\r\n# For contributors\r\n\r\n## Setup\r\n\r\n yarn install\r\n\r\n\r\n## Build\r\n\r\n yarn build:watch\r\n\r\n\r\n## Lint\r\n\r\n yarn lint\r\n\r\nWe use [JavaScript Standard Style](https://github.com/feross/standard).\r\nWe recommend you installing [editor plugins](https://github.com/feross/standard#are-there-text-editor-plugins) so you can get real time lint result.\r\n\r\n\r\n## Test\r\n\r\n yarn test\r\n\r\nManual test in browser:\r\n\r\n open dist/index.html\r\n\r\n\r\n## Release\r\n\r\nFor those who have the permission to do so:\r\n\r\nUpdate version number in `package.json`.\r\n\r\n npm publish\r\n\r\nCommand above generates files into the `dist` folder and publishes them to npmjs.org.\r\n\r\n\r\n# Credits\r\n\r\nMany thanks to the [d3](http://d3js.org/) and [dagre-d3](https://github.com/cpettitt/dagre-d3) projects for providing the graphical layout and drawing libraries!\r\n\r\nThanks also to the [js-sequence-diagram](http://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.\r\n\r\n*Mermaid was created by Knut Sveidqvist for easier documentation.*\r\n\r\n*[Tyler Long](https://github.com/tylerlong) has became a collaborator since April 2017.*\r\n\r\nHere is the full list of the projects [contributors](https://github.com/knsv/mermaid/graphs/contributors).\r\n","readmeFilename":"README.md"}