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
Что это такое?BlockNote — это редактор с блочной структурой и форматированием текста для React с открытым исходным кодом, похожий по работе на Notion. В его основе лежат ProseMirror и Tiptap. Вы встраиваете его в своё приложение.
Это отдельное приложение вроде Notion или то, что я добавляю в свой код?Это библиотека, а не готовый сервис: вы устанавливаете @blocknote/react из npm и встраиваете компонент редактора в своё React-приложение. Интерфейс уже полностью оформлен, поэтому всё выглядит аккуратно без лишних усилий.
Как попробовать и потом добавить в свой проект?Начните с живого демо на главной странице или посмотрите примеры. Когда будете готовы, добавьте npm-пакет @blocknote/react и подключите компонент редактора в своём React-приложении.
Нужно ли разбираться в редакторских движках, на которых он построен?BlockNote построен напрямую на ProseMirror и Tiptap, а совместное редактирование в реальном времени работает на Yjs — но всё это поставляется в составе пакета, так что подключать их вручную не придётся.
Можно ли использовать в коммерческом продукте с закрытым кодом?Да, для большей части проекта: основная часть BlockNote распространяется по лицензии MPL-2.0, которая разрешает коммерческое использование и закрытый код, но с ожиданием, что изменения в исходных файлах самого BlockNote будут опубликованы. Пакеты XL — под GPL-3.0: если вы не можете соблюдать её условия, потребуется коммерческая лицензия.
Что редактор умеет сразу после установки?Из коробки есть меню по слэшу (/) для вставки блоков, меню форматирования, перетаскивание блоков, вложенность и отступы через Tab и Shift+Tab, полезные подсказки-заглушки и анимации.
Поддерживается ли совместная работа в реальном времени?Да — совместное редактирование в реальном времени встроено с самого начала, под капотом используется Yjs.
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