{"_id":"@binpar/mermaid-filter","_rev":"4-1e7234cfbb62623784f1d0c1cc10c943","name":"@binpar/mermaid-filter","dist-tags":{"latest":"1.4.18"},"versions":{"1.4.16":{"name":"@binpar/mermaid-filter","version":"1.4.16","description":"Pandoc filter for mermaid (including mermaid-v9)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["pandoc","mermaid"],"repository":{"type":"git","url":"https://github.com/marcelmaatkamp/mermaid-filter-tmp-v9"},"author":{"name":"Raghu Rajagopalan"},"license":"BSD-2-Clause","preferGlobal":true,"bin":{"mermaid-filter":"index.js"},"dependencies":{"@mermaid-js/mermaid-cli":"~9","imgur":"^0.3.1","lodash":"^4.17.13","minimist":">=0.2.1","pandoc-filter":"^0.1.3","sanitize-filename":"1.6.1","tmp":"0.0.28","winston":"^3.8.2"},"_id":"@binpar/mermaid-filter@1.4.16","dist":{"shasum":"1ee38ad1bec7449b0595f965eabd43125421fa94","integrity":"sha512-HU8J/QueQOFoaJoRU+72xzQP1s3/sD7McDOor7lKpoHBOL3+x7VsBWmAJIta8JJ/MJAlrpz1X8k6kMZVoiZGjA==","tarball":"https://registry.npmjs.org/@binpar/mermaid-filter/-/mermaid-filter-1.4.16.tgz","fileCount":4,"unpackedSize":10209,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCIAwaUvfJXLwY9+pfhfoO2/m72m+VbsMwzHM8HT6l1qx5AiA3wrFE36dxJlt/X7jL1v+buSkV+ehs440cc2WcWrasmQ=="}]},"_npmUser":{"name":"drnachio","email":"voceses@gmail.com"},"directories":{},"maintainers":[{"name":"rai-binpar","email":"rai@binpar.com"},{"name":"drnachio","email":"voceses@gmail.com"},{"name":"mgonand","email":"marcos@binpar.com"},{"name":"miguelcdoc","email":"mcastro@binpar.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mermaid-filter_1.4.16_1690128210822_0.7623696261416208"},"_hasShrinkwrap":false},"1.4.17":{"name":"@binpar/mermaid-filter","version":"1.4.17","description":"Pandoc filter for mermaid (including mermaid-v9)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["pandoc","mermaid"],"repository":{"type":"git","url":"https://github.com/marcelmaatkamp/mermaid-filter-tmp-v9"},"author":{"name":"Raghu Rajagopalan"},"license":"BSD-2-Clause","preferGlobal":true,"bin":{"mermaid-filter":"index.js"},"dependencies":{"@mermaid-js/mermaid-cli":"~9","imgur":"^0.3.1","lodash":"^4.17.13","minimist":">=0.2.1","pandoc-filter":"^0.1.3","sanitize-filename":"1.6.1","tmp":"0.0.28","winston":"^3.8.2"},"_id":"@binpar/mermaid-filter@1.4.17","dist":{"shasum":"63e958508b8784e8d53e5c7f103c19df151442bf","integrity":"sha512-tJrsR/R5R1UzPhbzX+iujYcdMMW0NejDs64gFC4+W+vvSdjHUNmk37Y1ZQyGqu7IslKOFI30yQiLq+hspkCJxA==","tarball":"https://registry.npmjs.org/@binpar/mermaid-filter/-/mermaid-filter-1.4.17.tgz","fileCount":4,"unpackedSize":10233,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEUCIBKU7RN20KRqG3Qj5ofyxTQTKNrZ2jEDCIBjioPfLchlAiEA1uPNRp2xlu7W2gCeTvaLH+e9baDaCTkhZXBx4bix30w="}]},"_npmUser":{"name":"drnachio","email":"voceses@gmail.com"},"directories":{},"maintainers":[{"name":"rai-binpar","email":"rai@binpar.com"},{"name":"drnachio","email":"voceses@gmail.com"},{"name":"mgonand","email":"marcos@binpar.com"},{"name":"miguelcdoc","email":"mcastro@binpar.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mermaid-filter_1.4.17_1690129120054_0.23356840769683962"},"_hasShrinkwrap":false},"1.4.18":{"name":"@binpar/mermaid-filter","version":"1.4.18","description":"Pandoc filter for mermaid (including mermaid-v9)","main":"index.js","scripts":{"test":"echo \"Error: no test specified\" && exit 1"},"keywords":["pandoc","mermaid"],"repository":{"type":"git","url":"https://github.com/marcelmaatkamp/mermaid-filter-tmp-v9"},"author":{"name":"Raghu Rajagopalan"},"license":"BSD-2-Clause","preferGlobal":true,"bin":{"mermaid-filter":"index.js"},"dependencies":{"@mermaid-js/mermaid-cli":"~9","imgur":"^0.3.1","lodash":"^4.17.13","minimist":">=0.2.1","pandoc-filter":"^0.1.3","sanitize-filename":"1.6.1","tmp":"0.0.28","winston":"^3.8.2"},"_id":"@binpar/mermaid-filter@1.4.18","dist":{"shasum":"28001025384d5f7c56b882a8ee5babdf55843951","integrity":"sha512-tj+54AJLNmBijdfjhlHe6ybosTZW13nIef3AobI7BsBEEqhNzzPN3WBu8kgV1dgeIWM5JkTBhBNM4/VulqoPRA==","tarball":"https://registry.npmjs.org/@binpar/mermaid-filter/-/mermaid-filter-1.4.18.tgz","fileCount":4,"unpackedSize":10195,"signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQC0oLWRCoL++qlktHzUB4eHFOf6S9Z/03RAZVbHjJl8ZQIhAJkttHVhF0t4vaVrtpNnk8o/G7uXS9tA0Gi8/6W39gq3"}]},"_npmUser":{"name":"drnachio","email":"voceses@gmail.com"},"directories":{},"maintainers":[{"name":"rai-binpar","email":"rai@binpar.com"},{"name":"drnachio","email":"voceses@gmail.com"},{"name":"mgonand","email":"marcos@binpar.com"},{"name":"miguelcdoc","email":"mcastro@binpar.com"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/mermaid-filter_1.4.18_1690129942288_0.6300604245407981"},"_hasShrinkwrap":false}},"time":{"created":"2023-07-23T16:03:30.748Z","1.4.16":"2023-07-23T16:03:30.957Z","modified":"2023-12-20T10:37:18.565Z","1.4.17":"2023-07-23T16:18:40.216Z","1.4.18":"2023-07-23T16:32:22.426Z"},"maintainers":[{"email":"miguel@binpar.com","name":"miguelbinpar"},{"email":"rai@binpar.com","name":"rai-binpar"},{"email":"voceses@gmail.com","name":"drnachio"},{"email":"marcos@binpar.com","name":"mgonand"}],"description":"Pandoc filter for mermaid (including mermaid-v9)","keywords":["pandoc","mermaid"],"repository":{"type":"git","url":"https://github.com/marcelmaatkamp/mermaid-filter-tmp-v9"},"author":{"name":"Raghu Rajagopalan"},"license":"BSD-2-Clause","readme":"Sequence and Graph diagrams in your markdown files!\n=========================\n marcelmaatkamp: \n This is a temporary version untill `raghur/mermaid-filter` publishes a new version which includes mermaid-v9\n-------------------------\n\n`mermaid-filter` is a pandoc filter that adds support for [mermaid](http://knsv.github.io/mermaid/) syntax diagrams in markdown.\n\nWrite your diagrams in fenced code blocks as usual like this:\n\n ~~~mermaid\n sequenceDiagram\n Alice->>John: Hello John, how are you?\n John-->>Alice: Great!\n ~~~\n\n\nand get this in rendered doc \n\nInstallation and usage\n---------------------\n\n1. `npm install --global mermaid-filter`\n2. To convert your markdown file `something.md` into `something.html`, use `pandoc -t html -F mermaid-filter -o something.html something.md`\n\n\n**WINDOWS** - you need `mermaid-filter.cmd` in the line above\n\n**Windows 8.1** - On windows 8.1, `mermaid-filter.cmd` fails - apparently due to change in how the CMD.exe works\nfor subprocesses? - see this [issue thread](https://github.com/jgm/pandoc/issues/3458).\nYou have to edit the globally installed `mermaid-filter.cmd` located in `c:\\users\\\\AppData\\Roaming\\npm`\nto use `~dp$PATH:0`.\nUnfortunately, you will need to do this each time you install/update mermaid-filter since it overwrites the cmd file.\n\nOptions\n--------------------\n\nYou have a couple of formatting options via attributes of the fenced code block to control the rendering\n\n- Pandoc caption, the filename is this value cleaned up - Use `{.mermaid caption=\"Caption Text Here\"}`\n- Image Format - Use `{.mermaid format=svg}` Default is png\n- Width - Use `{.mermaid width=400}` default width is 800\n- Theme - Use `{.mermaid theme=forest}` default is 'default'. Corresponds to `--theme` flag of mermaid.cli\n- Background - Use `{.mermaid background=transparent}` default is 'white'. Correponds to `--backgroundColor` flag of mermaid.cli\n- Filename - Use `{.mermaid filename=\"file with space\"}` to set the filename. This has priority over the caption\n- Save path - Use `{.mermaid loc=img}` default loc=inline which will\n encode the image in a `data uri` scheme.\n - Possible values for `loc`\n - `loc=inline` - default; encode image to data uri on img tag.\n - For widest compatibility, use png (default)\n - SVG has trouble on IE11\n - `loc=imgur` - upload png to imgur and link to it.\n - `loc=` -treat as folder name to place images into\n\nNote that to specify options, you need to use the curly braces syntax and have the `.mermaid` class attached.\nAdmittedly, this is uglier than the earlier syntax on top - but that's how Pandoc wants it.\n\nIt's also possible to override global defaults by using environment variables. The name for these environment variables are the same as the attributes prefixed with a `MERMAID_FILTER_` so that `width` would be `MERMAID_FILTER_WIDTH`.\n\nYou can also specify an ID to be applied to the rendered image. This may be useful to use [`pandoc-crossref`](https://github.com/lierdakil/pandoc-crossref) or similar packages to reference your diagrams, for example:\n\n ```{.mermaid #fig:example}\n // Your diagram code here\n ```\n\n This text has a reference @fig:example which is automatically inserted.\n\n(Note that `pandoc-crossref` will automatically find and use the `caption=` option. Also note that the order of applying the filters matters - you must apply `mermaid-filter` *before* `pandoc-crossref` so that `pandoc-crossref` can find the images.)\n\nJSON and CSS configuration\n---------------------------\n\nMermaid cli allows you to specify additional options in a json configuration file and a css file. `mermaid-filter`\nwill look in the current working directory for `.mermaid-config.json` and `.mermaid.css` and if found, pass them in to\nmermaid cli.\n\nPuppeteer Configuration - `mermaid-filter` will look in the current working directory for a `.puppeteer.json` and pass it\non to mermaid cli (`-p` option of mmdc)if found\n","readmeFilename":"README.md"}