{"id":20835955,"url":"https://github.com/keyweeusr/mermaid-docker-mode","last_synced_at":"2025-05-08T02:38:00.365Z","repository":{"id":261990651,"uuid":"695896705","full_name":"KeyWeeUsr/mermaid-docker-mode","owner":"KeyWeeUsr","description":"Dockerized mermaid for mermaid-mode","archived":false,"fork":false,"pushed_at":"2025-04-24T17:31:48.000Z","size":179,"stargazers_count":4,"open_issues_count":0,"forks_count":2,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-04-24T18:34:59.432Z","etag":null,"topics":["diagram","docker","elisp","emacs","graph","melpa","melpa-badge","mermaid","mmd","org","org-mode","package","plot"],"latest_commit_sha":null,"homepage":"","language":"Emacs Lisp","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/KeyWeeUsr.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":"KeyWeeUsr","buy_me_a_coffee":"peterbadida","liberapay":"keyweeusr","custom":["https://paypal.me/peterbadida"]}},"created_at":"2023-09-24T15:03:26.000Z","updated_at":"2025-04-24T17:31:39.000Z","dependencies_parsed_at":"2024-11-09T19:24:44.752Z","dependency_job_id":"d6c39cad-d70a-4927-910c-319fedb60e4a","html_url":"https://github.com/KeyWeeUsr/mermaid-docker-mode","commit_stats":null,"previous_names":["keyweeusr/mermaid-docker-mode"],"tags_count":10,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2Fmermaid-docker-mode","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2Fmermaid-docker-mode/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2Fmermaid-docker-mode/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/KeyWeeUsr%2Fmermaid-docker-mode/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/KeyWeeUsr","download_url":"https://codeload.github.com/KeyWeeUsr/mermaid-docker-mode/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":252987993,"owners_count":21836437,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["diagram","docker","elisp","emacs","graph","melpa","melpa-badge","mermaid","mmd","org","org-mode","package","plot"],"created_at":"2024-11-18T00:28:06.148Z","updated_at":"2025-05-08T02:38:00.356Z","avatar_url":"https://github.com/KeyWeeUsr.png","language":"Emacs Lisp","funding_links":["https://github.com/sponsors/KeyWeeUsr","https://buymeacoffee.com/peterbadida","https://liberapay.com/keyweeusr","https://paypal.me/peterbadida","https://www.buymeacoffee.com/peterbadida"],"categories":[],"sub_categories":[],"readme":"# mermaid-docker-mode\n[![MELPA][melpa-badge]][melpa-package]\n[![MELPA Stable][melpa-stable-badge]][melpa-stable-package]\n[![CI][ci-badge]][ci-workflow]\n[![Coverage Status][cover-badge]][cover-link]\n[![Buy me a coffee][bmc-badge]][bmc-link]\n[![Liberapay][lp-badge]][lp-link]\n[![PayPal][ppl-badge]][ppl-link]\n\nRender mermaid graphs with Docker service\n\nThis library attempts to create Mermaid graphs via the official\n[`mermaid-cli`](https://github.com/mermaid-js/mermaid-cli) using the official\nDocker image and restricting network access, so that you are sure nothing gets\nout and your system is kept isolated from random Node.js deps/files noise all\naround the filesystem.\n\n## How to\n\nInstall it from [Melpa](https://melpa.org/#/getting-started) or clone and\ninstall manually, then:\n\n1. Have [`mermaid-mode`](https://melpa.org/#/mermaid-mode) installed and\n   _activated_.\n2. Run the install function `M-x mermaid-docker-install`\n3. Activate this mode with `M-x mermaid-docker-mode`\n4. After successful installation `C-c C-c` for `mermaid-mode` is patched and\n   renders the graphs via Docker container\n\n## Customization\n\nName                                |Type     |Default               |Description                                                  |\n------------------------------------|---------|----------------------|-------------------------------------------------------------|\n`mermaid-docker-verbose`            |`boolean`|`t`                   |Emit messages when something's happening in the background.  |\n`mermaid-docker-always-check-deps`  |`boolean`|`t`                   |Always look up binaries, libraries and other required tools. |\n`mermaid-docker-image-name`         |`string` |`\"minlag/mermaid-cli\"`|Official mermaid-cli image.                                  |\n`mermaid-docker-image-tag`          |`string` |`\"11.4.3-beta.30\"`    |Tag for official mermaid-cli image.                          |\n`mermaid-docker-output-format`      |`string` |`\"png\"`               |Output format for rendered diagram.                          |\n`mermaid-docker-output`             |`string` |`\"\"`                  |Default file output ('' / empty string).                     |\n`mermaid-docker-external-viewer-bin`|`string` |`\"/usr/bin/xviewer\"`  |Path to external image viewer.                               |\n`mermaid-docker-focus-steal-fix`    |`boolean`|`t`                   |Should attempt to fix focus stealing?                        |\n`mermaid-docker-focus-steal-ms`     |`number` |`200`                 |Milliseconds to wait before stealing focus back.             |\n`mermaid-docker-external`           |`boolean`|`nil`                 |Use external viewer to display rendered mermaid graph.       |\n`mermaid-docker-stay-in-window`     |`boolean`|`nil`                 |Stay in window with the diagram after rendering.             |\n`mermaid-docker-bin`                |`string` |`\"docker\"`            |Docker or Docker-compatible binary on PATH or absolute value.|\n\n[melpa-badge]: http://melpa.org/packages/mermaid-docker-mode-badge.svg\n[melpa-package]: http://melpa.org/#/mermaid-docker-mode\n[melpa-stable-badge]: http://stable.melpa.org/packages/mermaid-docker-mode-badge.svg\n[melpa-stable-package]: http://stable.melpa.org/#/mermaid-docker-mode\n[bmc-badge]: https://img.shields.io/badge/-buy_me_a%C2%A0coffee-gray?logo=buy-me-a-coffee\n[bmc-link]: https://www.buymeacoffee.com/peterbadida\n[ppl-badge]: https://img.shields.io/badge/-paypal-grey?logo=paypal\n[ppl-link]: https://paypal.me/peterbadida\n[lp-badge]: https://img.shields.io/badge/-liberapay-grey?logo=liberapay\n[lp-link]: https://liberapay.com/keyweeusr\n[ci-badge]: https://github.com/KeyWeeUsr/mermaid-docker-mode/actions/workflows/test.yml/badge.svg\n[ci-workflow]: https://github.com/KeyWeeUsr/mermaid-docker-mode/actions/workflows/test.yml\n[cover-badge]: https://coveralls.io/repos/github/KeyWeeUsr/mermaid-docker-mode/badge.svg?branch=master\n[cover-link]: https://coveralls.io/github/KeyWeeUsr/mermaid-docker-mode?branch=master\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyweeusr%2Fmermaid-docker-mode","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkeyweeusr%2Fmermaid-docker-mode","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkeyweeusr%2Fmermaid-docker-mode/lists"}