# uai-editor

**Repository Path**: uai-team/uai-editor

## Basic Information

- **Project Name**: uai-editor
- **Description**: UAI Editor 是一个现代 UI 风格、面向 AI 的强大的个人&团队文档。开箱即用，支持Vue、React、Layui、Angular 等几乎任何前端框架。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 87
- **Forks**: 27
- **Created**: 2025-02-27
- **Last Updated**: 2025-09-28

## Categories & Tags

**Categories**: text-editor

**Tags**: None

## README

# UAI Editor：有爱文档，有爱、有AI、有UI。

> 💪打造现代 UI 风格、面向 AI 的最强、最轻量级的个人&团队文档。  
> UAI Editor 是一个面向 AI 的、现代 UI 风格的下一代富文本编辑器。开箱即用、支持所有前端框架。

- **【全行业】** 无论您是：金融、教育、医疗、零售、互联网还是传统行业。
- **【全场景】** 无论您是：文章创作、会议记录、学术论文还是知识库管理。
- **【全功能】** 功能丰富：文本编辑、格式排版、多媒体插入、表格制作等。
- **【全模态】** 人工智能：文字、语音、图片、视频，全模态功能创作体验。

<table>
  <tr>
    <td colspan="2">
      <img src="./docs/images/image-00.png" alt="image-00" width="100%" />
    </td>
  </tr>
  <tr>
    <td colspan="2">
      <br />
    </td>
  </tr>
  <tr>
    <td>
      <img src="./docs/images/image-01.png" alt="image-01"/>
    </td>
    <td>
      <img src="./docs/images/image-02.png" alt="image-02"/>
    </td>
  </tr>
</table>

## 特别鸣谢

### 优秀项目

**学习与借鉴成功案例、模仿及改进优秀项目，是快速提升自身能力的学习方式。** 本项目的创作过程中，学习、借鉴了一些优秀的作品，并结合自身理解完成改进创作。在此对这些优秀作品及作者表示衷心的感谢！

