{"repo":"abhinav/goldmark-mermaid","free":true,"listed":false,"github":"https://github.com/abhinav/goldmark-mermaid","clone":"git clone https://github.com/abhinav/goldmark-mermaid.git","description":"Mermaid diagram support for Goldmark Markdown parser.","language":"Go","stars":62,"topics":["golang","markdown","mermaidjs"],"license":"BSD-3-Clause","category":"cli-tools","readme_excerpt":"goldmark-mermaid - Introduction - Installation - Usage - Rendering - Rendering modes - Server-side rendering - License Introduction goldmark-mermaid is an extension for the goldmark Markdown parser that adds support for Mermaid diagrams. Demo : A web-based demonstration of the extension is available at https://abhinav.github.io/goldmark-mermaid/demo/. Features - Pluggable components - Supports client-side rendering by injecting JavaScript - Supports server-side rendering with the MermaidJS CLI or with your browser Installation Install the latest version of the library with Go modules. Usage To use goldmark-mermaid, import the mermaid package. Then include the mermaid.Extender in the list of extensions you build your goldmark.Markdown with. The package supports Mermaid diagrams inside fenced code blocks with the language mermaid . For example, When you render the Markdown as HTML, these will be rendered into diagrams. You can also render diagrams server-side if you have a Chromium-like browser installed. See Rendering with CDP for details. Rendering Rendering methods goldmark-mermaid supports two rendering modes: - Client-side : Diagrams are rendered in-browser by injecting MermaidJS into the generated HTML. - Server-side : Diagrams are rendered at the time the HTML is generated. The browser receives only the final SVGs. You can pick between these by setting the RenderMode field. A third automatic mode is provided as a convenience. It automatically picks between client-side an","default_branch":null,"files":null,"tree":[],"storefront":"/r/abhinav","claimed":false,"request_supported":{"post":"https://gitbuyer.com/r/abhinav/goldmark-mermaid/request-supported","requests":0},"note":"indexed from public GitHub; nothing is for sale on this page. Clone it from GitHub. Paid listings live at /search."}