Skip to main content

Editor

Docmost features a block-based rich text editor built on top of TipTap. The editor supports a wide range of content types, formatting options, and embeds to help you create rich documentation.

Slash Commands

Type / on a new line to open the slash command menu. You can also type to filter commands by name. The following commands are available:

Basic

CommandDescription
TextPlain paragraph text
To-do listTrack tasks with a to-do list with checkboxes
Heading 1Large section heading
Heading 2Medium section heading
Heading 3Small section heading
Bullet listCreate an unordered bullet list
Numbered listCreate an ordered numbered list
QuoteCreate a block quote
CodeInsert a code block with syntax highlighting
DividerInsert a horizontal rule divider

Media

CommandDescription
ImageUpload an image from your device
VideoUpload a video from your device
File attachmentUpload any file from your device

Structure

CommandDescription
TableInsert a table
Toggle blockInsert a collapsible block
CalloutInsert a callout notice block

Advanced

CommandDescription
Math inlineInsert an inline math equation (KaTeX)
Math blockInsert a block-level math equation (KaTeX)
Mermaid diagramInsert a Mermaid diagram (flowcharts, sequence diagrams, etc.)
Draw.ioOpen the Draw.io diagram editor
ExcalidrawOpen the Excalidraw whiteboard editor
DateInsert a date with a calendar picker
SubpagesList all child pages of the current page
Insert LinkLink to pages or external URLs
Mention memberMention a workspace member

Embeds

CommandDescription
Iframe embedEmbed content via an iframe URL
AirtableEmbed an Airtable base
LoomEmbed a Loom video
FigmaEmbed Figma files
TypeformEmbed a Typeform
MiroEmbed a Miro board
YouTubeEmbed a YouTube video
VimeoEmbed a Vimeo video
FramerEmbed a Framer prototype
Google DriveEmbed Google Drive content
Google SheetsEmbed Google Sheets
Google DocsEmbed Google Docs

Formatting Toolbar

Select text to reveal the floating formatting toolbar. The toolbar provides quick access to:

  • Ask AI - Use the AI assistant to help with writing
  • Block type - Convert the block to a different type (Text, Heading 1-3, To-do List, Bullet List, Numbered List, Blockquote, Code, Callout, Toggle block)
  • Alignment - Align text left, center, right, or justify
  • Bold (Ctrl/Cmd + B)
  • Italic (Ctrl/Cmd + I)
  • Underline (Ctrl/Cmd + U)
  • Strikethrough
  • Inline code (Ctrl/Cmd + E)
  • Link - Insert or edit a hyperlink
  • Text color - Choose from a palette of text colors
  • Highlight color - Choose from a palette of background highlight colors
  • Comment - Add an inline comment on the selected text

@ Mentions

Type @ in the editor to open the mention menu. The menu shows two sections:

  • Users - Mention workspace members by name. Mentioned users may receive notifications.
  • Pages - Link to existing pages in your workspace. Type to search for a specific page.

Emoji

Type : followed by a keyword to search and insert emoji. For example, :smile shows matching emoji suggestions.

Diagrams

The editor supports three diagram tools that you can insert via the / slash command menu:

  • Mermaid - Write text-based diagrams using Mermaid syntax (flowcharts, sequence diagrams, Gantt charts, and more).
  • Draw.io (diagrams.net) - Create visual diagrams with a full-featured drag-and-drop editor.
  • Excalidraw - Create hand-drawn style whiteboard diagrams.

For more details, see the Diagrams page.

Tables

To insert a table, type / and select Table. A 3×3 table is inserted with a header row enabled by default.

Table Toolbar

Click inside a table cell to reveal the table toolbar above the table. The toolbar provides the following actions:

ActionDescription
Add left columnInsert a new column to the left of the current cell
Add right columnInsert a new column to the right of the current cell
Delete columnRemove the current column
Add row aboveInsert a new row above the current cell
Add row belowInsert a new row below the current cell
Delete rowRemove the current row
Toggle header rowEnable or disable the header style on the first row
Toggle header columnEnable or disable the header style on the first column
Delete tableRemove the entire table

Table Features

  • Resize columns — Drag the column borders to adjust column widths.
  • Reorder rows and columns — Drag rows or columns to rearrange them.
  • Merge cells — Select multiple cells and merge them into one.
  • Split cells — Split a previously merged cell back into individual cells.
  • Cell alignment — Align cell content left, center, or right.
  • Cell background color — Set a background color on individual cells.

Use Tab to move to the next cell and Shift + Tab to move to the previous cell.

Drag and Drop

Hover over any block to reveal a drag handle on the left. Click and drag the handle to reorder blocks within the page.

Keyboard Shortcuts

Essentials

CommandShortcut
CopyCtrl/Cmd + C
CutCtrl/Cmd + X
PasteCtrl/Cmd + V
Paste without formattingCtrl/Cmd + Shift + V
UndoCtrl/Cmd + Z
RedoCtrl/Cmd + Shift + Z
Add a line breakShift + Enter
Find and replaceCtrl/Cmd + F

Text Formatting

CommandShortcut
BoldCtrl/Cmd + B
ItalicCtrl/Cmd + I
UnderlineCtrl/Cmd + U
StrikethroughCtrl/Cmd + Shift + S
HighlightCtrl/Cmd + Shift + H
Inline codeCtrl/Cmd + E
SubscriptCtrl/Cmd + ,
SuperscriptCtrl/Cmd + .

Paragraph Formatting

CommandShortcut
Normal textCtrl/Cmd + Alt + 0
Heading 1Ctrl/Cmd + Alt + 1
Heading 2Ctrl/Cmd + Alt + 2
Heading 3Ctrl/Cmd + Alt + 3
Heading 4Ctrl/Cmd + Alt + 4
Heading 5Ctrl/Cmd + Alt + 5
Heading 6Ctrl/Cmd + Alt + 6
Ordered listCtrl/Cmd + Shift + 7
Bullet listCtrl/Cmd + Shift + 8
Task listCtrl/Cmd + Shift + 9
BlockquoteCtrl/Cmd + Shift + B
Code blockCtrl/Cmd + Alt + C
Left alignCtrl/Cmd + Shift + L
Center alignCtrl/Cmd + Shift + E
Right alignCtrl/Cmd + Shift + R
JustifyCtrl/Cmd + Shift + J

Text Selection

CommandShortcut
Select allCtrl/Cmd + A
Extend selection one character to leftShift + ←
Extend selection one character to rightShift + →
Extend selection one line upShift + ↑
Extend selection one line downShift + ↓
CommandShortcut
Indent list item / next table cellTab
Outdent list item / previous table cellShift + Tab
Open slash command menu/
Open mention menu@
Open emoji picker:

Markdown Shortcuts

The editor supports standard Markdown shortcuts as you type:

InputResult
# Heading 1
## Heading 2
### Heading 3
#### Heading 4
##### Heading 5
###### Heading 6
- or * Bullet list
1. Numbered list
[ ] To-do list item
> Block quote
```Code block
---Divider
**text**Bold
*text* or _text_Italic
`text`Inline code
~~text~~Strikethrough
$$text$$Inline math equation
$$$text$$$Math block
:::Callout block

You can also paste Markdown content directly into the editor and it will be automatically converted to rich text.