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)

radix-ui
Searching Database…

16.7K ·GitHub
What is this?Plate is an open-source rich-text editor framework for React: a plugin system on top of Slate, headless Radix-based primitives, ready-made shadcn/ui components, and AI support built in.
So is it a finished editor widget I drop in, or a framework I build on?A framework. It has four layers: a Core plugin system for slate-react, plugin packages for editor behaviors, hooks, serialization and normalization, unstyled Radix UI primitives, and shadcn/ui components you copy in via the Plate CLI.
How do I get an editor running?Pick a starter template — Notion-like (Plate, plugins, AI, backend), playground (Plate, plugins, AI) or minimal (Plate only) — then add editor components shadcn/ui-style with the Plate CLI. The docs cover the rest.
What do I need installed before it runs?A React (TypeScript) web stack. Working with the repository itself targets Node.js 18.12 or newer and pnpm 9.15 or newer.
Any catch I should know before committing to it?It is React-specific — the core is a plugin system for slate-react — and you assemble the editor from plugin packages and copied-in components rather than dropping in a finished widget.
Does it work in mobile or desktop apps, or is it browser-only?It is a front-end framework for React web apps, so it targets the browser. The README mentions nothing about native mobile or desktop builds.
What does the AI part actually include?AI ships as a first-class feature: it is listed among the project topics alongside MCP, and both the Notion-like and playground templates come with AI enabled. The docs describe the AI features in detail.
Can I restyle it to match my own design system?Yes. The primitives are unstyled, accessible hooks and components built on Radix UI specifically for creating design systems, and the shadcn/ui components are meant as a starting point for your own component library.
Why pick Plate over wiring up Slate myself?Slate alone is low-level. Plate adds a tidy plugin system for slate-react, ready plugin packages covering behaviors, hooks, serialization and normalization, plus prebuilt accessible components, so you skip assembling those layers yourself.
Is there Chinese-language documentation and support?Yes. There are separate Chinese docs, a Chinese Discord channel where community members answer questions in Chinese, and a Chinese contributing guide for developers.
What are similar projects?slate, lexical, arc-library, base-ui, ui, editor.js, primitives, BlockNote
Creator
udecode
Size
321.3 MB
Stars
16.7K
Age
6y
Commits · 90 Days