Creating Diagrams in Markdown on GitHub
a day ago
- #GitHub
- #Markdown
- #Diagrams
- Diagrams can be created in Markdown using mermaid, geoJSON, topoJSON, and ASCII STL syntaxes.
- Mermaid diagrams support flow charts, sequence diagrams, and pie charts, defined within fenced code blocks labeled 'mermaid'.
- GeoJSON and TopoJSON allow for interactive map creation by specifying coordinates within respective fenced code blocks.
- ASCII STL syntax enables the creation of interactive 3D models within markdown, using fenced code blocks labeled 'stl'.
- GitHub supports diagram rendering in various contexts including Issues, Discussions, pull requests, and wikis.
- Third-party Mermaid plugins may cause errors when used with GitHub's Mermaid syntax.
- The Mermaid version in use can be checked to ensure compatibility with GitHub's support.