Skip to content

Commit ad2773e

Browse files
Fu-JieFu-Jie
committed
Update plugin documentation for various filters and actions
- Updated README.md and README_CN.md for the infographic plugin to reflect new features and bug fixes in version 1.5.0, including context-aware generation and language synchronization. - Revised README.md and README_CN.md for the smart mind map plugin to include support for user feedback and a changelog. - Enhanced README.md and README_CN.md for the async context compression filter with critical fixes and improved compatibility details. - Introduced initial release notes for the folder memory filter, detailing its core features and installation instructions. - Updated markdown normalizer documentation to synchronize version numbers and improve clarity on configuration options. - Revised GitHub Copilot SDK documentation to enhance installation instructions and troubleshooting sections, including a new changelog.
1 parent 7d4da3b commit ad2773e

22 files changed

Lines changed: 384 additions & 297 deletions

File tree

‎.github/copilot-instructions.md‎

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,15 @@ plugins/actions/export_to_docx/
4242
- 格式: `**Author:** [Fu-Jie](https://github.com/Fu-Jie) | **Version:** x.x.x | **Project:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)`
4343
- **注意**: Author 和 Project 为固定值，仅需更新 Version 版本号
4444
3. **描述 (Description)**: 一句话功能介绍
45-
4. **最新更新 (What's New)**: **必须**放在描述之后，显著展示最新版本的变更点 (仅展示最近 3 次更新)
45+
4. **最新更新 (What's New)**: **必须**放在描述之后，仅展示**最近 1 次**更新
4646
5. **核心特性 (Key Features)**: 使用 Emoji + 粗体标题 + 描述格式
4747
6. **使用方法 (How to Use)**: 按步骤说明
4848
7. **配置参数 (Configuration/Valves)**: 使用表格格式，包含参数名、默认值、描述
49-
8. **其他 (Others)**: 支持的模板类型、语法示例、故障排除等
49+
8. **支持 (Support)**: **必须**包含，放在配置参数之后、故障排除之前
50+
- English: `If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.`
51+
- 中文: `如果这个插件对你有帮助，欢迎到 [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) 点个 Star，这将是我持续改进的动力，感谢支持。`
52+
9. **其他 (Others)**: 支持的模板类型、语法示例、故障排除等
53+
- **Changelog**: 统一指向 GitHub 项目历史，不在 README 中列出具体变更
5054

5155
### 2. 插件目录结构 (Plugin Directory Structure)
5256

‎docs/PLUGIN_README_TEMPLATE.md‎

Lines changed: 10 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,9 +10,10 @@ The Chinese version (README_CN.md) MUST be translated based on this English vers
1010

1111
## What's New
1212

13-
<!-- Keep the changelog for the last 3 versions here. Remove this section for the initial release. -->
13+
<!-- Keep only the latest update here. Remove this section for the initial release. -->
1414

1515
### v1.0.0
16+
1617
- **Initial Release**: Released the first version of the plugin.
1718
- **[Feature Name]**: [Brief description of the feature].
1819

@@ -36,9 +37,17 @@ The Chinese version (README_CN.md) MUST be translated based on this English vers
3637
| `VALVE_NAME` | `Default Value` | Description of what this setting does. |
3738
| `ANOTHER_VALVE` | `True` | Another setting description. |
3839

40+
## ⭐ Support
41+
42+
If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.
43+
3944
## Troubleshooting ❓
4045

4146
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
4247
- **Debug Logs**: Enable `SHOW_DEBUG_LOG` in Valves and check the browser console (F12) for detailed logs.
4348
- **Error Messages**: If you see an error, please copy the full error message and report it.
4449
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
50+
51+
## Changelog
52+
53+
See the full history on GitHub: [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

‎plugins/actions/deep-dive/README.md‎

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@ A comprehensive thinking lens that dives deep into any content - from context to
3939
| **Clear Previous HTML (CLEAR_PREVIOUS_HTML)** | `True` | Whether to clear previous plugin results. |
4040
| **Message Count (MESSAGE_COUNT)** | `1` | Number of recent messages to analyze. |
4141

42+
## ⭐ Support
43+
44+
If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.
45+
4246
## 🌗 Theme Support
4347

4448
The plugin automatically detects and adapts to OpenWebUI's theme settings:
@@ -48,7 +52,7 @@ The plugin automatically detects and adapts to OpenWebUI's theme settings:
4852
2. Parent document `html/body` class or `data-theme` attribute
4953
3. System preference via `prefers-color-scheme: dark`
5054

51-
- **Requirements**: For best results, enable **iframe Sandbox Allow Same Origin** in OpenWebUI:
55+
- **Requirements**: For best results, enable **iframe Sandbox Allow Same Origin** in OpenWebUI:
5256
- Go to **Settings** → **Interface** → **Artifacts** → Check **iframe Sandbox Allow Same Origin**
5357

5458
## 🎨 Visual Preview
@@ -88,3 +92,7 @@ The plugin generates a structured thinking timeline:
8892
- **Debug Logs**: Enable `SHOW_STATUS` in Valves to see progress updates.
8993
- **Error Messages**: If you see an error, please copy the full error message and report it.
9094
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
95+
96+
## Changelog
97+
98+
See the full history on GitHub: [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

‎plugins/actions/deep-dive/README_CN.md‎

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -39,6 +39,10 @@
3939
| **清除旧 HTML (CLEAR_PREVIOUS_HTML)** | `True` | 是否清除之前的插件结果。 |
4040
| **消息数量 (MESSAGE_COUNT)** | `1` | 要分析的最近消息数量。 |
4141

42+
## ⭐ 支持
43+
44+
如果这个插件对你有帮助，欢迎到 [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) 点个 Star，这将是我持续改进的动力，感谢支持。
45+
4246
## 🌗 主题支持
4347

4448
插件会自动检测并适配 OpenWebUI 的主题设置：
@@ -88,3 +92,7 @@
8892
- **调试日志**: 在 Valves 中启用 `SHOW_STATUS` 以查看进度更新。
8993
- **错误信息**: 如果看到错误，请复制完整的错误信息并报告。
9094
- **提交 Issue**: 如果遇到任何问题，请在 GitHub 上提交 Issue：[Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
95+
96+
## 更新日志
97+
98+
完整历史请查看 GitHub 项目： [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

‎plugins/actions/export_to_docx/README.md‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ Export conversation to Word (.docx) with **syntax highlighting**, **native math
4444
| **Mermaid PNG Scale** | `3.0` | Resolution multiplier for Mermaid images |
4545
| **Math Enable** | `True` | Enable LaTeX math conversion |
4646

47+
## ⭐ Support
48+
49+
If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.
50+
4751
## 🛠️ Supported Markdown Syntax
4852

4953
| Syntax | Word Result |
@@ -71,25 +75,13 @@ Export conversation to Word (.docx) with **syntax highlighting**, **native math
7175
- `latex2mathml` - LaTeX to MathML conversion
7276
- `mathml2omml` - MathML to Office Math (OMML) conversion
7377

74-
## 📝 Changelog
75-
76-
### v0.4.3
77-
- **S3 Object Storage**: Direct S3/MinIO access via boto3 for faster image retrieval.
78-
- **6-Level Fallback**: Robust file retrieval: DB → S3 → Local → URL → API → Attributes.
79-
- **Better Logging**: Improved error messages for debugging file access issues.
80-
81-
### v0.4.1
82-
- **Chinese Parameter Names**: Localized configuration names for Chinese version.
83-
84-
### v0.4.0
85-
- **Multi-language Support**: UI language switching (English/Chinese).
86-
- **Font & Style Configuration**: Customizable fonts and table colors.
87-
- **Mermaid Enhancements**: Hybrid SVG+PNG rendering, background color config.
88-
- **Performance**: Real-time progress updates for large exports.
89-
9078
## Troubleshooting ❓
9179

9280
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
9381
- **Debug Logs**: Check the browser console (F12) for detailed logs if available.
9482
- **Error Messages**: If you see an error, please copy the full error message and report it.
9583
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
84+
85+
## 📝 Changelog
86+
87+
See the full history on GitHub: [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

‎plugins/actions/export_to_docx/README_CN.md‎

Lines changed: 8 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@
4444
| **Mermaid_PNG缩放比例** | `3.0` | Mermaid 图片分辨率倍数 |
4545
| **启用数学公式** | `True` | 启用 LaTeX 公式转换 |
4646

47+
## ⭐ 支持
48+
49+
如果这个插件对你有帮助，欢迎到 [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) 点个 Star，这将是我持续改进的动力，感谢支持。
50+
4751
## 🛠️ 支持的 Markdown 语法
4852

4953
| 语法 | Word 效果 |
@@ -71,25 +75,13 @@
7175
- `latex2mathml` - LaTeX 转 MathML
7276
- `mathml2omml` - MathML 转 Office Math (OMML)
7377

74-
## 📝 更新日志
75-
76-
### v0.4.3
77-
- **S3 对象存储**: 通过 boto3 直连 S3/MinIO，图片获取速度更快。
78-
- **6 级回退机制**: 稳健的文件获取：数据库 → S3 → 本地 → URL → API → 属性。
79-
- **日志优化**: 改进错误提示，便于调试文件访问问题。
80-
81-
### v0.4.1
82-
- **中文参数名**: 配置项名称和描述全部汉化。
83-
84-
### v0.4.0
85-
- **多语言支持**: 界面语言切换（中文/英文）。
86-
- **字体与样式配置**: 支持自定义中英文字体、代码字体以及表格颜色。
87-
- **Mermaid 增强**: 混合 SVG+PNG 渲染，支持背景色配置。
88-
- **性能优化**: 导出大型文档时提供实时进度反馈。
89-
9078
## 故障排除 (Troubleshooting) ❓
9179

9280
- **插件不工作？**: 请检查是否在模型设置中启用了该过滤器/动作。
9381
- **调试日志**: 请查看浏览器控制台 (F12) 获取详细日志（如果可用）。
9482
- **错误信息**: 如果看到错误，请复制完整的错误信息并报告。
9583
- **提交 Issue**: 如果遇到任何问题，请在 GitHub 上提交 Issue：[Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
84+
85+
## 📝 更新日志
86+
87+
完整历史请查看 GitHub 项目： [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

‎plugins/actions/export_to_excel/README.md‎

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,59 @@
1-
# Export to Excel
1+
# 📊 Export to Excel
2+
3+
**Author:** [Fu-Jie](https://github.com/Fu-Jie/awesome-openwebui) | **Version:** 0.3.6 | **Project:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **License:** MIT
4+
5+
Export chat history to an Excel (.xlsx) file directly from the chat interface.
6+
7+
## 🔥 What's New in v0.3.6
8+
9+
- **OpenWebUI-Style Theme**: Modern dark header (#1f2937) with light gray zebra striping for better readability.
10+
- **Zebra Striping**: Alternating row colors (#ffffff / #f3f4f6) for improved visual scanning.
11+
- **Smart Data Type Conversion**: Automatically converts columns to numeric or datetime types with fallback to string.
12+
- **Full Cell Bold/Italic**: Supports full cell Markdown bold (`**text**`) and italic (`*text*`) formatting in Excel.
13+
- **Partial Markdown Cleanup**: Removes partial Markdown formatting symbols for cleaner Excel output.
14+
- **Export Scope**: Added `EXPORT_SCOPE` to choose between the last message or all messages.
15+
- **Smart Sheet Naming**: Names sheets based on Markdown headers, AI titles, or message index.
16+
- **Multiple Tables Support**: Improved handling of multiple tables across messages.
17+
- **Smart Filename Generation**: Supports filenames based on chat title, AI summary, or Markdown headers.
18+
- **Configuration Options**: Added `TITLE_SOURCE` to control filename strategy.
19+
- **AI Title Generation**: Added `MODEL_ID` to use AI for filename generation with progress notifications.
20+
21+
## ✨ Core Features
22+
23+
- 🚀 **One-Click Export**: Adds an “Export to Excel” action button to the chat.
24+
- 🧠 **Automatic Header Extraction**: Intelligently identifies table headers from chat content.
25+
- 📊 **Multi-Table Support**: Handles multiple tables within a single chat session.
26+
27+
## 🚀 How to Use
28+
29+
1. **Install**: Search for “Export to Excel” in the Open WebUI Community and install.
30+
2. **Trigger**: In any chat, click the “Export to Excel” action button.
31+
3. **Download**: The .xlsx file will be automatically downloaded.
32+
33+
## ⚙️ Configuration (Valves)
34+
35+
| Parameter | Default | Description |
36+
| :--- | :--- | :--- |
37+
| `TITLE_SOURCE` | `chat_title` | Filename source: `chat_title`, `ai_generated`, or `markdown_title`. |
38+
| `EXPORT_SCOPE` | `last_message` | Export scope: `last_message` or `all_messages`. |
39+
| `MODEL_ID` | `""` | Model ID for AI title generation. Empty uses current chat model. |
40+
| `SHOW_STATUS` | `True` | Show operation status updates. |
41+
| `SHOW_DEBUG_LOG` | `False` | Print debug logs in the browser console (F12). |
42+
43+
## ⭐ Support
44+
45+
If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.
46+
47+
## Troubleshooting ❓
48+
49+
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
50+
- **Debug Logs**: Enable `SHOW_STATUS` and check the browser console (F12) if needed.
51+
- **Error Messages**: If you see an error, please copy the full error message and report it.
52+
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
53+
54+
## Changelog
55+
56+
See the full history on GitHub: [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)# Export to Excel
257

358
This plugin allows you to export your chat history to an Excel (.xlsx) file directly from the chat interface.
459

‎plugins/actions/export_to_excel/README_CN.md‎

Lines changed: 56 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,59 @@
1-
# 导出为 Excel
1+
# 📊 导出为 Excel
2+
3+
**作者:** [Fu-Jie](https://github.com/Fu-Jie/awesome-openwebui) | **版本:** 0.3.6 | **项目:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **许可证:** MIT
4+
5+
将对话历史直接导出为 Excel (.xlsx) 文件。
6+
7+
## 🔥 最新更新 v0.3.6
8+
9+
- **OpenWebUI 风格主题**：现代深灰表头（#1f2937）与浅灰斑马纹，提升可读性。
10+
- **斑马纹效果**：隔行变色（#ffffff / #f3f4f6），方便视觉扫描。
11+
- **智能数据类型转换**：自动将列转换为数字或日期类型，无法转换时保持字符串。
12+
- **全单元格粗体/斜体**：支持全单元格 Markdown 粗体与斜体格式。
13+
- **部分 Markdown 清理**：移除部分 Markdown 格式符号，输出更整洁。
14+
- **导出范围**：新增 `EXPORT_SCOPE`，可选择导出最后一条或所有消息。
15+
- **智能 Sheet 命名**：按 Markdown 标题、AI 标题或消息索引命名。
16+
- **多表格支持**：优化了多表格处理能力。
17+
- **智能文件名生成**：支持对话标题 / AI 总结 / Markdown 标题命名。
18+
- **配置选项**：新增 `TITLE_SOURCE` 控制文件名策略。
19+
- **AI 标题生成**：新增 `MODEL_ID`，支持 AI 标题生成与进度提示。
20+
21+
## ✨ 核心特性
22+
23+
- 🚀 **一键导出**：在聊天界面添加“导出为 Excel”按钮。
24+
- 🧠 **自动表头提取**：智能识别聊天内容中的表格标题。
25+
- 📊 **多表支持**：支持单次对话中的多个表格。
26+
27+
## 🚀 使用方法
28+
29+
1. **安装**：在 Open WebUI 社区搜索“导出为 Excel”并安装。
30+
2. **触发**：在任意对话中，点击“导出为 Excel”动作按钮。
31+
3. **下载**：.xlsx 文件将自动下载到你的设备。
32+
33+
## ⚙️ 配置参数 (Valves)
34+
35+
| 参数 | 默认值 | 描述 |
36+
| :--- | :--- | :--- |
37+
| `TITLE_SOURCE` | `chat_title` | 文件名来源：`chat_title`、`ai_generated`、`markdown_title`。 |
38+
| `EXPORT_SCOPE` | `last_message` | 导出范围：`last_message` 或 `all_messages`。 |
39+
| `MODEL_ID` | `""` | AI 标题生成的模型 ID。为空则使用当前对话模型。 |
40+
| `SHOW_STATUS` | `True` | 是否显示操作状态更新。 |
41+
| `SHOW_DEBUG_LOG` | `False` | 是否在浏览器控制台输出调试日志 (F12)。 |
42+
43+
## ⭐ 支持
44+
45+
如果这个插件对你有帮助，欢迎到 [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) 点个 Star，这将是我持续改进的动力，感谢支持。
46+
47+
## 故障排除 (Troubleshooting) ❓
48+
49+
- **插件不工作？**: 请检查是否在模型设置中启用了该过滤器/动作。
50+
- **调试日志**: 如需排查，启用 `SHOW_STATUS` 并查看浏览器控制台 (F12)。
51+
- **错误信息**: 如果看到错误，请复制完整的错误信息并报告。
52+
- **提交 Issue**: 如果遇到任何问题，请在 GitHub 上提交 Issue：[Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
53+
54+
## 更新日志
55+
56+
完整历史请查看 GitHub 项目： [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)# 导出为 Excel
257

358
此插件允许你直接从聊天界面将对话历史导出为 Excel (.xlsx) 文件。
459

‎plugins/actions/flash-card/README.md‎

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -4,13 +4,10 @@ Generate polished learning flashcards from any text—title, summary, key points
44

55
**Author:** [Fu-Jie](https://github.com/Fu-Jie/awesome-openwebui) | **Version:** 0.2.4 | **Project:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **License:** MIT
66

7-
## Preview 📸
8-
9-
![Flash Card Example](flash_card.png)
10-
117
## What's New
128

139
### v0.2.4
10+
1411
- **Clean Output**: Removed debug messages from output.
1512

1613
## Key Features 🔑
@@ -39,9 +36,21 @@ Generate polished learning flashcards from any text—title, summary, key points
3936
| CLEAR_PREVIOUS_HTML | Whether to clear previous card HTML (otherwise append/merge) | false |
4037
| MESSAGE_COUNT | Use the latest N messages to build the card | 1 |
4138

39+
## ⭐ Support
40+
41+
If this plugin has been useful, a star on [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) is a big motivation for me. Thank you for the support.
42+
4243
## Troubleshooting ❓
4344

4445
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
4546
- **Debug Logs**: Enable `SHOW_STATUS` in Valves to see progress updates.
4647
- **Error Messages**: If you see an error, please copy the full error message and report it.
4748
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)
49+
50+
## Preview 📸
51+
52+
![Flash Card Example](flash_card.png)
53+
54+
## Changelog
55+
56+
See the full history on GitHub: [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui)

0 commit comments

Comments
 (0)