Overview
Welcome to Arkpad documentation — a high-performance, modular rich text editor framework built on ProseMirror.
Arkpad is an enterprise-grade rich text editor built on ProseMirror. It provides a sophisticated, developer-first API designed for building powerful, reliable, and highly customizable editing experiences.
What is Arkpad?
Arkpad is a headless, modular rich text editor framework. It gives you complete control over the UI while handling the complex state management, schema validation, and command execution under the hood.
- Extreme Performance — Optimized for large, complex documents
- 100% Modular — Tiny core, infinite extensions
- Type-Safe — First-class TypeScript support
- Headless — Complete CSS/UI freedom
- Agent-Ready — Built-in interceptor layer for AI integration
Quick Start
npm install @arkpad/react @arkpad/coreimport { useArkpadEditor, ArkpadEditorContent } from "@arkpad/react";
import { Essentials } from "@arkpad/core";
export default function App() {
const editor = useArkpadEditor({
extensions: [Essentials],
content: "<h1>Hello, Arkpad!</h1>",
});
return <ArkpadEditorContent editor={editor} />;
}Documentation
Editor
Getting started guides for building with Arkpad — installation, quick start, and practical guides.
Core
Deep-dive reference for the engine, extension system, API, and resources.