# WangEditorAI富文本编辑器

**Repository Path**: tyerp/wangEditor-ai

## Basic Information

- **Project Name**: WangEditorAI富文本编辑器
- **Description**: AI 富文本编辑器 - 轻量化集成，高效能创作，基于WangEditorAI开发，接入火山引擎AI服务。
- **Primary Language**: Unknown
- **License**: MIT
- **Default Branch**: main
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2025-12-28
- **Last Updated**: 2026-03-29

## Categories & Tags

**Categories**: text-editor

**Tags**: None

## README

# WangEditor AI

<div align="center">

![WangEditor AI Logo](/public/images/logo.png)

**AI 富文本编辑器 - 轻量化集成，高效能创作**

基于 [WangEditor](https://www.wangeditor.com/) 和火山引擎 AI 服务构建的智能富文本编辑器

[![Gitee](https://img.shields.io/badge/Gitee-C71D23?style=flat-square&logo=gitee&logoColor=white)](https://gitee.com/tyerp/wangEditor-ai)
[![Vue](https://img.shields.io/badge/Vue-3.4.0-4FC08D?style=flat-square&logo=vue.js&logoColor=white)](https://vuejs.org/)
[![WangEditor](https://img.shields.io/badge/WangEditor-5.1.23-1890FF?style=flat-square)](https://www.wangeditor.com/)

</div>

## ✨ 特性

### 🎨 基于 wangEditor 零侵入开发

零侵入集成，保持 wangEditor 原生体验，快速赋能项目高效便捷的 AI 富文本编辑功能。

### 🤖 AI 智能助手

集成 AI 续写、优化、校对、翻译等功能，侧边栏智能对话助手支持实时流式响应，自动保存对话历史，支持多会话管理。

- **AI 续写**：选中文本后自动续写，保持风格和语调一致
- **AI 优化**：智能优化文本表达，使其更加流畅、准确、易读
- **AI 校对**：自动检查并修正语法、拼写、标点和表达错误
- **AI 翻译**：支持中英文互译，自动识别语言类型

### 📄 多格式导入导出

支持导入 Word 文档，导出为 Word、PDF、Markdown 等格式，格式转换过程中尽可能保留原始样式和结构。

- **Word 导入**：支持 `.docx` 和 `.doc` 格式
- **Word 导出**：将编辑器内容导出为 Word 文档
- **PDF 导出**：将内容导出为 PDF 格式，适合打印和归档
- **Markdown 导出**：导出为 Markdown 格式，方便在其他平台使用

## 🚀 快速开始

### 安装

```bash
# 使用 npm
npm install

# 使用 pnpm
pnpm install

# 使用 yarn
yarn install
```

### 开发

```bash
npm run dev
```

### 构建

```bash
npm run build
```

## 📦 技术栈

- **Vue 3.4.0** - 渐进式 JavaScript 框架
- **WangEditor 5.1.23** - 富文本编辑器
- **火山引擎 AI 服务** - AI 能力支持
- **Vite 5.0.0** - 下一代前端构建工具

### 主要依赖

- `@wangeditor/editor` - 富文本编辑器核心
- `@wangeditor/editor-for-vue` - Vue 3 适配器
- `@vicons/ionicons5` - 图标库
- `marked` - Markdown 解析
- `docx` - Word 文档生成
- `mammoth` - Word 文档解析
- `html2pdf.js` - PDF 导出
- `turndown` - HTML 转 Markdown

## 🎯 核心功能

### AI 功能

1. **AI 续写**：选中文本后，AI 会根据上下文自动续写内容
2. **AI 优化**：智能优化文本表达，提升可读性
3. **AI 校对**：自动检查并修正文本错误
4. **AI 翻译**：支持中英文互译

### 编辑器功能

- 完整的富文本编辑功能（基于 wangEditor）
- 实时流式文本插入
- 选中文本高亮提示
- 悬停工具栏（Hoverbar）集成 AI 功能

### 对话助手

- 侧边栏智能对话助手
- 实时流式响应
- 对话历史自动保存
- 多会话管理
- Markdown 格式支持

### 文件处理

- Word 文档导入（.docx, .doc）
- Word 文档导出
- PDF 导出
- Markdown 导出

## 📖 使用说明

### 基本使用

```vue
<template>
  <Editor />
</template>

<script setup>
import Editor from '@/components/Editor.vue'
</script>
```

### AI 配置

在 `src/utils/aiConfig.js` 中配置 AI 服务：

```javascript
export default {
  conversations: [
    {
      name: 'chat',
      // AI 服务配置
    }
  ]
}
```

## 🤝 贡献

欢迎提交 Issue 和 Pull Request！

## 📄 许可证

本项目采用 MIT 许可证。

## 📮 联系方式

- **邮箱**：tydl@163.com
- **Gitee**：[https://gitee.com/tyerp/wangEditor-ai](https://gitee.com/tyerp/wangEditor-ai)

## 🙏 致谢

- [WangEditor](https://www.wangeditor.com/) - 强大的富文本编辑器
- [Vue.js](https://vuejs.org/) - 渐进式 JavaScript 框架
- [火山引擎](https://www.volcengine.com/) - AI 服务支持

---

<div align="center">

**© 2024 WangEditor AI | Made with ❤️ by @Tuoyu**

</div>