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 之上构建的插件系统、基于 Radix 的无样式底层组件、现成的 shadcn/ui 组件,并且内置了 AI 支持。
那它是拿来即用的成品编辑器组件,还是需要在其上搭建的框架?是一个框架。它分为四层:面向 slate-react 的 Core 插件系统、覆盖编辑器行为、hooks、序列化和规范化的插件包、无样式的 Radix UI 底层组件,以及可以通过 Plate CLI 复制进项目的 shadcn/ui 组件。
怎么把编辑器跑起来?选一个入门模板——Notion 风格(Plate、插件、AI、后端)、playground(Plate、插件、AI)或 minimal(仅 Plate)——然后按照 shadcn/ui 的方式用 Plate CLI 添加编辑器组件。其余内容文档里都有说明。
运行之前需要装好哪些东西?需要一套 React(TypeScript)Web 技术栈。如果要直接操作这个仓库本身,则需要 Node.js 18.12 或更高版本,以及 pnpm 9.15 或更高版本。
在决定采用它之前,有什么需要提前知道的限制吗?它只适用于 React——核心就是面向 slate-react 的插件系统——而且你需要从插件包和复制进来的组件自己组装编辑器,而不是直接引入一个现成的成品组件。
它能在移动端或桌面应用里用吗,还是只能在浏览器里运行?它是面向 React Web 应用的前端框架,所以面向的是浏览器。README 里没有提到原生移动端或桌面端构建。
AI 这部分具体包含什么?AI 是作为核心功能提供的:它与 MCP 一起列在项目主题中,而且 Notion 风格和 playground 模板都默认启用了 AI。文档里对 AI 功能有详细介绍。
我可以重新调整它的样式来匹配自己的设计系统吗?可以。这些底层组件是无样式的、可访问的 hooks 和组件,专门基于 Radix UI 构建,用于创建设计系统;shadcn/ui 组件则可以当作你自己组件库的起点。
为什么不自己直接搭 Slate,而要选 Plate?Slate 本身太底层。Plate 提供了面向 slate-react 的完善插件系统,还有现成的插件包,覆盖编辑器行为、hooks、序列化和规范化,外加预构建的可访问组件,让你不用自己一层层去拼。
有中文文档和中文支持吗?有。项目提供单独的中文文档、一个社区成员会用中文答疑的中文 Discord 频道,以及面向开发者的中文贡献指南。
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