{"id":25161115,"url":"https://github.com/landmaj/mkdocs-d2-plugin","last_synced_at":"2025-04-08T03:18:29.544Z","repository":{"id":196207809,"uuid":"695316386","full_name":"landmaj/mkdocs-d2-plugin","owner":"landmaj","description":"A plugin for embedding D2 diagrams in MkDocs.","archived":false,"fork":false,"pushed_at":"2025-03-01T14:32:47.000Z","size":244,"stargazers_count":28,"open_issues_count":1,"forks_count":6,"subscribers_count":1,"default_branch":"master","last_synced_at":"2025-04-04T08:47:42.789Z","etag":null,"topics":["diagrams","mkdocs","mkdocs-plugin","text-to-diagram"],"latest_commit_sha":null,"homepage":"https://landmaj.github.io/mkdocs-d2-plugin/","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/landmaj.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","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}},"created_at":"2023-09-22T20:56:00.000Z","updated_at":"2025-04-03T23:55:26.000Z","dependencies_parsed_at":"2024-04-24T13:40:37.143Z","dependency_job_id":"5177a619-5363-41ea-b394-cac0cf666901","html_url":"https://github.com/landmaj/mkdocs-d2-plugin","commit_stats":null,"previous_names":["landmaj/mkdocs-d2-plugin"],"tags_count":5,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landmaj%2Fmkdocs-d2-plugin","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landmaj%2Fmkdocs-d2-plugin/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landmaj%2Fmkdocs-d2-plugin/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/landmaj%2Fmkdocs-d2-plugin/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/landmaj","download_url":"https://codeload.github.com/landmaj/mkdocs-d2-plugin/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247767239,"owners_count":20992548,"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":["diagrams","mkdocs","mkdocs-plugin","text-to-diagram"],"created_at":"2025-02-09T02:18:02.673Z","updated_at":"2025-04-08T03:18:29.517Z","avatar_url":"https://github.com/landmaj.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"# mkdocs-d2-plugin\n\nA plugin for embedding D2 diagrams in MkDocs.\n\n**Documentation and live demo can be found\n[here](https://landmaj.github.io/mkdocs-d2-plugin/).**\n\n## Requirements\n\n* [Python](https://www.python.org/) \u003e= 3.9\n* [MkDocs](https://www.mkdocs.org/) \u003e= 1.6.0\n* [D2](https://d2lang.com) \u003e= 0.6.3\n\n## Installation\n\nInstall the plugin using pip:\n\n```bash\npip install mkdocs-d2-plugin\n```\n\nAnd add it to your `mkdocs.yml`:\n\n```yaml\nplugins:\n  - d2\n```\n\n## Usage\n\n### Fenced code block\n\n````md\n```d2\nshape: sequence_diagram\nAlice -\u003e John: Hello John, how are you?\nAlice -\u003e John.ack: John, can you hear me?\nJohn.ack -\u003e Alice: Hi Alice, I can hear you!\nJohn -\u003e Alice: I feel great!\n```\n````\n\n### Image tag\n\n```md\n![Diagram](diagram.d2)\n```\n\n## Demo app\n\nYou can find demo app in the `docs` directory.\nLive version is available [here](https://landmaj.github.io/mkdocs-d2-plugin/).\n\nTo run in locally:\n\n```bash\ncd docs\npython3 -m venv .venv\nsource .venv/bin/activate\npip install mkdocs-material mkdocs-d2-plugin\nmkdocs serve\n```\n\nTo run it using Docker:\n\n```bash\ncd docs\ndocker build --tag mkdocs-d2-plugin:latest .\ndocker run --rm -it -p 8000:8000 -v ${PWD}:/docs mkdocs-d2-plugin:latest\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flandmaj%2Fmkdocs-d2-plugin","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Flandmaj%2Fmkdocs-d2-plugin","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Flandmaj%2Fmkdocs-d2-plugin/lists"}