{"id":16318759,"url":"https://github.com/dpvreony/docfx-mermaidjs","last_synced_at":"2026-03-17T19:43:11.448Z","repository":{"id":65630640,"uuid":"580099134","full_name":"dpvreony/docfx-mermaidjs","owner":"dpvreony","description":"DocFX MermaidJs Image Generator Plugin","archived":false,"fork":false,"pushed_at":"2026-03-12T23:19:12.000Z","size":853,"stargazers_count":8,"open_issues_count":5,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2026-03-13T05:00:04.450Z","etag":null,"topics":["docfx","docfx-plugin","mermaid","mermaidjs"],"latest_commit_sha":null,"homepage":"https://docs.dpvreony.com/projects/docfx-mermaidjs/","language":"C#","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/dpvreony.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":"citation.cff","codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null,"notice":null,"maintainers":null,"copyright":null,"agents":null,"dco":null,"cla":null}},"created_at":"2022-12-19T18:04:48.000Z","updated_at":"2026-03-12T23:18:52.000Z","dependencies_parsed_at":"2025-11-27T20:08:05.134Z","dependency_job_id":null,"html_url":"https://github.com/dpvreony/docfx-mermaidjs","commit_stats":null,"previous_names":[],"tags_count":30,"template":false,"template_full_name":"dpvreony/net-repo-template","purl":"pkg:github/dpvreony/docfx-mermaidjs","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dpvreony%2Fdocfx-mermaidjs","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dpvreony%2Fdocfx-mermaidjs/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dpvreony%2Fdocfx-mermaidjs/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dpvreony%2Fdocfx-mermaidjs/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/dpvreony","download_url":"https://codeload.github.com/dpvreony/docfx-mermaidjs/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/dpvreony%2Fdocfx-mermaidjs/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":30629862,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-03-17T17:32:55.572Z","status":"ssl_error","status_checked_at":"2026-03-17T17:32:38.732Z","response_time":56,"last_error":"SSL_read: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"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":["docfx","docfx-plugin","mermaid","mermaidjs"],"created_at":"2024-10-10T22:24:31.149Z","updated_at":"2026-03-17T19:43:11.399Z","avatar_url":"https://github.com/dpvreony.png","language":"C#","funding_links":[],"categories":[],"sub_categories":[],"readme":"# DocFx MermaidJS\n\n## Mission Statement\n\nTo provide a plugin to convert MermaidJS notations to diagrams during the build of a DocFX project.\n\n## Introduction\n\nThis DocFX MermaidJS plugin is a wrapper around the mermaid NPM package. It is aimed at doing build time generation of the mermaid diagram so:\n\n* The syntax can be validated at build time.\n* The image is only built once.\n* The image can be embedded in a pdf.\n\n## Credits\n\n* https://dotnet.github.io/docfx/\n* https://mermaid.js.org/\n* https://github.com/mermaid-js/mermaid-cli\n* https://github.com/mermaid-js/mermaid\n* https://github.com/dpvreony/article-statiq-mermaid\n* https://github.com/KevReed/DocFx.Plugins.PlantUml\n\n## Getting Started\n\n### 1. Create a console application (or similar)\n### 2. Add a nuget package reference to \"Dhgms.DocFX.Mermaid.Plugin\" in your docfx_project\n### 3. Add the following initialisation\n\n```cs\n                var options = new BuildOptions\n                {\n                    // Enable MermaidJS markdown extension\n                    ConfigureMarkdig = pipeline =\u003e pipeline.UseMermaidJsExtension(new MarkdownContext())\n                };\n                await Docset.Build(\"docfx.json\", options);\n```\n\nYou can see an example of this in\n\n1. [The sample console application in this repository (github.com/dpvreony/docfx-mermaidjs/tree/main/src/Dhgms.DocFx.MermaidJs.Sample.Cmd)](https://github.com/dpvreony/docfx-mermaidjs/tree/main/src/Dhgms.DocFx.MermaidJs.Sample.Cmd)\n2. [The console application in my main documentation repository (github.com/dpvreony/documentation/tree/main/src/docfx_project)](https://github.com/dpvreony/documentation/tree/main/src/docfx_project)\n\nNOTES:\n* Only inline PNG is supported, this is due to a limitation in the plug in model and adding new files to the file cache on the fly. I may revisit this in future. The plug in itself exposes SVG data if you want to play with it.\n\nYou can adjust the settings by viewing the detailed documentation.\n\n### 4. Adding a diagram\n\nIn your markdown files add a code block with a mermaid descriptor like so:\n\n````\n```mermaid\ngraph TD;\n    A--\u003eB;\n    A--\u003eC;\n    B--\u003eD;\n    C--\u003eD;\n```\n````\n\nThen you can run the build and you should see the image output in place of the mermaid markdown syntax.\n\n```mermaid\ngraph TD;\n    A--\u003eB;\n    A--\u003eC;\n    B--\u003eD;\n    C--\u003eD;\n```\n\n\n## Viewing the documentation\n\nThe documentation can be found at https://docs.dpvreony.com/projects/docfx-mermaidjs/\n\n## Contributing to the code\n\nSee the [contribution guidelines](CONTRIBUTING.md).\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdpvreony%2Fdocfx-mermaidjs","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fdpvreony%2Fdocfx-mermaidjs","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fdpvreony%2Fdocfx-mermaidjs/lists"}