Visual Editor
Visual Editor

Author specs visually with a toolbar, components, and live model embeds.

The visual editor is a WYSIWYG environment for MDX. You write and format content directly, insert components from the toolbar, and manage page properties without hand-editing YAML.

What you can do

  • Format text (headings, lists, emphasis, links, tables).
  • Insert components (callouts, tabs, steps, code blocks).
  • Insert model embeds (objects, workflows, artifacts).
  • Edit page properties (frontmatter) via a dialog.

Editing flow

Enter edit mode

Switch the page from view to editor.

Write and format

Use the toolbar for structure and inline formatting.

Insert components

Add callouts, tabs, steps, or model embeds from the insert menu.

Set page properties

Use Edit Page Properties for title, description, icon, and labels.

Save

Persist your changes; the page re-renders in view mode.

Components have real props

When you insert an embed, the editor sets the correct props (for example model_key and workflow_id for a workflow). See the MDX Components reference for what each component expects.

Visual and source together

Best for everyday authoring: prose, formatting, and inserting components without syntax.

Insert model embeds rather than screenshots. Embeds stay current as the model changes, while images go stale.

Last updated on