Skip to Content

Draw IO Block

The Draw IO block lets you embed a Draw.io  diagram directly inside a narrative. Architecture diagrams, flowcharts, sequence diagrams, and any other Draw.io content can live alongside your written documentation without leaving ArchRepo.

Draw.io is a free, widely-used diagramming tool. Embedding diagrams this way keeps your visuals version-controlled alongside your written specification.


Inserting a Draw IO Block

  1. In the narrative editor, click where you want the diagram to appear.
  2. Type / to open the slash command menu.
  3. Type draw (or drawing, drawio) and select Draw IO from the list.
  4. An empty Draw IO block is inserted at that position.

Creating or Uploading a Diagram

Once the block is inserted, you have two options:

Create a new diagram Click the New Diagram button inside the block. The Draw.io editor opens in a dialog. Draw your diagram, save it and close the Draw.io editor to add it to the Narrative.

Upload an existing file Click the Upload button to select a .drawio or .xml file from your computer. The diagram is stored in ArchRepo and displayed in the block.


Editing an Existing Diagram

Click the pencil icon next to the diagram to re-open the Draw.io editor. Remember to save your changes.

The diagram is only editable when the narrative itself is in edit mode. In read-only mode, the diagram is displayed but cannot be changed.


Viewing the Diagram

In read-only mode (and when you are not actively editing the block), the diagram is rendered as an image. Readers can see the full diagram inline without needing to open any external tool.


Tips

All diagrams are stored in ArchRepo as separate items. This means you can create a diagram in one narrative and reuse it in another.

Likewise, if you modify the diagram in one narrative, those changes are reflected everywhere it’s used.

Last updated on