{"_id":"@dendronhq/remark-mermaid","_rev":"3-2ef587af7f7476fcd70b3f1221b63826","name":"@dendronhq/remark-mermaid","dist-tags":{"latest":"0.4.0"},"versions":{"0.2.0":{"name":"@dendronhq/remark-mermaid","version":"0.2.0","description":"A remark plugin for Markdown that replaces `mermaid` graphs with rendered SVGs.","license":"MIT","keywords":["mermaid","graphs","remark"],"repository":{"type":"git","url":"git+ssh://git@github.com/temando/remark-mermaid.git"},"dependencies":{"fs-extra":"^4.0.1","unist-util-visit":"^1.1.3","which":"^1.3.0"},"devDependencies":{"changelog-verify":"^1.0.4","eslint":"^4.2.0","eslint-config-airbnb-base":"^11.1.0","eslint-plugin-import":"^2.0.0","jest":"^21.2.1","mermaid.cli":"^0.3.1","remark-parse":"^4.0.0","remark-stringify":"^4.0.0","to-vfile":"^2.1.2","unified":"^6.1.5","version-changelog":"^2.1.0","vfile":"^2.2.0"},"scripts":{"lint":"$(npm bin)/eslint src","teardown":"rm -rf test/runtime/*","test":"npm run teardown && $(npm bin)/jest","test:coverage":"npm run teardown && $(npm bin)/jest --coverage --coverageReporters text text-summary","preversion":"npm run lint && npm run test","version":"version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"},"main":"src/index.js","gitHead":"8b13ef9f5362eb4e0a9f56cc8fee3abad70a3ced","bugs":{"url":"https://github.com/temando/remark-mermaid/issues"},"homepage":"https://github.com/temando/remark-mermaid#readme","_id":"@dendronhq/remark-mermaid@0.2.0","_nodeVersion":"12.14.0","_npmVersion":"6.13.4","dist":{"integrity":"sha512-8BwEtYghUJEGTGV77afmXbZgt3zKFcykb3mgUEW6lGoEIrmG5Kz1/AdWNccIMy5qCmH7efBhbDYjqUK09Ag7NQ==","shasum":"e617cd6904c4c435fcd85bd6ed75443cf815b7e8","tarball":"https://registry.npmjs.org/@dendronhq/remark-mermaid/-/remark-mermaid-0.2.0.tgz","fileCount":6,"unpackedSize":14882,"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v3.0.13\r\nComment: https://openpgpjs.org\r\n\r\nwsFcBAEBCAAQBQJgCi8YCRA9TVsSAnZWagAAqAkP/1kEeY9XA4lW6VhqfrXq\ngaupQtwbjj7rcw2Vo3Od4e9yhwWAsOOzcjEuBGk0gvCwiIRyu49lJEaIa40N\n6p+1oARRBx5ssLwDClrnSuIwFsYEje0DVdYDuFFig2UybTqsD71u1SYZnL5S\nWigyfhgJvze3EU/EcV/KyXWIOoEefbqtpUPJZCc5LTrpWEq3gmGQZ3vatI+t\nAU/kTNIseaQyECg1Huige1h6zokpyrHMVXjLdLz8Wf0YtHrzZLuWfixVI0MN\npAYJIes3nznv55JgvEbiSHMyhpHrb1/tCsx/2OvrKLMZL3lPEcwlxIooPBbb\nwwjYRdCzrYievm2DNhwHUW0PFTCozsz7efJKrQwi0kuO1phS97EDsif4apEL\nxuKN3ExWhWR+89NbAQozgQG9ai6iyvsCqlS4VMnmepqynnJxfUJzuqgA+EZp\nq9QaqsdRPZb6n1kErUp0adbE4+8DqKi407WZn67hnfA63YLyQQP3skxxB8Ay\nNx8mngKQ1cavbhFhJ1bA5KbdaNPcNrKp0SAGtADIBZsyTRaUqO0aSiKkdUOM\nFDuqfJhG+3OfQEUeBFUU0WJtCdC4FRfIShYQbc5KTIDEqhn5fJAZHxgkldP9\nDwkG8dYiYjhX/oBnrIwlHxFqre5S/PZorVUyvOKdFezs9jz7M+AsCdbpcWWA\nujOz\r\n=DO9P\r\n-----END PGP SIGNATURE-----\r\n","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIHij6+w+j+Be/SlW4ZulshCJRmWKoQ6cMqc/Nrh53CZ2AiEA6esPdQnlz1lfCOMaJcvsI7fRMD8kAPTMVPFzqunPZPI="}]},"_npmUser":{"name":"kevins8","email":"kevinslin8@gmail.com"},"directories":{},"maintainers":[{"name":"kevins8","email":"kevinslin8@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-mermaid_0.2.0_1611280151723_0.2624840545705083"},"_hasShrinkwrap":false},"0.3.0":{"name":"@dendronhq/remark-mermaid","version":"0.3.0","description":"A remark plugin for Markdown that replaces `mermaid` graphs with rendered SVGs.","license":"MIT","keywords":["mermaid","graphs","remark"],"repository":{"type":"git","url":"git+ssh://git@github.com/temando/remark-mermaid.git"},"dependencies":{"fs-extra":"^4.0.1","unist-util-visit":"^1.1.3","which":"^1.3.0"},"devDependencies":{"changelog-verify":"^1.0.4","eslint":"^4.2.0","eslint-config-airbnb-base":"^11.1.0","eslint-plugin-import":"^2.0.0","jest":"^21.2.1","mermaid.cli":"^0.3.1","remark-parse":"^4.0.0","remark-stringify":"^4.0.0","to-vfile":"^2.1.2","unified":"^6.1.5","version-changelog":"^2.1.0","vfile":"^2.2.0"},"scripts":{"lint":"$(npm bin)/eslint src","teardown":"rm -rf test/runtime/*","test":"npm run teardown && $(npm bin)/jest","test:coverage":"npm run teardown && $(npm bin)/jest --coverage --coverageReporters text text-summary","preversion":"npm run lint && npm run test","version":"version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"},"main":"src/index.js","gitHead":"16874c08cb02d36647c24412c9ae6c83c991e1ed","bugs":{"url":"https://github.com/temando/remark-mermaid/issues"},"homepage":"https://github.com/temando/remark-mermaid#readme","_id":"@dendronhq/remark-mermaid@0.3.0","_nodeVersion":"14.18.2","_npmVersion":"7.20.3","dist":{"integrity":"sha512-CL2DbhBHAXXPN+0GNoW2xi8jl4YkslZLY3ElGUB+F5v12on58jjAbnkvKo3JLgMTuaSXw1KNz2crJuPo43UJOA==","shasum":"5e943020fbfbce4ae4c9cc7cba25a93e5a880fb6","tarball":"https://registry.npmjs.org/@dendronhq/remark-mermaid/-/remark-mermaid-0.3.0.tgz","fileCount":5,"unpackedSize":13828,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIFpm+0D3TDu5fSGc1inSmtau32uP4CAb9p7yQara4u6dAiA/a5Bebz72rE7oF95gRzf7dhAAU/oeYLXTXQlvmZjXaA=="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJih/khACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmoepQ//R3ssHwXQcGJsBWPzFJFeansScKh1LWsVa8UZeZiOVZtfXHHu\r\n0Qk9kKUntgU40GhA5RgnhHsD2iEgN0Ofdaj7+oFytmg+wfqCKARlTTsZxrxz\r\nH1DdN0wKM3HEJzE9YoTwTcPIgN8PrXFekYNoYqy37CmcYwcLn6fViyNWc0jA\r\nkODa0GzhWkFehu2+xk6ZfJblD6zgR3CMxj0brWNuzd1Ns1bikZtpajlM3UfW\r\npk+JyyeoFulVtaS4oFsC2KRLINkOwNElfb2BAWVK+kO/cOzm1veNv0S7748W\r\nG8BfXYbhzEvJDIZMZ2bDBcUq9RbzjmcrweShljGbvl/zi0OYx4DHdF34/2hs\r\ngwzB1YEOCfF4r5GHaFhudfmWLuCQco0dWPfnRynso8Hwdwl8TVM4UNMNlmHa\r\nFxq7lLIDhDsFzVg8Onq57Yt92ZMIQYfaUpSjgbKAgRmNLeht5mKo1FdRbv6g\r\n+jHb+r4QFleINUnfeX8+nrFNL6pr8JRIJ9MNhmos0zUK+bj1hhPRW9dqrSzc\r\nq8cU0rfvKk4E3cnWzfiB86Spdc5Mb7puOJHzWF+MNsZsLqWH5y3bDPVXxAkS\r\nx5PbA+RUPVQ3qDrVbLPlE5M1AXFk7GsZBjiIhrs71XzXpcaZt8Hh/O6l6EXp\r\nRCnGvXx44B494KuuCUl1uA/m2vEuw1ZDLRU=\r\n=qUr4\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"kevins8","email":"kevinslin8@gmail.com"},"directories":{},"maintainers":[{"name":"kevins8","email":"kevinslin8@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-mermaid_0.3.0_1653078305222_0.07850324009914544"},"_hasShrinkwrap":false},"0.4.0":{"name":"@dendronhq/remark-mermaid","version":"0.4.0","description":"A remark plugin for Markdown that replaces `mermaid` graphs with rendered SVGs.","license":"MIT","keywords":["mermaid","graphs","remark"],"repository":{"type":"git","url":"git+ssh://git@github.com/temando/remark-mermaid.git"},"dependencies":{"unist-util-visit":"^1.1.3"},"devDependencies":{"changelog-verify":"^1.0.4","eslint":"^4.2.0","eslint-config-airbnb-base":"^11.1.0","eslint-plugin-import":"^2.0.0","jest":"^21.2.1","mermaid.cli":"^0.3.1","remark-parse":"^4.0.0","remark-stringify":"^4.0.0","to-vfile":"^2.1.2","unified":"^6.1.5","version-changelog":"^2.1.0","vfile":"^2.2.0"},"scripts":{"lint":"$(npm bin)/eslint src","teardown":"rm -rf test/runtime/*","test":"npm run teardown && $(npm bin)/jest","test:coverage":"npm run teardown && $(npm bin)/jest --coverage --coverageReporters text text-summary","preversion":"npm run lint && npm run test","version":"version-changelog CHANGELOG.md && changelog-verify CHANGELOG.md && git add CHANGELOG.md"},"main":"src/index.js","gitHead":"31e9ca31ec8ead3597e6cb00ca0ba73e9f267438","bugs":{"url":"https://github.com/temando/remark-mermaid/issues"},"homepage":"https://github.com/temando/remark-mermaid#readme","_id":"@dendronhq/remark-mermaid@0.4.0","_nodeVersion":"14.18.2","_npmVersion":"7.20.3","dist":{"integrity":"sha512-qQryznn2+Fy3FLE9rmXOuEB3MSOM6jbb4VIjLIypY6vQYgkblTIPlDH5iPCPMzAuECR9qrHJlKmKpEN97ThxlQ==","shasum":"d9158e9e12343472c929e9ba0c90748ebdda65eb","tarball":"https://registry.npmjs.org/@dendronhq/remark-mermaid/-/remark-mermaid-0.4.0.tgz","fileCount":5,"unpackedSize":13857,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIQCIz3fOTZDC6BnTs2jgNiZpMV29u7dYwWHkcdmhuWSvZgIgXDzG7HsPxtNJKBWFp0AvoW/YGkm+YEhn4FcLpe2yFjw="}],"npm-signature":"-----BEGIN PGP SIGNATURE-----\r\nVersion: OpenPGP.js v4.10.10\r\nComment: https://openpgpjs.org\r\n\r\nwsFzBAEBCAAGBQJjDuaIACEJED1NWxICdlZqFiEECWMYAoorWMhJKdjhPU1b\r\nEgJ2VmqahQ//b6uafAwLilIFvMghqJ3iq6bPB0Z48xLpKc2sQWH+Qo7S2q28\r\nj0R2YhBfT+PiY5CpyEB3cnTw0wtCq+zJ7aU51An5g/UWgo+JAOGrl7/VrsQF\r\n3/qGoCkkE5HvUngAnAtBWoBXHKhyZQyvr3aGlFEtdPFuy0cGAj+jrXA2NJVN\r\neq1ZKgo8mSDMIAZ0egIq0wU3LTpmGaBLKObBiOtCkBYCzAEvqqK2TpRnU+61\r\nHNv8XrWDZ+LOuIC21C35VcSzB4oJHLiTUduPOZnbn6c6gM951zVwXNuchvHy\r\nQL/CmqJAorueow0TbmXJfLMIkCPQgtD11NPxUVfiX1bSmekE83x78bQilUsV\r\n9QLsDmCpPWtcGLvU4w5JhzncvIcC0PNHkhDBj2Jsp+wGAG4vh2fvXgReOUZo\r\nJfwSlmVrFx0o29vy7Gdonl+0pgecqt6rBvgpABqDwxujKfqzhmRAXmRyaNtA\r\nSM48fG+qJImS2JaxDUV2+z99UIqpRkXiZMcT61GH7qUkwb6WjLkxDMgzSjs9\r\n2eqUAp/5dlvmF1QB5pNIFe9gFkdRPx9PpHkt6unkY+wyIRsQa/A+MP18wxel\r\nwI3PFny3+fvvZ+P91EBYU6jNkf4MvDmfdZIkbpa/ytlrxMr5PyAjcyXvJeYA\r\n+YI+RdHHBnpfDqniwpK4hbB3ULjKNv/KfTM=\r\n=nENx\r\n-----END PGP SIGNATURE-----\r\n"},"_npmUser":{"name":"kevins8","email":"kevinslin8@gmail.com"},"directories":{},"maintainers":[{"name":"kevins8","email":"kevinslin8@gmail.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/remark-mermaid_0.4.0_1661920904614_0.5618369799911622"},"_hasShrinkwrap":false}},"time":{"created":"2021-01-22T01:49:11.513Z","0.2.0":"2021-01-22T01:49:11.853Z","modified":"2022-08-31T04:41:44.840Z","0.3.0":"2022-05-20T20:25:05.393Z","0.4.0":"2022-08-31T04:41:44.750Z"},"maintainers":[{"name":"kevins8","email":"kevinslin8@gmail.com"}],"description":"A remark plugin for Markdown that replaces `mermaid` graphs with rendered SVGs.","homepage":"https://github.com/temando/remark-mermaid#readme","keywords":["mermaid","graphs","remark"],"repository":{"type":"git","url":"git+ssh://git@github.com/temando/remark-mermaid.git"},"bugs":{"url":"https://github.com/temando/remark-mermaid/issues"},"license":"MIT","readme":"# remark-mermaid\n\n[![NPM](https://img.shields.io/npm/v/remark-mermaid.svg)](https://npmjs.org/packages/remark-mermaid/)\n[![Travis CI](https://img.shields.io/travis/temando/remark-mermaid.svg)](https://travis-ci.org/temando/remark-mermaid)\n[![MIT License](https://img.shields.io/github/license/temando/remark-mermaid.svg)](https://en.wikipedia.org/wiki/MIT_License)\n\nReplaces fenced code blocks in mermaid format with:\n\n- Links to rendered SVG files of the graph (default mode).\n- Mermaid-formatted code wrapped in div tags for rendering by mermaidjs (simple mode).\n\nYou might also like [`remark-graphviz`](https://www.npmjs.com/package/remark-graphviz).\n\n## Installation\n\n```sh\n$ npm install remark-mermaid mermaid.cli\n```\n\n## Usage\n\nGraphs defined using `mermaid` can be referenced using a `mermaid:` title which\nwill generate an SVG image.\n\n```md\n[Link to a Graph](test/fixtures/assets/example.mmd \"mermaid:\")\n![Embed image of graph](test/fixtures/assets/example.mdd \"mermaid:\")\n```\n\nAlternatively, graphs can be generated inline, by using `mermaid` as the\nlanguage identifier for a fenced code block.\n\n<pre>\n```mermaid\ngraph LR\n    Start --> Stop\n```\n</pre>\n\nSee this project's [fixtures](test/fixtures) for more examples.\n\n### Options\n\n- `simple`: when set to `true`, plugin will wrap mermaid graphs in an `<div class=\"mermaid\">` element instead of generating an SVG. Defaults to `false`.\n\n## Example\n\n### SVG Generation\n\nGiven a file, `example.md`, which contains the following Markdown:\n\n<pre>\n# mermaid code block\n\n```mermaid\ngraph LR\n    Start --> Stop\n```\n</pre>\n\nUsing remark like follows:\n\n```js\nvar vfile = require('to-vfile');\nvar remark = require('remark');\nvar mermaid = require('remark-mermaid');\n\nvar example = vfile.readSync('example.md');\n\nremark()\n  .use(mermaid)\n  .process(example, function (err, file) {\n    if (err) throw err;\n    console.log(String(file));\n  });\n```\n\nWill result in an SVG being written relative to `example.md`, and the Markdown\nbeing transformed to:\n\n```md\n# mermaid code block\n\n![](./6b03e143dc2a47a93496133d692c44d5ec012b57.svg \"`mermaid` image\")\n```\n\nTo change where the SVG's are written, set `data.destinationDir` on the vFile:\n\n```js\nvar vfile = require('to-vfile');\nvar remark = require('remark');\nvar mermaid = require('remark-mermaid');\n\nvar example = vfile.readSync('example.md');\nexample.data = {\n  destinationDir: '~/absolute/path/to/output'\n};\n\nremark()\n  .use(mermaid)\n  .process(example, function (err, file) {\n    if (err) throw err;\n    vfile.writeSync({ path: example.destinationFilePath });\n  });\n```\n\nThis allows you process files from one directory, and save the results to another.\n\n### Simple mode\n\nThe following code sample enables simple mode:\n\n```js\nvar vfile = require('to-vfile');\nvar remark = require('remark');\nvar mermaid = require('remark-mermaid');\n\nvar example = vfile.readSync('example.md');\n\nremark()\n  .use(mermaid, { simple: true })\n  .process(example, function (err, file) {\n    if (err) throw err;\n    console.log(String(file));\n  });\n```\n\nThis will result in the following Markdown output:\n\n```md\n# mermaid code block\n\n<div class=\"mermaid\">\n  graph LR\n    Start --> Stop\n</div>\n```\n\n[mermaidjs](https://mermaidjs.github.io/usage.html)\n","readmeFilename":"README.md"}