Skip to content
aq-ui
Back to EditorsEditor

Markdown Editor

CommonMark and GFM source editor with write, preview, split, formatting, uploads, and deferred rendering.

Preview

This is a live example. Interact with the available controls and use the keyboard to inspect the component's states and behavior.

Loading interactive preview…

Installation

pnpm dlx aq-ui@alpha add markdown-editor

API reference

Client moduleView full source

Quick start

"use client"

import { MarkdownEditor } from "@/components/ui/markdown-editor"

<MarkdownEditor />

Exports

  • EditorAssetUploadAdapter type
  • MarkdownEditor const
  • MarkdownEditorMode type
  • MarkdownEditorPreview const
  • MarkdownEditorPreviewProps interface
  • MarkdownEditorProps interface
  • MarkdownEditorStatusBar function
  • MarkdownEditorStatusBarProps interface
  • MarkdownEditorToolbar function
  • MarkdownEditorToolbarProps interface
  • MarkdownRenderer const
  • useMarkdownEditor function

Registry dependencies

button, code-editor, code-language-markdown, markdown-renderer, upload, use-code-editor, use-markdown-editor, utils

Package dependencies

hast-util-sanitize@^5.0.2, lucide-react@^1.31.0, unified@^11.0.5

Files

  • components/ui/markdown-editor.tsx

Source