Search page titles, headings and text across the docs.

Get started

On this page

Pick your platform

Use this page to find your platform, see what works there today, and jump to a five-minute quick start.

Every platform runs the same Rust core, so documents, extensions, and commands behave the same everywhere. A document you create in Dart exports byte for byte the same as one created in Rust or TypeScript.

What’s available today

PlatformPackageStatusQuick start
Server: Rustcanvist_headlessAvailableRust
Server: Node, Deno, Bun, Workers@canvist/headlessAvailableTypeScript
Server: DartcanvistAvailableDart
Server-side renderingcanvist_headless (ssr feature)Available in Rust; JavaScript soonSSR
Fluttercanvist_flutterEngine available; editor widget soonFlutter
Web@canvist/webPreviewWeb
React@canvist/reactPreviewReact
Vue@canvist/vuePreviewVue
iOSCanvist Swift packageComing sooniOS
Androidcanvist-androidComing soonAndroid
macOS, Windows, Linuxcanvist_desktopComing soonDesktop
React Native and Lynx@canvist/react-nativeComing soonReact Native and Lynx

Available means the package works and its tests run on every change. canvist hasn’t had its first release yet, so every quick start shows how to install from GitHub, and the registry command for after the release.

Which one do I need?

  • You’re processing content on a server: importing Markdown, cleaning pasted HTML, migrating TipTap JSON, or running a collaboration endpoint. Use the server package for your language.
  • You’re building a Flutter app: use canvist_flutter. Your engine code stays the same when the editor widget ships.
  • You want an editor in a web page: use @canvist/web, or its React and Vue bindings. Do server work with @canvist/headless.
  • You’re an AI coding agent: read Integrate canvist with an agent first.
Docs