Installation

Requirements

Node.js 18+
React 18+
Next.js 13+ (App Router or Pages Router)

Install packages

pnpm


pnpm add @inkstream/react-editor @inkstream/editor-core

npm


npm install @inkstream/react-editor @inkstream/editor-core

yarn


yarn add @inkstream/react-editor @inkstream/editor-core

Optional packages


# Heading levels (H1–H6)
pnpm add @inkstream/heading
 
# Inline link editing bubble
pnpm add @inkstream/link-bubble

Pro plugins

Pro plugins are distributed via a private npm registry on GitHub Packages. A paid license token is required.


# Configure the registry (one-time)
echo "@inkstream-dev:registry=https://npm.pkg.github.com" >> .npmrc
echo "//npm.pkg.github.com/:_authToken=YOUR_TOKEN" >> .npmrc
 
# Install
pnpm add @inkstream-dev/pro-plugins

See the Pro Setup guide for full instructions.