* [Umo Editor](https://gitee.com/umodoc/editor) 是一个基于 Vue3 和 Tiptap 的本土化开源文档编辑器，专为国人用户设计。它提供了强大的文档编辑能力和 AI 创作功能。如果您基于 VUE 进行项目开发，可以直接引用该作品。

### 优秀团队

**个人奋进能突破局限、团队协作可汇聚智慧，是持续发展共同进步的高效路径。** 本项目的创作过程中，遇到了一群志同道合的小伙伴，在人工智能全链路学习中给予了很大的帮助。在此表示衷心的感谢！

* 上海人工智能实验室组织的书生大模型实战营，提供了人工智能全链路工具：[InternLM](https://github.com/InternLM/InternLM)、[InternVL](https://github.com/OpenGVLab/InternVL)、[XTuner](https://github.com/InternLM/XTuner)、[LMDeploy](https://github.com/InternLM/LMDeploy)，以及优质的人工智能课程，并且为项目提供了免费的算力支持。

### 优秀用户

**用户认可，是项目生存的根基；持续迭代，是项目进化的引擎。** 您的认可与支持是项目持续迭代的最大动力，感谢每一位点赞支持项目的小伙伴！

## 与众不同

UAI Editor 提供了完善的文档编辑能力和 AI 创作能力，支持 Markdown 语法，支持基础的富文本编辑功能，支持插入多种节点类型，提供了多种类型的实用工具。作为一个独立的纯前端文档编辑器，UAI Editor 可以轻松无缝集成到 Vue、React、Layui、Angular 等几乎任何前端框架。

### 场景丰富

* 无论您是：金融、教育、医疗、零售、互联网还是传统行业。
* 无论您是：文章创作、会议记录、学术论文还是知识库管理。
* 即便是个人笔记整理，UAI Editor 都能成为您得力的助手。

### 功能全面

* **基础：** 标题、正文、字体、字号、加粗、斜体、下划线、删除线、链接、行内代码、上标、下标、分割线、引用...
* **增强：** 撤销、重做、格式刷、橡皮擦、字体颜色、背景颜色、对齐方式、行高、待办事项、有（无）序列表、段落缩进...
* **附件：** 支持图片、语音、视频、文件功能，支持选择上传、支持拖动调整大小...
* **Markdown：** 标题、引用、表格、图片、代码块、高亮块、各种列表、粗体、斜体、删除线...
* **AI：** AI 续写、AI 优化、AI 校对、AI 翻译、自定义 AI 菜单及其 Prompts...
* **更多：** 国际化、主题切换...

### 简单易用

* UAI Editor 基于 Web Component 开发，支持与任意主流的前端框架集成。
* UAI Editor 提供了友好的 UI 界面，强大的工具栏支持，助您轻松实现文档编辑。
* UAI Editor 提供了便捷的快捷键支持，让您的文档编辑快人一步。

### AI 驱动

* UAI Editor 旨在解决 Web 应用中文档编辑的复杂性，提供类似 Microsoft Word 的强大编辑能力，同时保持 Web 应用的便捷性。
* UAI Editor 打造了一个完全由 AI 驱动的富文本编辑器，同时支持对接任意大模型，包括私有的大模型。
* UAI Editor 支持全模态大模型，包括文本生成、语音识别、语音生成、文生图、图生图、局部重绘、图片理解、文生视频、图生视频、视频理解等。
* UAI Editor 私有模型适配多种环境，包括英伟达显卡、天数智芯显卡、Pytorch、IPEX等。

## 帮助文档

UAI Editor 提供了一份使用文档，您可以通过以下方式访问：

安装必要的软件`docsify`：

```bash
npm i docsify -g
```

### 开发文档

启动文档服务：

```bash
docsify serve docs/developer --port 3000
```

访问文档：

[http://localhost:3000](http://localhost:3000)。

<table>
  <tr>
    <td>
      <img src="./docs/images/image-81.png" alt="image-81"/>
    </td>
    <td>
      <img src="./docs/images/image-82.png" alt="image-82"/>
    </td>
  </tr>
</table>

### 用户文档

启动文档服务：

```bash
docsify serve docs/user --port 3010
```

访问文档：

[http://localhost:3010](http://localhost:3010)。

<table>
  <tr>
    <td>
      <img src="./docs/images/image-91.png" alt="image-91"/>
    </td>
    <td>
      <img src="./docs/images/image-92.png" alt="image-92"/>
    </td>
  </tr>
</table>

或者，您也可以直接访问：[文档编辑](docs/user/base.md)、[附件插入](docs/user/insert.md)、[文档导出](docs/user/export.md)、[AI 功能](docs/user/chat.md)等文档。

## 开源地址

* GitCode：[https://gitcode.com/uai-team/uai-editor](https://gitcode.com/uai-team/uai-editor)
* Gitee：[https://gitee.com/uai-team/uai-editor](https://gitee.com/uai-team/uai-editor)
* Github：[https://github.com/uai-team/uai-editor](https://github.com/uai-team/uai-editor)

## 开源优势

* **免费使用：** 作为开源项目，UAI Editor 采用 [MIT 许可证](LICENSE) 对所有用户免费开放，无需担心版权问题。

* **持续更新：** UAI Editor 将持续迭代，不断优化功能，提升用户体验。

* **定制开发：** 开发者可根据项目需求进行定制化开发，打造专属的文档编辑器。

## 开源协议

UAI Editor 采用 [MIT 许可证](LICENSE)，您可以自由地使用、修改和分发软件，可以用于个人项目或商业项目，**但禁止用于参加创新、创意类比赛**。

## 支持我们

如果您觉得 UAI Editor 有用，请考虑通过以下方式支持我们：

* ⭐ 给 UAI Editor 仓库 点个 Star，表示对项目的支持。
* ⛓️ UAI Editor 很多功能还存在不足，如果您感兴趣，欢迎优化 PR。