Yorkie JavaScript SDK

The Yorkie JavaScript SDK implements the client-side libraries.

How to use JS SDK

To get started using Yorkie JavaScript SDK, see: https://yorkie.dev/docs/sdks/js-sdk

Packages

This is a pnpm monorepo. See each package's README for details:

• packages/sdk/ — Core SDK (@yorkie-js/sdk): client, documents, CRDTs
• packages/react/ — React hooks and providers (@yorkie-js/react)
• packages/prosemirror/ — ProseMirror binding (@yorkie-js/prosemirror)
• packages/schema/ — Schema validation (@yorkie-js/schema)
• packages/devtools/ — Chrome devtools extension (@yorkie-js/devtools)
• examples/ — Sample apps using the SDK

Documentation

• docs/design/ — Architectural design documents
• docs/tasks/ — Task tracking (active and archived)
• CHANGELOG.md — Release notes
• MAINTAINING.md — Release and maintenance procedures
• CLAUDE.md — Agent instructions for AI-assisted development

Contributing

See CONTRIBUTING for details on submitting patches and the contribution workflow.

Contributors ✨

Thanks goes to these incredible people: