BlockNote README

The project's README from github.com/TypeCellOS/BlockNote. As one markdown file: README.md.

TypeCell

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 or browse the examples.

Example code (React)

npm version

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 <BlockNoteView editor={editor} />;
}

@blocknote/react comes with a fully styled UI that makes it an instant, polished editor ready to use in your app.

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.

Contributing 🙌

See CONTRIBUTING.md for more info and guidance on how to run the project (TLDR: just use pnpm start).

The codebase is automatically tested using Vitest and Playwright.

License 📃

BlockNote is 100% Open Source Software. The majority of BlockNote is licensed under the MPL-2.0 license, 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. Learn more.

The XL packages (source code in the packages/xl-* directories and published in NPM as @blocknote/xl-*) are licensed under the GPL-3.0. If you cannot comply with this license and want to use the XL libraries, you'll need a commercial license. Refer to our website for more information.

Credits ❤️

BlockNote builds directly on two awesome projects; Prosemirror by Marijn Haverbeke and Tiptap. Consider sponsoring those libraries when using BlockNote: Prosemirror, Tiptap.

BlockNote is built as part of TypeCell. TypeCell is proudly sponsored by the renowned NLNet foundation who are on a mission to support an open internet, and protect the privacy and security of internet users. Check them out!

NLNet

Hosting and deployments powered by Vercel:

NLNet

This project is tested with BrowserStack

BlockNote (TypeCellOS/BlockNote)

Searching Database…

10.3K ·GitHub
What is this?BlockNote is an open source block-based rich text editor for React with a Notion-style editing experience, built on top of ProseMirror and Tiptap. You embed it in your own app.
Is this a standalone app like Notion, or something I add to my code?It's a library, not a hosted app: you install @blocknote/react from npm and embed the editor component in your React application. The UI comes fully styled, so it looks polished without extra work.
How do I try it and then get it into my project?Start with the live demo on the homepage or browse the examples. When ready, add the @blocknote/react npm package and render the editor component in your React app.
Do I need to learn the editor engines it's built on?BlockNote is built directly on ProseMirror and Tiptap, and real-time collaboration is powered by Yjs — but they ship as part of the package, so you don't wire them up yourself.
Can I use it in a commercial, closed-source product?Yes for most of it: the majority of BlockNote is MPL-2.0, which allows commercial and closed-source use, with the expectation that changes to BlockNote's own source files get published. The XL packages are GPL-3.0 — if you can't comply with that, they require a commercial license.
What does the editor do out of the box?A slash (/) menu for inserting blocks, a format menu, drag and drop of blocks, nesting and indentation with Tab and Shift+Tab, helpful placeholders, and animations are all built in.
Does it support real-time collaboration?Yes — real-time collaboration is a built-in feature, with Yjs as the multiplayer layer underneath.
What are similar projects?tiptap, ckeditor5, lexical, novel, slate, milkdown, puck, pell
Creator
TypeCellOS
Size
1.5 GB
Stars
10.3K
Age
4y
Commits · 90 Days