Readme.md

Testing

Notes on testing Mermaid support in GitHub:

• Supports .md, .mmd and .mermaid files.
• Supports the complete examples.

Notes on testing Mermaid plugins for VSCode:

• Mermaid Markdown Syntax Highlighting
  • Seems to be working fine. Optional, as it just offers syntax highlightning.
  • Seems to be required by other plugins.
• Markdown Preview Mermaid Support
  • Works only with .md files.
  • Supports the complete example.
• Mermaid Editor
  • Works only with .mmd files.
  • Works with simplified example only.
  • Fails generating images with mermaid-editor: Failed to generate image. message.
    • Seems to be an issue only in the preview section.
    • Source section generates a solid .svg.
• Mermaid Preview
  • Works with .md and .mmd files.
  • Works with simplified examples only.
• Preview
  • Works with .md, .mmd and .mermaid files.
  • Works with simplified examples only.

Summary

Using VSCode with Mermaid Markdown Syntax Highlighting and Markdown Preview Mermaid Support is a solid option.

The Markdown Preview Mermaid Support plugin does limit us to .md files, but other plugins do not support .mmd and .mermaid files completely.