ArchDoc Documentation

Editor Overview

ArchDoc's powerful rich text editor features

Editor Overview

ArchDoc includes a powerful TipTap-based rich text editor designed for technical documentation.

Editor Interface

The editor consists of:

  1. Toolbar: Formatting controls at the top
  2. Content Area: Where you write and edit
  3. Side Panel: Comments and metadata (in view mode)

Key Features

Toolbar Overview

The editor toolbar provides quick access to all formatting options:

History

ButtonAction
↩️ UndoUndo last change
↪️ RedoRedo undone change

Text Formatting

ButtonActionShortcut
BBoldCtrl/Cmd + B
IItalicCtrl/Cmd + I
UnderlineCtrl/Cmd + U
SStrikethrough-
</>Inline codeCtrl/Cmd + E
🖍️Highlight-

Headings

Six heading levels available (H1-H6).

Lists

ButtonAction
Bullet list
1.Numbered list
☑️Task list

Blocks

ButtonAction
"Blockquote
{ }Code block
Horizontal rule

Media

ButtonAction
🔗Insert link
🖼️Insert image
📊Insert table
✏️Insert Excalidraw diagram

Text Alignment

  • Align left
  • Align center
  • Align right
  • Justify

Subscript/Superscript

  • Subscript (H₂O)
  • Superscript (x²)

Content Capabilities

Rich Text

  • Multiple heading levels
  • Bold, italic, underline, strikethrough
  • Highlight text
  • Links with automatic detection

Code

  • Inline code snippets
  • Code blocks with syntax highlighting
  • Support for 100+ programming languages

Lists

  • Bullet points
  • Numbered lists
  • Nested lists
  • Interactive task lists

Tables

  • Create structured data
  • Add/remove rows and columns
  • Header rows

Media

  • Embed images via URL
  • Insert links
  • Excalidraw diagrams
  • Mermaid diagrams (in preview)

Keyboard Shortcuts

Essential

ActionWindows/LinuxMac
SaveCtrl + SCmd + S
UndoCtrl + ZCmd + Z
RedoCtrl + YCmd + Shift + Z

Formatting

ActionWindows/LinuxMac
BoldCtrl + BCmd + B
ItalicCtrl + ICmd + I
UnderlineCtrl + UCmd + U
Inline CodeCtrl + ECmd + E

Structure

ActionWindows/LinuxMac
Heading 1Ctrl + Alt + 1Cmd + Alt + 1
Heading 2Ctrl + Alt + 2Cmd + Alt + 2
Bullet ListCtrl + Shift + 8Cmd + Shift + 8
Ordered ListCtrl + Shift + 7Cmd + Shift + 7
Task ListCtrl + Shift + 9Cmd + Shift + 9
BlockquoteCtrl + Shift + BCmd + Shift + B
Code BlockCtrl + Alt + CCmd + Alt + C

Auto Features

Auto-Save

  • Content cached locally every few seconds
  • Survives browser crashes
  • Syncs when you return
  • URLs automatically become clickable links
  • Paste URLs to create links

Smart Typography

  • Automatic curly quotes
  • Em-dashes from --
  • Ellipsis from ...

View Modes

Edit Mode

  • Full editing capabilities
  • All toolbar options
  • Real-time collaboration

Preview Mode

  • Read-only formatted view
  • See how the document looks
  • Mermaid diagrams rendered

Switch between modes using the tabs at the top of the document.

Getting Started

  1. Text Formatting - Basic formatting
  2. Code Blocks - Adding code
  3. Tables - Structured data
  4. Diagrams - Visual elements

On this page