README_zh.md

May 12, 2026 · View on GitHub

English | 简体中文

Yiitap

⚡ 几分钟打造 Notion 风格的 AI 编辑器

stars

Yiitap 是一个AI驱动、Notion风格的块级编辑器。🔥

演示

AI + 块级编辑器 —— 实例展示

截图

AI菜单

AI块

分栏

表格

核心特性

🚀 支持 Vue & React: 无缝集成两大主流框架
🤖 AI 赋能: 内置 AI 功能,助力内容创作,提升工作效率
📝 Markdown 友好:支持直接粘贴、复制 Markdown 内容
🤝 协作:基于 Yjs 和 Hocuspocus 的协作编辑
📝 Notion 风格编辑器: 界面简洁,交互直观
🔧 高度可定制 & 可扩展: 基于 Tiptap & ProseMirror 构建
🧩 块级编辑: 通过 气泡菜单、悬浮菜单、主菜单、侧边菜单 轻松操作内容
丰富的特性: 内置 15+ 定制扩展 & 50+ 组件
🌍 国际化 – 支持 10+ 语言
🌗 支持深色模式
🆓 MIT 许可

使用场景

  • 知识管理 / 笔记:个人笔记、知识库、灵感记录、项目文档;
  • 内容创作 / 写作:文章、博客、周报、技术文档、长文写作;
  • AI 内容编辑:AI 辅助续写、润色、改写、总结、翻译等;
  • Markdown 工作流:Markdown 编辑、查看、复制粘贴、导入导出;
  • AI 对话渲染:适合作为 Chat / Agent 的富文本消息渲染器;
  • 低代码 / CMS 编辑器:用于后台管理系统、页面编辑器、内容系统;
  • 自定义编辑器开发:适合需要块级编辑、扩展能力、深度定制的场景。

快速开始

安装

pnpm install @yiitap/vue @yiitap/vue-preset

指南

如需更详细的信息,请务必查看我们的文档。如果您在使用过程中遇到任何问题或有改进建议,欢迎提交 issue

使用 Yiitap 的项目

🍀 PileaX: 一站式 AI 知识库,一款本地优先的一站式 AI 知识库,集 AI 对话、智能笔记、电子书阅读和管理于一体。

贡献

如果您希望贡献代码,请参阅我们的贡献指南。我们欢迎所有贡献,并将对贡献者给予完整署名。

贡献者

致谢

  • TiptapProseMirror:Yiitap 构建于 Tiptap 和 ProseMirror 之上。
  • BlockNote:一款基于块结构且可扩展的 React 富文本编辑器。

许可证

本项目基于 MIT 许可证发布。更多信息请参阅 License File