Editor overview

The Doxbrix editor is where you write and structure documentation. It pairs a content tree, a writing canvas, and live quality insights so you can draft, organize, and improve a page in one place — with AI and collaboration built in.

The editor layout

When you open a project, the editor has these regions:

Collaborators currently in the page appear as avatars in the top bar, with live cursors on the canvas.

Two editing modes

A project uses one of two editing surfaces, set in Settings → Project → Editor Configuration under Editor mode:

Block editor (default)

A structured canvas where content is a sequence of blocks (paragraphs, headings, callouts, code, steps, and more). You insert blocks from the slash palette and rearrange them freely. This mode gives you the full Doxbrix block palette.

WYSIWYG editor

A document-style surface that feels closer to a word processor. Select text to get a floating formatting toolbar, and use the same block menu for richer components. Choose it when your team prefers continuous-document editing over a block canvas.

Both modes write the same underlying content, so pages remain portable between them and to docs-as-code.

The slash palette

In the block editor, press <kbd>/</kbd> on a new line to open the block palette. Start typing to filter (for example /steps or /info), then press <kbd>Enter</kbd> to insert. The palette is grouped into these sections:

• AI — AI: Continue writing, AI: Generate table, AI: Generate diagram.
• Writing — Text, Heading 1–6, Table, Divider, Import MDX, Import Document.
• Callouts — Info, Note, Tip, Check, Warning, Danger.
• Lists — Unordered list, Ordered list, Task list.
• Code — Code block, Code group, Terminal.
• Media — Image, Video embed, iframe embed, File download.
• Layout — 2 / 3 / 4 Columns.
• Visual — Badge, Icon, Frame.
• Interactive — Tabs, Accordion, Expandable, Steps, Card, Card group.
• Changelog — Update.
• API Reference — API Endpoint, Parameter Table, Response Example.
• Diagrams — Flowchart, Sequence, ER, Gantt, Class, Pie, State, blank Mermaid, Math, Excalidraw.

See Blocks & components for each block's syntax.

The formatting toolbar

Select text to bring up the inline formatting toolbar:

Markdown shortcuts

You can type Markdown directly and it converts as you go: **bold**, *italic*, ` inline code , links, # … ###### headings, - and 1. lists, > blockquotes, ---` dividers, and fenced code blocks.

Keyboard shortcuts

AI while you write

• Writing Copilot — from the / menu, have AI continue writing at the cursor, generate a table from nearby content, or turn a description into a diagram. See Writing Copilot.
• Improve with AI — the page-header button rewrites the page to fix the issues your quality scan flagged, overall or focused on one area (Readability, Structure, SEO, Accessibility, Completeness). See Improve with AI.
• Document insights — the side panel shows the live quality score and prioritized suggestions.

Review and collaboration

The editor is multiplayer and review-aware:

• Comments — discuss a block without changing it. See Comments.
• Suggestions — propose edits that an owner accepts or rejects. See Suggestions & presence.
• Preview & publish — preview the page as readers see it, then publish or submit for review from the top bar.

Autosave

The editor saves continuously as you work. The top-bar badge moves from Autosaving… to Autosaved (and shows Saved after a manual <kbd>⌘ S</kbd>). Changes are kept as a draft until you publish.

Next steps