open-webui/Fu-Jie_openwebui-extensions
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Merge pull request #9 from Fu-Jie/copilot/update-github-pages-documentation

Browse Source 
Update Smart Mind Map docs to v0.8.0 and reflect latest features
This commit is contained in:
Jeff
2025-12-31 03:27:06 +08:00
committed by GitHub
parent 6bae24ab74 11ac26351a
commit 27186aee1a
7 changed files with 71 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

16
docs/examples/action_plugin_smart_mind_map_example_cn.md
View File

@@ -27,7 +27,7 @@ Open WebUI 通过文件顶部的特定格式注释来识别和展示插件信息
"""
title: 思维导图
icon_url: data:image/svg+xml;base64,PHN2ZyB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciIHdpZHRoPSIyNCIgaGVpZ2h0PSIyNCIgdmlld0JveD0iMCAwIDI0IDI0IiBmaWxsPSJub25lIiBzdHJva2U9ImN1cnJlbnRDb2xvciIgc3Ryb2tlLXdpZHRoPSIxLjUiIHN0cm9rZS1saW5lY2FwPSJyb3VuZCIgc3Ryb2tlLWxpbmVqb2luPSJyb3VuZCI+CiAgPGNpcmNsZSBjeD0iMTIiIGN5PSIxMiIgcj0iMyIgZmlsbD0iY3VycmVudENvbG9yIi8+CiAgPGxpbmUgeDE9IjEyIiB5MT0iOSIgeDI9IjEyIiB5Mj0iNCIvPgogIDxjaXJjbGUgY3g9IjEyIiBjeT0iMyIgcj0iMS41Ii8+CiAgPGxpbmUgeDE9IjEyIiB5MT0iMTUiIHgyPSIxMiIgeTI9IjIwIi8+CiAgPGNpcmNsZSBjeD0iMTIiIGN5PSIyMSIgcj0iMS41Ii8+CiAgPGxpbmUgeDE9IjkiIHkxPSIxMiIgeDI9IjQiIHkyPSIxMiIvPgogIDxjaXJjbGUgY3g9IjMiIGN5PSIxMiIgcj0iMS41Ii8+CiAgPGxpbmUgeDE9IjE1IiB5MT0iMTIiIHgyPSIyMCIgeTI9IjEyIi8+CiAgPGNpcmNsZSBjeD0iMjEiIGN5PSIxMiIgcj0iMS41Ii8+CiAgPGxpbmUgeDE9IjEwLjUiIHkxPSྡ1LjUiIHgyPSI2IiB5Mj0iNiIvPgogIDxjaXJjbGUgY3g9IjUiIGN5PSI1Iigcj0iMS41Ii8+CiAgPGxpbmUgeDE9IjEzLjUiIHkxPSྡ5LjUgeDI9IjE1IiB5Mj0iNiIvPgogIDxjaXJjbGUgY3g9IjE5IiBjeT0iNSIgcj0iMS41Ii8+CiAgPGxpbmUgeDE9ྡ1LjUgeTE9ྡ3MuNSB4Mj0iNiIgeTI9IjE4Ii8+CiAgPGNpcmNsZSBjeD0iNSIgY3k9IjE5IiByPSྡ1LjUiLz4KICA8bGluZSB4MT0ྡzIuNSB5MT0ྡzIuNSB4Mj0iNSIgeTI9IjE4Ii8+CiAgPGNpcmNsZSBjeD0ྡ5IiBjeT0ྡ5IiByPSྡ1LjUiLz4KPC9zdmc+Cg==
version: 0.7.2
version: 0.8.0
description: 智能分析文本内容,生成交互式思维导图,帮助用户结构化和可视化知识。
"""
```
@@ -50,16 +50,22 @@ description: 智能分析文本内容,生成交互式思维导图,帮助用户
```python
class Action:
class Valves(BaseModel):
show_status: bool = Field(
SHOW_STATUS: bool = Field(
default=True, description="是否在聊天界面显示操作状态更新。"
)
LLM_MODEL_ID: str = Field(
default="gemini-2.5-flash",
description="用于文本分析的内置LLM模型ID。",
MODEL_ID: str = Field(
default="",
description="用于文本分析的内置 LLM 模型 ID（留空使用当前对话模型）。",
)
MIN_TEXT_LENGTH: int = Field(
default=100, description="进行思维导图分析所需的最小文本长度(字符数)。"
)
CLEAR_PREVIOUS_HTML: bool = Field(
default=False, description="生成新导图时是否清理之前的插件输出。"
)
MESSAGE_COUNT: int = Field(
default=1, description="用于生成的最近消息数量（1-5）。"
)
def __init__(self):
self.valves = self.Valves()

2
docs/plugins/actions/index.md
View File

@@ -23,7 +23,7 @@ Actions are interactive plugins that:
Intelligently analyzes text content and generates interactive mind maps with beautiful visualizations.
**Version:** 0.7.2
**Version:** 0.8.0
[:octicons-arrow-right-24: Documentation](smart-mind-map.md)

2
docs/plugins/actions/index.zh.md
View File

@@ -23,7 +23,7 @@ Actions 是交互式插件，能够：
智能分析文本并生成交互式、精美的思维导图。
**版本：** 0.7.2
**版本：** 0.8.0
[:octicons-arrow-right-24: 查看文档](smart-mind-map.md)

50
docs/plugins/actions/smart-mind-map.md
View File

@@ -1,7 +1,7 @@
# Smart Mind Map
<span class="category-badge action">Action</span>
<span class="version-badge">v0.7.2</span>
<span class="version-badge">v0.8.0</span>
Intelligently analyzes text content and generates interactive mind maps for better visualization and understanding.
@@ -13,31 +13,31 @@ The Smart Mind Map plugin transforms text content into beautiful, interactive mi
## Features
- :material-brain: **AI-Powered Analysis**: Intelligently extracts key concepts and relationships
- :material-gesture-swipe: **Interactive Navigation**: Zoom, pan, and explore the mind map
- :material-palette: **Beautiful Styling**: Modern design with customizable colors
- :material-download: **Export Options**: Save as image or structured data
- :material-translate: **Multi-language Support**: Works with multiple languages
- :material-brain: **LLM Analysis**: Uses configurable models to extract key concepts and hierarchy
- :material-gesture-swipe: **Rich Controls**: Zoom, reset view, expand level selector (All/2/3) and fullscreen
- :material-palette: **Theme Aware**: Auto-detects OpenWebUI light/dark theme with manual toggle
- :material-download: **One-Click Export**: Download high-res PNG, copy SVG, or copy Markdown source
- :material-translate: **Multi-language**: Adapts output language to the user context
---
## Installation
1. Download the plugin file: [`smart_mind_map.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map)
2. Upload to OpenWebUI: **Admin Panel** → **Settings** → **Functions**
3. Enable the plugin
1. Download the plugin file: [`思维导图.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map)
2. Upload to OpenWebUI: **Admin Panel** → **Settings** → **Functions** (Actions)
3. Enable the plugin, and optionally allow iframe same-origin access so theme auto-detection works
---
## Usage
1. Start a conversation and get a response from the AI
2. Click the **Mind Map** button in the message action bar
3. Wait for the mind map to generate
4. Interact with the visualization:
- **Zoom**: Scroll to zoom in/out
- **Pan**: Click and drag to move around
- **Expand/Collapse**: Click nodes to show/hide children
1. Enable **Smart Mind Map** in chat settings, then provide at least ~100 characters of text
2. Click the **Mind Map** action button on a message to trigger generation
3. Interact with the visualization:
- **Zoom & Reset**: Scroll or use the + / - / ↻ controls
- **Expand Levels**: Switch between All / 2 / 3 levels
- **Theme & Fullscreen**: Toggle light/dark or enter fullscreen
4. Export with one click: **PNG**, **Copy SVG**, or **Copy Markdown**
---
@@ -45,9 +45,11 @@ The Smart Mind Map plugin transforms text content into beautiful, interactive mi
| Option | Type | Default | Description |
|--------|------|---------|-------------|
| `show_status` | boolean | `true` | Show processing status updates |
| `max_depth` | integer | `5` | Maximum depth of the mind map |
| `theme` | string | `"default"` | Color theme for the visualization |
| `SHOW_STATUS` | boolean | `true` | Show status updates in chat during processing |
| `MODEL_ID` | string | `""` | Built-in LLM ID for analysis (empty uses current chat model) |
| `MIN_TEXT_LENGTH` | integer | `100` | Minimum characters required before analysis runs |
| `CLEAR_PREVIOUS_HTML` | boolean | `false` | Clear previous plugin HTML instead of merging |
| `MESSAGE_COUNT` | integer | `1` | Number of recent messages to include (1–5) |
---
@@ -73,16 +75,20 @@ The plugin generates an interactive HTML mind map embedded in the chat:
!!! note "Prerequisites"
- OpenWebUI v0.3.0 or later
- No additional Python packages required
- For theme auto-detection/PNG export accuracy, allow iframe same-origin access in **User Settings → Interface → Artifacts**
---
## Troubleshooting
??? question "Mind map is not displaying?"
Ensure your browser supports HTML5 Canvas and JavaScript is enabled.
- Ensure the input text is at least `MIN_TEXT_LENGTH` characters
- Confirm a valid `MODEL_ID` is available (or leave empty to use current model)
- Refresh and re-run after enabling the plugin
??? question "Generation takes too long?"
For very long texts, the AI analysis may take more time. Consider breaking down the content into smaller sections.
??? question "Theme looks wrong or PNG export is blank?"
- Enable iframe same-origin access so the plugin can read the parent theme
- Wait for the mind map to fully render before exporting
---

50
docs/plugins/actions/smart-mind-map.zh.md
View File

@@ -1,7 +1,7 @@
# Smart Mind Map（智能思维导图）
<span class="category-badge action">Action</span>
<span class="version-badge">v0.7.2</span>
<span class="version-badge">v0.8.0</span>
智能分析文本内容，生成交互式思维导图，帮助你更直观地理解信息结构。
@@ -13,31 +13,31 @@ Smart Mind Map 会将文本转换成漂亮的交互式思维导图。插件会
## 功能特性
- :material-brain: **AI 分析**：智能提取关键概念与关联关系
- :material-gesture-swipe: **交互导航**：支持缩放、平移、展开/折叠
- :material-palette: **精美样式**：现代化配色，支持自定义主题
- :material-download: **导出**：可保存为图片或结构化数据
- :material-translate: **多语言**：支持多语言文本分析
- :material-brain: **LLM 分析**：可配置模型，提取核心概念与层级
- :material-gesture-swipe: **丰富控制**：缩放/重置、展开层级（全部/2/3 级）与全屏
- :material-palette: **主题感知**：自动检测 OpenWebUI 亮/暗色主题并支持手动切换
- :material-download: **一键导出**：下载高分辨率 PNG、复制 SVG 或 Markdown
- :material-translate: **多语言**：根据用户语言自动输出
---
## 安装
1. 下载插件文件：[`smart_mind_map.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map)
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
3. 启用插件
1. 下载插件文件：[`思维导图.py`](https://github.com/Fu-Jie/awesome-openwebui/tree/main/plugins/actions/smart-mind-map)
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**（Actions）
3. 启用插件，并可在设置中允许 iframe same-origin 以启用主题自动检测
---
## 使用方法
1. 先与 AI 对话并生成回复
2. 点击消息操作栏中的 **Mind Map** 按钮
3. 等待思维导图生成
4. 交互使用：
- **缩放**：滚轮缩放
- **平移**：按住拖动
- **展开/折叠**：点击节点显示或隐藏子节点
1. 在聊天设置中启用 **Smart Mind Map**，提供不少于约 100 字符的文本
2. 点击消息操作栏中的 **Mind Map** 动作按钮触发生成
3. 交互使用：
- **缩放与重置**：滚轮或使用 + / - / ↻ 控制
- **展开层级**：切换“全部 / 2 级 / 3 级”
- **主题与全屏**：手动切换亮/暗色或进入全屏
4. 一键导出：**PNG**、**复制 SVG**、**复制 Markdown**
---
@@ -45,9 +45,11 @@ Smart Mind Map 会将文本转换成漂亮的交互式思维导图。插件会
| 选项 | 类型 | 默认值 | 说明 |
|--------|------|---------|-------------|
| `show_status` | boolean | `true` | 是否显示处理状态更新 |
| `max_depth` | integer | `5` | 思维导图的最大层级 |
| `theme` | string | `"default"` | 可视化的主题配色 |
| `SHOW_STATUS` | boolean | `true` | 是否在聊天中显示状态更新 |
| `MODEL_ID` | string | `""` | 内置 LLM 模型 ID（留空使用当前聊天模型） |
| `MIN_TEXT_LENGTH` | integer | `100` | 开始分析所需的最少字符数 |
| `CLEAR_PREVIOUS_HTML` | boolean | `false` | 生成新导图时是否清除之前的插件 HTML |
| `MESSAGE_COUNT` | integer | `1` | 用于生成的最近消息数量（1–5） |
---
@@ -73,16 +75,20 @@ Smart Mind Map 会将文本转换成漂亮的交互式思维导图。插件会
!!! note "前置条件"
- OpenWebUI v0.3.0 及以上
- 无需额外 Python 依赖
- 如需自动匹配主题/提高 PNG 导出准确性，请在 **User Settings → Interface → Artifacts** 中允许 iframe same-origin 访问
---
## 常见问题
??? question "思维导图不显示？"
请确认浏览器支持 HTML5 Canvas，并且已开启 JavaScript。
- 确认输入文本达到 `MIN_TEXT_LENGTH`
- 确保已配置可用的 `MODEL_ID`（或留空使用当前模型）
- 启用插件后刷新页面再试
??? question "生成时间过长？"
对超长文本，AI 分析会更耗时。建议拆分内容后再生成。
??? question "主题不匹配或 PNG 为空白？"
- 在设置中开启 iframe same-origin 以读取父页面主题
- 等待导图完全渲染后再导出
---

2
docs/plugins/index.md
View File

@@ -48,7 +48,7 @@ OpenWebUI supports four types of plugins, each serving a different purpose:
| Plugin | Type | Description | Version |
|--------|------|-------------|---------|
| [Smart Mind Map](actions/smart-mind-map.md) | Action | Generate interactive mind maps from text | 0.7.2 |
| [Smart Mind Map](actions/smart-mind-map.md) | Action | Generate interactive mind maps from text | 0.8.0 |
| [Smart Infographic](actions/smart-infographic.md) | Action | Transform text into professional infographics | 1.0.0 |
| [Knowledge Card](actions/knowledge-card.md) | Action | Create beautiful learning flashcards | 0.2.0 |
| [Export to Excel](actions/export-to-excel.md) | Action | Export chat history to Excel files | 1.0.0 |

2
docs/plugins/index.zh.md
View File

@@ -48,7 +48,7 @@ OpenWebUI 支持四种类型的插件，每种都有不同的用途：
| 插件 | 类型 | 描述 | 版本 |
|--------|------|-------------|---------|
| [Smart Mind Map（智能思维导图）](actions/smart-mind-map.md) | Action | 从文本生成交互式思维导图 | 0.7.2 |
| [Smart Mind Map（智能思维导图）](actions/smart-mind-map.md) | Action | 从文本生成交互式思维导图 | 0.8.0 |
| [Smart Infographic（智能信息图）](actions/smart-infographic.md) | Action | 将文本转成专业信息图 | 1.0.0 |
| [Knowledge Card（知识卡片）](actions/knowledge-card.md) | Action | 生成精美学习卡片 | 0.2.0 |
| [Export to Excel（导出到 Excel）](actions/export-to-excel.md) | Action | 导出聊天记录为 Excel | 1.0.0 |