The Yorkie JavaScript SDK implements the client-side libraries.
To get started using Yorkie JavaScript SDK, see: https://yorkie.dev/docs/sdks/js-sdk
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
- docs/ — Architectural design documents and task tracking
- scripts/ — Task-doc tooling and clone setup
- CHANGELOG.md — Release notes
- MAINTAINING.md — Release and maintenance procedures
- CLAUDE.md — Agent instructions for AI-assisted development
See CONTRIBUTING for details on submitting patches and the contribution workflow.
Thanks goes to these incredible people: