{"id":22234341,"url":"https://github.com/furqansoftware/goldmark-d2","last_synced_at":"2025-07-27T21:32:15.237Z","repository":{"id":65071832,"uuid":"581408068","full_name":"FurqanSoftware/goldmark-d2","owner":"FurqanSoftware","description":"Goldmark extension for D2 diagrams","archived":false,"fork":false,"pushed_at":"2024-02-22T04:25:55.000Z","size":556,"stargazers_count":16,"open_issues_count":1,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-06-19T02:10:55.651Z","etag":null,"topics":["d2","goldmark","goldmark-extension"],"latest_commit_sha":null,"homepage":"","language":"Go","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/FurqanSoftware.png","metadata":{"files":{"readme":"README.md","changelog":null,"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}},"created_at":"2022-12-23T05:12:02.000Z","updated_at":"2024-06-19T02:10:55.652Z","dependencies_parsed_at":"2024-02-22T05:28:27.283Z","dependency_job_id":"d72e3827-ba82-4b8c-ad5c-0876ec933a73","html_url":"https://github.com/FurqanSoftware/goldmark-d2","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fgoldmark-d2","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fgoldmark-d2/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fgoldmark-d2/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/FurqanSoftware%2Fgoldmark-d2/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/FurqanSoftware","download_url":"https://codeload.github.com/FurqanSoftware/goldmark-d2/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":227837049,"owners_count":17827066,"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":["d2","goldmark","goldmark-extension"],"created_at":"2024-12-03T02:08:09.917Z","updated_at":"2024-12-03T02:08:10.512Z","avatar_url":"https://github.com/FurqanSoftware.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Goldmark D2\n\n[![Go Reference](https://pkg.go.dev/badge/github.com/FurqanSoftware/goldmark-d2.svg)](https://pkg.go.dev/github.com/FurqanSoftware/goldmark-d2)\n\nGoldmark D2 is a [Goldmark](https://github.com/yuin/goldmark) extension providing diagram support through [D2](https://d2lang.com/).\n\n## Usage\n\n``` go\ngoldmark.New(\n\tgoldmark.WithExtensions(\u0026Extender{\n\t\t// Defaults when omitted\n\t\tLayout:  d2dagrelayout.Layout,\n\t\tThemeID: d2themescatalog.CoolClassics.ID,\n\t}),\n).Convert(src, dst)\n```\n\n## Example\n\n\u003ctable\u003e\n\u003ctr\u003e\n\u003ctd\u003e\n\n~~~markdown\nThe following diagram shows the important link between the letters X and Y:\n\n```d2\nx -\u003e y\n```\n~~~\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n![](testdata/basic.png)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\n\u003ctr\u003e\n\u003ctd\u003e\n\n{Sketch: true}\n\n~~~markdown\n```d2\ndogs -\u003e cats -\u003e mice: chase\nreplica 1 \u003c-\u003e replica 2\na -\u003e b: To err is human, to moo bovine {\n  source-arrowhead: 1\n  target-arrowhead: * {\n    shape: diamond\n  }\n}\n```\n~~~\n\n\u003c/td\u003e\n\u003ctd\u003e\n\n![](testdata/connections.png)\n\n\u003c/td\u003e\n\u003c/tr\u003e\n\u003c/table\u003e\n\n## To-dos\n\n- [x] Option for hand-drawn rendering\n\n## More Goldmark Extensions\n\n- [Katex](https://github.com/FurqanSoftware/goldmark-katex): math and equation support through [KaTeX](https://katex.org/)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffurqansoftware%2Fgoldmark-d2","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffurqansoftware%2Fgoldmark-d2","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffurqansoftware%2Fgoldmark-d2/lists"}