Skip to content

Troubleshooting for Authors

Mermaid Diagram Syntax Errors

If your Mermaid diagram doesn't render and you see a "Syntax error" message at the bottom of the page, the diagram syntax is invalid.

Solution: Test your diagram in GitHub's markdown preview first. Create a PR or edit the file directly on GitHub's web interface and use the preview feature. This gives you immediate feedback without waiting for the docs site to rebuild. Once the diagram renders correctly in GitHub's preview, it will work on the docs site.