plate README

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

Plate

Total Downloads PRs Welcome

Templates

You can choose one of the following templates to get started:

Option Plate Plugins AI Backend
Notion-like template ✅ ✅ ✅ ✅
Plate playground template ✅ ✅ ✅
Plate minimal template ✅

Documentation

You can learn more about Plate by checking out our documentation.

Contributing

To get started, check out our contributing guide.

Contributors

We'd love for you to join us! Whether it's through giving us a 🌟 star, making a 📥 pull request, or sharing your plugins, your help is always appreciated.

Star History Chart

Need more help? Join us on Discord. We're always here to guide you.

中文文档

您可以通过查看我们的中文文档了解更多关于Plate的信息。如果您需要中文支持,欢迎加入我们的Discord中文频道,我们的社区成员将很乐意用中文为您解答问题。

对于贡献者,我们也提供了中文贡献指南,帮助您参与到Plate的开发中。

plate (udecode/plate)

Searching Database…

16.7K ·GitHub
Что это такое?Plate — это опенсорсный фреймворк для редактора с форматированием текста на React: система плагинов поверх Slate, headless-примитивы на основе Radix, готовые компоненты shadcn/ui и встроенная поддержка AI.
Так это готовый редактор, который я просто вставляю, или фреймворк, на котором я строю своё?Это фреймворк. В нём четыре уровня: система плагинов Core для slate-react, пакеты плагинов с поведением редактора, хуками, сериализацией и нормализацией, нестилизованные примитивы Radix UI и компоненты shadcn/ui, которые вы копируете себе через Plate CLI.
Как запустить редактор у себя?Выберите стартовый шаблон — в стиле Notion (Plate, плагины, AI, бэкенд), playground (Plate, плагины, AI) или минимальный (только Plate) — затем добавьте компоненты редактора в стиле shadcn/ui с помощью Plate CLI. Остальное описано в документации.
Что должно быть установлено, чтобы всё заработало?Веб-стек на React (TypeScript). Для работы с самим репозиторием нужен Node.js 18.12 или новее и pnpm 9.15 или новее.
Есть ли подвох, о котором стоит знать до начала работы?Он работает только с React — ядро представляет собой систему плагинов для slate-react — и редактор вы собираете из пакетов плагинов и скопированных компонентов, а не вставляете готовый виджет целиком.
Работает ли он в мобильных или десктопных приложениях, или только в браузере?Это фронтенд-фреймворк для веб-приложений на React, поэтому он ориентирован на браузер. В README ничего не сказано про нативные сборки для мобильных устройств или десктопа.
Что именно входит в AI-часть?AI — это полноценная функция проекта: она указана среди тем проекта наряду с MCP, а шаблоны в стиле Notion и playground поставляются с включённым AI. AI-возможности подробно описаны в документации.
Могу ли я оформить его под свою дизайн-систему?Да. Примитивы нестилизованы — это доступные хуки и компоненты на базе Radix UI, созданные специально для построения дизайн-систем, а компоненты shadcn/ui задуманы как отправная точка для вашей собственной библиотеки компонентов.
Почему лучше взять Plate, а не подключать Slate самостоятельно?Сам по себе Slate — низкоуровневая библиотека. Plate добавляет аккуратную систему плагинов для slate-react, готовые пакеты плагинов с поведением редактора, хуками, сериализацией и нормализацией, а также готовые доступные компоненты, так что вам не приходится собирать эти слои вручную.
Есть ли документация и поддержка на китайском языке?Да. Есть отдельная китайская документация, китайский канал в Discord, где участники сообщества отвечают на вопросы по-китайски, и китайское руководство для разработчиков, желающих внести вклад.
What are similar projects?slate, lexical, arc-library, base-ui, ui, editor.js, primitives, BlockNote
Creator
udecode
Size
312.9 MB
Stars
16.7K
Age
6y
Commits · 90 Days