Files
Fu-Jie_openwebui-extensions/plugins/actions/export_to_docx/README_CN.md
fujie 7fb5c243fa feat(export-to-word): add S3 object storage support
- Add boto3 direct download for S3/MinIO stored images
- Implement 6-level file fallback: DB → S3 → Local → URL → API → Attributes
- Sync S3 support to Chinese version (export_to_word_cn.py)
- Update version to 0.4.2
- Rewrite README.md and README_CN.md following standard format
- Update docs version numbers
- Add file storage access guidelines to copilot-instructions.md
2026-01-07 20:59:33 +08:00

4.3 KiB
Raw Blame History

📝 导出为 Word (增强版)

Author: Fu-Jie | Version: 0.4.2 | Project: Awesome OpenWebUI

将对话导出为 Word (.docx),支持代码语法高亮原生数学公式Mermaid 图表引用参考增强表格格式

🔥 v0.4.2 更新内容

  • S3 对象存储支持: 通过 boto3 直连 S3/MinIO绕过 API 层,导出速度更快。
  • 🔧 多级文件回退: 6 级文件获取机制(数据库 → S3 → 本地 → URL → API → 属性)。
  • 🛡️ 错误处理优化: 更完善的日志记录和错误提示,便于调试文件访问问题。

核心特性

  • 🚀 一键导出: 在聊天界面添加"导出为 Word"动作按钮。
  • 📄 Markdown 转换: 完整支持 Markdown 语法(标题、粗体、斜体、代码、表格、列表)。
  • 🎨 代码语法高亮: 使用 Pygments 库高亮代码块(支持 500+ 种语言)。
  • 🔢 原生数学公式: LaTeX 公式($$...$$\[...\]$...$)转换为可编辑的 Word 公式。
  • 📊 Mermaid 图表: 流程图和时序图渲染为文档中的图片。
  • 📚 引用与参考: 自动生成参考资料章节,支持可点击的引用链接。
  • 🧹 移除思考过程: 自动移除 AI 思考块(<think><analysis>)。
  • 📋 增强表格: 智能列宽、对齐、表头跨页重复。
  • 💬 引用块支持: Markdown 引用块渲染为带左侧边框的灰色斜体样式。
  • 🌐 多语言支持: 正确处理中文和英文文本。

🚀 使用方法

  1. 安装: 在 Open WebUI 社区搜索 "导出为 Word" 并安装。
  2. 触发: 在任意对话中,点击"导出为 Word"动作按钮。
  3. 下载: .docx 文件将自动下载到你的设备。

⚙️ 配置参数 (Valves)

参数 默认值 说明
文档标题来源 chat_title chat_title(对话标题)、ai_generatedAI 生成)、markdown_titleMarkdown 标题)
最大嵌入图片大小MB 20 嵌入图片的最大大小 (MB)
界面语言 zh en(英语)或 zh(中文)
英文字体 Calibri 英文字体名称
中文字体 SimSun 中文字体名称
代码字体 Consolas 代码块字体名称
表头背景色 F2F2F2 表头背景色(十六进制)
表格隔行背景色 FBFBFB 表格隔行背景色(十六进制)
Mermaid_PNG缩放比例 3.0 Mermaid 图片分辨率倍数
启用数学公式 True 启用 LaTeX 公式转换

🛠️ 支持的 Markdown 语法

语法 Word 效果
# 标题1###### 标题6 标题级别 1-6
**粗体**__粗体__ 粗体文本
*斜体*_斜体_ 斜体文本
`行内代码` 等宽字体 + 灰色背景
``` 代码块 ``` 语法高亮的代码块
> 引用文本 带左侧边框的灰色斜体文本
[链接](url) 蓝色下划线链接文本
~~删除线~~ 删除线文本
- 项目* 项目 无序列表
1. 项目 有序列表
Markdown 表格 增强表格(智能列宽)
$$LaTeX$$\[LaTeX\] 原生 Word 公式(块级)
$LaTeX$\(LaTeX\) 原生 Word 公式(行内)
```mermaid ... ``` Mermaid 图表(图片形式)
[1] 引用标记 可点击链接到参考资料

📦 依赖

  • python-docx==1.1.2 - Word 文档生成
  • Pygments>=2.15.0 - 语法高亮
  • latex2mathml - LaTeX 转 MathML
  • mathml2omml - MathML 转 Office Math (OMML)

📝 更新日志

v0.4.2

  • S3 对象存储: 通过 boto3 直连 S3/MinIO图片获取速度更快。
  • 6 级回退机制: 稳健的文件获取:数据库 → S3 → 本地 → URL → API → 属性。
  • 日志优化: 改进错误提示,便于调试文件访问问题。

v0.4.1

  • 中文参数名: 配置项名称和描述全部汉化。

v0.4.0

  • 多语言支持: 界面语言切换(中文/英文)。
  • 字体与样式配置: 支持自定义中英文字体、代码字体以及表格颜色。
  • Mermaid 增强: 混合 SVG+PNG 渲染,支持背景色配置。
  • 性能优化: 导出大型文档时提供实时进度反馈。