Diagrams and charts

You can add diagrams and charts to your documentation in Swimm, using Mermaid Syntax in the editor.

To get started, type /Diagram to start editing your Mermaid diagram.

Mermaid + Swimm = up-to-date diagrams 🤯

You can now create and edit Mermaid diagrams straight from Swimm’s editor:

The real value comes when creating diagrams with Swimm’s Smart Tokens. Type a backtick (`) within your diagram labels to code-couple constants or variables and you won't need to worry about the impact of refactoring on your documentation, as well as renaming those values referenced in your diagram. This means - diagrams that are up to date with your code 🤯

Learn more

To find out more about Swimm's integration with Mermaid, and different use cases for diagrams in code documentation, see our blog post.

---

This document is automatically kept up to date using Swimm.