@liveblocks/react-blocknote
Version:
An integration of BlockNote + React to enable collaboration, comments, live cursors, and more with Liveblocks.
68 lines (50 loc) • 2.39 kB
Markdown
<p align="center">
<a href="https://liveblocks.io#gh-light-mode-only">
<img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-light.svg" alt="Liveblocks" />
</a>
<a href="https://liveblocks.io#gh-dark-mode-only">
<img src="https://raw.githubusercontent.com/liveblocks/liveblocks/main/.github/assets/header-dark.svg" alt="Liveblocks" />
</a>
</p>
# `@liveblocks/react-blocknote`
<p>
<a href="https://npmjs.org/package/@liveblocks/react-blocknote">
<img src="https://img.shields.io/npm/v/@liveblocks/react-blocknote?style=flat&label=npm&color=c33" alt="NPM" />
</a>
<a href="https://bundlephobia.com/package/@liveblocks/react-blocknote">
<img src="https://img.shields.io/bundlephobia/minzip/@liveblocks/react-blocknote?style=flat&label=size&color=09f" alt="Size" />
</a>
<a href="https://github.com/liveblocks/liveblocks/blob/main/LICENSE">
<img src="https://img.shields.io/github/license/liveblocks/liveblocks?style=flat&label=license&color=f80" alt="License" />
</a>
</p>
`@liveblocks/react-blocknote` provides [React](https://reactjs.org/) APIs to
integrate [BlockNote](https://www.blocknotejs.org/) text editors with
Liveblocks—a platform to build, host, and scale collaborative applications with
zero configuration, no maintenance required.
## Installation
```
npm install @liveblocks/client @liveblocks/react @liveblocks/react-blocknote
```
## Documentation
Read the
[documentation](https://liveblocks.io/docs/api-reference/liveblocks-react-blocknote)
for guides and API references.
## Examples
Explore our [collaborative examples](https://liveblocks.io/examples) to help you
get started.
> All examples are open-source and live in this repository, within
> [`/examples`](../../examples).
## Releases
See the [latest changes](https://github.com/liveblocks/liveblocks/releases) or
learn more about
[upcoming releases](https://github.com/liveblocks/liveblocks/milestones).
## Community
- [Discord](https://liveblocks.io/discord) - To get involved with the Liveblocks
community, ask questions and share tips.
- [X](https://x.com/liveblocks) - To receive updates, announcements, blog posts,
and general Liveblocks tips.
## License
Licensed under the Apache License 2.0, Copyright © 2021-present
[Liveblocks](https://liveblocks.io).
See [LICENSE](../../LICENSE) for more information.