` 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
\n# mermaid code block\n\n```mermaid\ngraph LR\n Start --> Stop\n```\n
\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
\n graph LR\n Start --> Stop\n
\n```\n\n[mermaidjs](https://mermaidjs.github.io/usage.html)\n","maintainers":[{"name":"robot.grylls","email":"robot.grylls@temando.com"}],"time":{"modified":"2022-06-26T11:03:10.992Z","created":"2017-11-10T03:19:34.488Z","0.1.0":"2017-11-10T03:19:34.488Z","0.1.1":"2017-11-14T03:54:03.626Z","0.1.2":"2017-11-15T01:52:45.275Z","0.2.0":"2018-01-07T23:46:32.080Z"},"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","readmeFilename":"README.md"}