LexKit Docs

Installation Guide

Get LexKit running in your project

Follow our step-by-step guide to install LexKit and its peer dependencies. We'll get you from zero to a working editor in under 5 minutes.

Quick SetupMultiple Package ManagersType-Safe Installation

Understanding LexKit's Architecture

LexKit is built on Meta's Lexical framework. Here's why this matters for your installation.

Why Peer Dependencies?

LexKit doesn't bundle Lexical — instead, it declares it as a peer dependency. This gives you full control over versioning and reduces bundle size.

Smaller bundle size

Version control in your hands

Avoid dependency conflicts

What This Means for You

You'll install both LexKit and its Lexical dependencies together. This ensures compatibility and gives you access to all Lexical's features.

Pro Tip:

Always check our documentation for the recommended Lexical version that matches your LexKit version.

Install LexKit first, then its Lexical peer dependencies.

Install LexKit

Start with the main LexKit package that provides our type-safe editor system.

npm install @lexkit/editor

Install Lexical Dependencies

Install the Lexical packages that power LexKit's functionality. These are peer dependencies.

npm install lexical @lexical/react @lexical/html @lexical/markdown @lexical/list @lexical/rich-text @lexical/selection @lexical/utils

See LexKit in action with this basic example.

A simple editor with basic formatting capabilities.

Start writing your content here...

Common issues and their solutions.

Version Conflicts

If you see version conflicts, try installing with the --legacy-peer-deps flag or check our documentation for compatible version combinations.

TypeScript Issues

Make sure your TypeScript version is compatible. LexKit requires TypeScript 4.5+ and proper type definitions for all Lexical packages.

Now that LexKit is installed, let's start building amazing editors!