Skip to main content
The Document Editor provides a powerful, full-featured editing experience for AGO source documents with real-time preview, auto-save, and version history.

​
Features

​
Monaco Editor

The editor uses Monaco Editor (the same editor powering VS Code) for a professional markdown editing experience with:
  • Syntax highlighting for markdown
  • Keyboard shortcuts (Ctrl/Cmd+S to save)
  • Line numbers and code folding
  • Auto-completion and IntelliSense

​
Split View with Live Preview

  • Side-by-side editing: Write markdown on the left, see the rendered preview on the right
  • Toggle preview: Hide the preview to focus on editing with a full-width editor
  • Real-time rendering: Changes appear instantly in the preview pane

​
Toolbar Quick Actions

The toolbar provides one-click insertion of common markdown elements:
  • Headings: H1, H2, H3
  • Text formatting: Bold, italic, inline code
  • Lists: Bullet lists, numbered lists, quotes
  • Links and images: Insert links, upload images, create tables
  • Version history: Access previous versions of the document

​
Auto-Save with Drafts

  • Automatic saving: Your changes are automatically saved as drafts every 3 seconds
  • Draft indicator: See the save status in the toolbar (“Saving…”, “Last saved at…”)
  • Persistent drafts: Your drafts are preserved across browser sessions
  • No lost work: Even if you navigate away, your draft will be available when you return

​
Image Upload

  • Click to upload: Use the image button in the toolbar to select and upload images
  • Drag and drop: Drag image files directly into the editor
  • Paste from clipboard: Copy an image and paste it directly into the editor (Ctrl/Cmd+V)
  • Automatic markdown: Images are automatically inserted with proper markdown syntax

​
Version History

Track all changes to your documents with comprehensive version history:
  • Automatic versioning: A new version is created every time you save
  • Version browser: View all previous versions with timestamps and author information
  • Restore capability: Restore any previous version with a single click
  • Version comparison: Select two versions to compare changes (opens in new window)
  • Change summaries: Each version can include a summary of what changed

​
Using Version History

  1. Click the History button in the toolbar
  2. Browse through previous versions in the sidebar panel
  3. Click on a version to select it for comparison
  4. Select two versions and click Compare to see differences
  5. Click the Restore button on any version to revert to that content

​
How to Use

​
Opening the Editor

  1. Navigate to Knowledge in the sidebar
  2. Select a knowledge source, then select a document from the tree
  3. Click the Edit button (pencil icon) in the document sidebar
  4. The full-screen editor will open

​
Editing a Document

  1. Type or paste your markdown content in the left pane
  2. Use the toolbar buttons to insert formatted elements
  3. View the rendered result in the right preview pane
  4. Your changes are auto-saved as drafts every 3 seconds

​
Saving Your Changes

  1. Click the Save button in the header (or press Ctrl/Cmd+S)
  2. Your changes will be published to the document
  3. A new version will be automatically created in the version history
  4. The editor will close and return to the document view

​
Canceling Edits

  • Click the Cancel button to discard your changes
  • Your saved drafts will remain available for future editing

​
Tips

  • Use keyboard shortcuts: Ctrl/Cmd+S to save quickly
  • Toggle preview: Hide the preview when working with long documents for better performance
  • Check version history: Before making major changes, check the version history to understand the document’s evolution
  • Add change summaries: When significant changes are made, version history helps track what was modified
  • Draft safety: Don’t worry about losing work - drafts are automatically saved and persisted

​
Technical Details

  • Editor: Monaco Editor with markdown syntax highlighting
  • Preview: Real-time markdown rendering with GitHub-flavored markdown support
  • Auto-save: 3-second debounce after last keystroke
  • Version control: Automatic version creation on every save
  • Storage: Drafts and versions stored securely in the database
  • Supported formats: Full GitHub-flavored markdown including tables, code blocks, and task lists