https://github.com/typecellos/blocknote
A React Rich Text Editor that's block-based (Notion style) and extensible. Built on top of Prosemirror and Tiptap.
https://github.com/typecellos/blocknote
block-based editor javascript notion notion-editor prosemirror react rich-text-editor tiptap typescript wysiwyg yjs
Last synced: 1 day ago
JSON representation
A React Rich Text Editor that's block-based (Notion style) and extensible. Built on top of Prosemirror and Tiptap.
- Host: GitHub
- URL: https://github.com/typecellos/blocknote
- Owner: TypeCellOS
- License: mpl-2.0
- Created: 2022-03-02T07:24:48.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2025-04-11T12:25:38.000Z (10 days ago)
- Last Synced: 2025-04-11T13:13:26.400Z (10 days ago)
- Topics: block-based, editor, javascript, notion, notion-editor, prosemirror, react, rich-text-editor, tiptap, typescript, wysiwyg, yjs
- Language: TypeScript
- Homepage: https://www.blocknotejs.org/
- Size: 76.5 MB
- Stars: 7,815
- Watchers: 36
- Forks: 527
- Open Issues: 262
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
Welcome to BlockNote! The open source Block-Based
React rich text editor. Easily add a modern text editing experience to your app.
Homepage
-
Documentation
-
Quickstart
-
Examples
# Live demo
See our homepage @ [https://www.blocknotejs.org](https://www.blocknotejs.org/) or browse the [examples](https://www.blocknotejs.org/examples).
# Example code (React)
[](https://badge.fury.io/js/%40blocknote%2Freact)
```typescript
import { useCreateBlockNote } from "@blocknote/react";
import { BlockNoteView } from "@blocknote/mantine";
import "@blocknote/core/fonts/inter.css";
import "@blocknote/mantine/style.css";
function App() {
const editor = useCreateBlockNote();
return ;
}
```
`@blocknote/react` comes with a fully styled UI that makes it an instant, polished editor ready to use in your app.
If you prefer to create your own UI components (menus), or don't want to use React, you can use `@blocknote/core` (_advanced_, [see docs](https://www.blocknotejs.org/docs/vanilla-js)).
# Features
BlockNote comes with a number of features and components to make it easy to embed a high-quality block-based editor in your app:
### Animations:
### Helpful placeholders:
### Drag and drop blocks:
### Nesting / indentation with tab and shift+tab:
### Slash (/) menu:
### Format menu:
### Real-time collaboration:
# Feedback 🙋♂️🙋♀️
We'd love to hear your thoughts and see your experiments, so [come and say hi on Discord](https://discord.gg/Qc2QTTH5dF) or [Matrix](https://matrix.to/#/#typecell-space:matrix.org).
# Contributing 🙌
See [CONTRIBUTING.md](CONTRIBUTING.md) for more info and guidance on how to run the project (TLDR: just use `npm start`).
Directory structure:
```
blocknote
├── packages/core - The core of the editor
├── packages/react - The main library for use in React apps
├── packages/mantine - Mantine (default) implementation of BlockNote UI
├── packages/ariakit - AriaKit implementation of BlockNote UI
├── packages/shadcn - ShadCN / Tailwind / Radix implementation of BlockNote UI
├── examples - Example apps
├── playground - App to browse the example apps (https://playground.blocknotejs.org)
└── tests - Playwright end to end tests
```
The codebase is automatically tested using Vitest and Playwright.
# License 📃
BlockNote is licensed under the [MPL 2.0 license](https://fossa.com/blog/open-source-software-licenses-101-mozilla-public-license-2-0/), which allows you to use BlockNote in commercial (and closed-source) applications. If you make changes to the BlockNote source files, you're expected to publish these changes so the wider community can benefit as well.
# Credits ❤️
BlockNote builds directly on two awesome projects; [Prosemirror](https://prosemirror.net/) by Marijn Haverbeke and [Tiptap](https://tiptap.dev/). Consider sponsoring those libraries when using BlockNote: [Prosemirror](https://marijnhaverbeke.nl/fund/), [Tiptap](https://github.com/sponsors/ueberdosis).
BlockNote is built as part of [TypeCell](https://www.typecell.org). TypeCell is proudly sponsored by the renowned [NLNet foundation](https://nlnet.nl/foundation/) who are on a mission to support an open internet, and protect the privacy and security of internet users. Check them out!
Hosting and deployments powered by Vercel:
This project is tested with BrowserStack