Introduction
Installation
Add inksane to your project and check the requirements.
Requirements
- Node.js 22.12 or newer for the tooling around your project.
- A bundler that resolves ESM. Every inksane package is ESM-only.
- A browser supported by CodeMirror 6, which is every current Chrome, Firefox, Safari, and Edge.
Install the core package
@inksane/core contains the editor, BaseKit, individual feature extensions, and the command API. It has no
framework dependency.
pnpm add @inksane/corenpm install @inksane/coreyarn add @inksane/corebun add @inksane/coreInstall the React bindings
Add the bindings next to core when you build with React. They depend on @inksane/core, so the
core package is installed for you.
pnpm add @inksane/reactnpm install @inksane/reactInstall the collaboration extension
@inksane/extension-collaboration adds Yjs-backed collaboration and remote cursors.
pnpm add @inksane/extension-collaborationNo styles to import
inksane is headless, so none of these packages ship a stylesheet. The editor renders without CSS, and styling is your job.