Skip to content

Editing and Help

Vivek Sarin edited this page Nov 18, 2026 · 4 revisions

Editing and help

FlowMotion uses CodeMirror by default. It includes YAML syntax highlighting, line numbers, and a live preview. Press Shift+Alt+F to format the diagram.

On desktop, enable Rich Code Editor (Monaco) for syntax checks, suggestions, and navigation. See Settings for installation steps.

Open the editor

Use any of these methods:

  • Hover over a diagram and select ✎ Edit.
  • Open a .flow file. It opens in the editor.
  • Right-click a note and select Add FlowMotion diagram. Then choose Inline diagram or Diagram file (.flow).

Monaco features

These features require Rich Code Editor (Monaco). Both editors support formatting and live preview.

  • Live checks: Errors and warnings appear as you type. Each error shows the line where it occurs.
  • Suggestions: Press Ctrl+Space to see keywords, shapes, and settings.
  • Hover help: Hover over a keyword to read what it does.
  • Quick fixes: Some errors offer a fix, such as Change to "…". Select the fix to apply it.
  • Go to definition: Press F12 to jump to where a node is defined.
  • Rename: Press F2 to rename a node or label throughout the diagram.
  • Next problem: Press F8 to move to the next error.

Format a diagram in a note

In a note's source view, a flowmotion block gets error marks, hover help, and suggestions. You can also format the block.

This note-source support does not depend on Monaco.

  • Run the command Format FlowMotion diagram block.
  • If the block has errors, or it is already formatted, FlowMotion shows the message: nothing to format.

The .flow file view

A .flow file opens with the editor on the left and the preview on the right. The toolbar has two buttons:

  • Format (align-left icon): tidies the text.
  • Toggle preview (eye icon): shows or hides the preview.

A .drawio.flow file opens in the draw.io editor instead. See draw.io drawings.

The edit window

The ✎ Edit button opens the same editor in a window. The window has three buttons:

  • Format: tidies the text.
  • Save: saves your changes to the diagram.
  • Close or Discard: closes the window. The button reads Discard when you have unsaved changes, so select it only if you want to lose them.

The file dialog

Use the Add FlowMotion diagram menu, then Diagram file (.flow), to open the file dialog. The dialog has two tabs:

  • Use existing: shows the diagram files already in your vault. The tab appears only when the vault has at least one diagram file.
  • Create new: creates a new file. Type a name in File name, and choose a folder in Save in.

A file name cannot contain these characters: \ / : * ? " < > | # ^ [ ].

Commands

Open the command palette and search for "FlowMotion". The main commands are:

Command What it does
New FlowMotion diagram (.flow file) Creates a diagram file
New draw.io diagram (.drawio.flow file) Creates a draw.io drawing
Insert FlowMotion diagram (inline) Adds a diagram to the current note
Insert FlowMotion diagram (.flow file) Shows a diagram from a .flow file in the current note
Format FlowMotion diagram block Formats the diagram block at the cursor
Format diagram Formats the open .flow file

Right-click menus

  • In a note: Add FlowMotion diagram.
  • On a folder: New FlowMotion diagram, or New draw.io diagram.
  • On a .yaml, .yml, or .json file: Convert to FlowMotion diagram (.flow).

Error messages

When a diagram has errors, FlowMotion shows FlowMotion: invalid diagram and lists the problems. Each problem shows the line number. Fix the lines, and the diagram redraws.

For more help, see Troubleshooting and FAQ.

Clone this wiki locally