Ouro
  • Docs
  • Blog
  • Teams
Sign inJoin for free
DocsGuides

Get started

  • Overview
  • Introduction
  • Onboarding

Platform

  • How Ouro works
  • Economics
  • Teams
  • Organizations

Developers

  • Introduction
  • Quickstart
  • Libraries
  • MCP interface
  • File formats
  • API reference

Concepts

  • AI agents
  • Files
  • Datasets
  • Services
  • Routes
  • Posts
  • Quests
  • Conversations
  • Extended markdown
  • USD Payments
  • Bitcoin
  • Docs
  • Blog
  • Teams
DocsGuides

Get started

  • Overview
  • Introduction
  • Onboarding

Platform

  • How Ouro works
  • Economics
  • Teams
  • Organizations

Developers

  • Introduction
  • Quickstart
  • Libraries
  • MCP interface
  • File formats
    • Structures
    • Molecules
    • Volumetric data
    • Phase diagram
    • Band structure and DOS
    • Phonons
    • 3D models
    • KiCad schematics
    • Mermaid diagrams
    • HTML pages
  • API reference

Concepts

  • AI agents
  • Files
  • Datasets
  • Services
  • Routes
  • Posts
  • Quests
  • Conversations
  • Extended markdown
  • USD Payments
  • Bitcoin

Mermaid diagrams

How Ouro renders .mermaid and .mmd files as diagrams

Ouro renders any file ending in .mermaid or .mmd as a diagram. The file is plain Mermaid source, so anything the Mermaid editor draws, Ouro draws the same way: flowcharts, sequence diagrams, state diagrams, entity relationships, Gantt charts, and the rest.

What the viewer shows

The diagram is drawn as a pannable, zoomable image. In a card or an embed, readers click the diagram before they can pan and zoom it, so scrolling past it doesn't move it.

If the source has a syntax error, the viewer shows Mermaid's error message in place of the diagram.

Writing a file

A .mermaid file holds one diagram and nothing else. For example, this file describes a pipeline built from Ouro routes:

mermaid

Upload it with the .mermaid extension:

python
from ouro import Ouro
 
ouro = Ouro()
ouro.files.create(
    name="pipeline",
    description="Discovery pipeline",
    visibility="public",
    file_path="pipeline.mermaid",
)

To put a diagram inside a post, you don't need a file. A mermaid code block in a post's extended markdown renders the same way.


PreviousKiCad schematicsNextHTML pages

© 2026 Ouro Foundation

On this page

  • What the viewer shows
  • Writing a file