fix: resolve mkdocs build warnings and broken links

2026-01-14 23:46:56 +08:00
parent ab0daba80d
commit 70a96d0754
12 changed files with 287 additions and 157 deletions
--- a/docs/development/plugin-guide.md
+++ b/docs/development/plugin-guide.md
@@ -7,10 +7,10 @@
 ## 📚 Table of Contents

 1. [Quick Start](#1-quick-start)
-2. [Core Concepts & SDK Details](#2-core-concepts--sdk-details)
+2. [Core Concepts & SDK Details](#2-core-concepts-sdk-details)
 3. [Deep Dive into Plugin Types](#3-deep-dive-into-plugin-types)
 4. [Advanced Development Patterns](#4-advanced-development-patterns)
-5. [Best Practices & Design Principles](#5-best-practices--design-principles)
+5. [Best Practices & Design Principles](#5-best-practices-design-principles)
 6. [Troubleshooting](#6-troubleshooting)

 ---
@@ -351,8 +351,7 @@ async def action(self, body, __event_call__, __metadata__, ...):

 #### Reference Implementations

- `plugins/actions/js-render-poc/infographic_markdown.py` - AntV Infographic + Data URL
- `plugins/actions/js-render-poc/js_render_poc.py` - Basic proof of concept
+- `plugins/actions/infographic/infographic.py` - Production-ready implementation using AntV + Data URL

 ---

--- a/docs/development/plugin-guide.zh.md
+++ b/docs/development/plugin-guide.zh.md
@@ -4,19 +4,19 @@

 ## 📚 目录

-1.  [插件开发快速入门](#1-插件开发快速入门)
-2.  [核心概念与 SDK 详解](#2-核心概念与-sdk-详解)
-3.  [插件类型深度解析](#3-插件类型深度解析)
-    *   [Action (动作)](#31-action-动作)
-    *   [Filter (过滤器)](#32-filter-过滤器)
-    *   [Pipe (管道)](#33-pipe-管道)
-4.  [高级开发模式](#4-高级开发模式)
-5.  [最佳实践与设计原则](#5-最佳实践与设计原则)
-6.  [故障排查](#6-故障排查)
+1.  [插件开发快速入门](#1-quick-start)
+2.  [核心概念与 SDK 详解](#2-core-concepts-sdk-details)
+3.  [插件类型深度解析](#3-plugin-types)
+    *   [Action (动作)](#31-action)
+    *   [Filter (过滤器)](#32-filter)
+    *   [Pipe (管道)](#33-pipe)
+4.  [高级开发模式](#4-advanced-patterns)
+5.  [最佳实践与设计原则](#5-best-practices)
+6.  [故障排查](#6-troubleshooting)

 ---

-## 1. 插件开发快速入门
+## 1. 插件开发快速入门 {: #1-quick-start }

 ### 1.1 什么是 OpenWebUI 插件？

@@ -64,7 +64,7 @@ class Action:

 ---

-## 2. 核心概念与 SDK 详解
+## 2. 核心概念与 SDK 详解 {: #2-core-concepts-sdk-details }

 ### 2.1 ⚠️ 重要：同步与异步

@@ -107,9 +107,9 @@ class Filter:

 ---

-## 3. 插件类型深度解析
+## 3. 插件类型深度解析 {: #3-plugin-types }

-### 3.1 Action (动作)
+### 3.1 Action (动作) {: #31-action }

 **定位**：在消息下方添加按钮，用户点击触发。

@@ -134,7 +134,7 @@ async def action(self, body, __event_call__):
    await __event_call__({"type": "execute", "data": {"code": js}})
 ```

-### 3.2 Filter (过滤器)
+### 3.2 Filter (过滤器) {: #32-filter }

 **定位**：中间件，拦截并修改请求/响应。

@@ -155,7 +155,7 @@ async def inlet(self, body, __metadata__):
    return body
 ```

-### 3.3 Pipe (管道)
+### 3.3 Pipe (管道) {: #33-pipe }

 **定位**：自定义模型/代理。

@@ -177,7 +177,7 @@ class Pipe:

 ---

-## 4. 高级开发模式
+## 4. 高级开发模式 {: #4-advanced-patterns }

 ### 4.1 Pipe 与 Filter 协同
 利用 `__request__.app.state` 在不同插件间共享数据。
@@ -315,10 +315,9 @@ async def action(self, body, __event_call__, __metadata__, ...):

 #### 参考实现

- `plugins/actions/js-render-poc/infographic_markdown.py` - AntV 信息图 + Data URL
- `plugins/actions/js-render-poc/js_render_poc.py` - 基础概念验证
+- `plugins/actions/infographic/infographic.py` - 基于 AntV + Data URL 的生产级实现

-## 5. 最佳实践与设计原则
+## 5. 最佳实践与设计原则 {: #5-best-practices }

 ### 5.1 命名与定位
 *   **简短有力**：如 "闪记卡", "精读"。避免 "文本分析助手" 这种泛词。
@@ -344,7 +343,7 @@ except Exception as e:

 ---

-## 6. 故障排查
+## 6. 故障排查 {: #6-troubleshooting }

 *   **HTML 不显示？** 确保包裹在 ` ```html ... ``` ` 代码块中。
 *   **数据库报错？** 检查是否在 `async` 函数中直接调用了同步的 DB 方法，请使用 `asyncio.to_thread`。
--- a/docs/index.md
+++ b/docs/index.md
@@ -73,13 +73,13 @@ hide:

    [:octicons-arrow-right-24: Learn More](plugins/actions/smart-mind-map.md)

-   :material-card-text:{ .lg .middle } **Knowledge Card**
+-   :material-card-text:{ .lg .middle } **Flash Card**

    ---

-    Quickly generates beautiful learning memory cards, perfect for studying and quick memorization.
+    Quickly generates beautiful flashcards from text, extracting key points and categories.

-    [:octicons-arrow-right-24: Learn More](plugins/actions/knowledge-card.md)
+    [:octicons-arrow-right-24: Learn More](plugins/actions/flash-card.md)

 -   :material-arrow-collapse-vertical:{ .lg .middle } **Async Context Compression**

--- a/docs/index.zh.md
+++ b/docs/index.zh.md
@@ -73,13 +73,13 @@ hide:

    [:octicons-arrow-right-24: 了解更多](plugins/actions/smart-mind-map.md)

-   :material-card-text:{ .lg .middle } **知识卡片**
+-   :material-card-text:{ .lg .middle } **Flash Card（闪记卡）**

    ---

    快速生成精美的学习记忆卡片，非常适合学习和快速记忆。

-    [:octicons-arrow-right-24: 了解更多](plugins/actions/knowledge-card.md)
+    [:octicons-arrow-right-24: 了解更多](plugins/actions/flash-card.md)

 -   :material-arrow-collapse-vertical:{ .lg .middle } **异步上下文压缩**

--- a/docs/plugins/actions/index.zh.md
+++ b/docs/plugins/actions/index.zh.md
@@ -37,15 +37,15 @@ Actions 是交互式插件，能够：

    [:octicons-arrow-right-24: 查看文档](smart-infographic.md)

-   :material-card-text:{ .lg .middle } **Knowledge Card**
+-   :material-card-text:{ .lg .middle } **Flash Card（闪记卡）**

    ---

-    快速生成精美的学习记忆卡片，适合学习与记忆。
+    快速生成精美的学习记忆卡片，非常适合学习和快速记忆。

-    **版本：** 0.2.2
+    **版本：** 0.2.4

-    [:octicons-arrow-right-24: 查看文档](knowledge-card.md)
+    [:octicons-arrow-right-24: 查看文档](flash-card.md)

 -   :material-file-excel:{ .lg .middle } **Export to Excel**

@@ -77,15 +77,7 @@ Actions 是交互式插件，能够：

    [:octicons-arrow-right-24: 查看文档](deep-dive.zh.md)

-   :material-image-text:{ .lg .middle } **信息图转 Markdown**

-    ---
-
-    AI 驱动的信息图生成器，渲染 SVG 并以 Markdown Data URL 图片嵌入。
-
-    **版本：** 1.0.0
-
-    [:octicons-arrow-right-24: 查看文档](infographic-markdown.zh.md)

 </div>

--- a/docs/plugins/filters/index.zh.md
+++ b/docs/plugins/filters/index.zh.md
@@ -36,15 +36,7 @@ Filter 充当消息管线中的中间件：

    [:octicons-arrow-right-24: 查看文档](context-enhancement.md)

-   :material-google:{ .lg .middle } **Gemini Manifold Companion**

-    ---
-
-    Gemini Manifold Pipe 插件的伴随过滤器。
-
-    **版本：** 1.7.0
-
-    [:octicons-arrow-right-24: 查看文档](gemini-manifold-companion.md)

 -   :material-format-paint:{ .lg .middle } **Markdown Normalizer**

--- a/docs/plugins/index.md
+++ b/docs/plugins/index.md
@@ -48,15 +48,15 @@ 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.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 |
-| [Export to Word](actions/export-to-word.md) | Action | Export chat content to Word (.docx) with formatting | 0.1.0 |
-| [Async Context Compression](filters/async-context-compression.md) | Filter | Intelligent context compression | 1.0.0 |
-| [Context Enhancement](filters/context-enhancement.md) | Filter | Enhance chat context | 1.0.0 |
-| [Gemini Manifold Companion](filters/gemini-manifold-companion.md) | Filter | Companion for Gemini Manifold | 1.0.0 |
-| [Gemini Manifold](pipes/gemini-manifold.md) | Pipe | Gemini model integration | 1.0.0 |
+| [Smart Mind Map](actions/smart-mind-map.md) | Action | Generate interactive mind maps from text | 0.9.1 |
+| [Smart Infographic](actions/smart-infographic.md) | Action | Transform text into professional infographics | 1.4.9 |
+| [Flash Card](actions/flash-card.md) | Action | Create beautiful learning flashcards | 0.2.4 |
+| [Export to Excel](actions/export-to-excel.md) | Action | Export chat history to Excel files | 0.3.7 |
+| [Export to Word](actions/export-to-word.md) | Action | Export chat content to Word (.docx) with formatting | 0.4.3 |
+| [Async Context Compression](filters/async-context-compression.md) | Filter | Intelligent context compression | 1.1.3 |
+| [Context Enhancement](filters/context-enhancement.md) | Filter | Enhance chat context | 0.3.0 |
+| [Multi-Model Context Merger](filters/multi-model-context-merger.md) | Filter | Merge context from multiple models | 0.1.0 |
+| [Web Gemini Multimodal Filter](filters/web-gemini-multimodel.md) | Filter | Multimodal capabilities for any model | 0.3.2 |
 | [MoE Prompt Refiner](pipelines/moe-prompt-refiner.md) | Pipeline | Multi-model prompt refinement | 1.0.0 |

 ---
--- a/docs/plugins/index.zh.md
+++ b/docs/plugins/index.zh.md
@@ -48,15 +48,15 @@ OpenWebUI 支持四种类型的插件，每种都有不同的用途：

 | 插件 | 类型 | 描述 | 版本 |
 |--------|------|-------------|---------|
-| [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 |
-| [Export to Word（导出为 Word）](actions/export-to-word.md) | Action | 将聊天内容导出为 Word (.docx) 并保留格式 | 0.1.0 |
-| [Async Context Compression（异步上下文压缩）](filters/async-context-compression.md) | Filter | 智能上下文压缩 | 1.0.0 |
-| [Context Enhancement（上下文增强）](filters/context-enhancement.md) | Filter | 提升对话上下文 | 1.0.0 |
-| [Gemini Manifold Companion](filters/gemini-manifold-companion.md) | Filter | Gemini Manifold 伴侣 | 1.0.0 |
-| [Gemini Manifold](pipes/gemini-manifold.md) | Pipe | Gemini 模型集成 | 1.0.0 |
+| [Smart Mind Map（智能思维导图）](actions/smart-mind-map.md) | Action | 从文本生成交互式思维导图 | 0.9.1 |
+| [Smart Infographic（智能信息图）](actions/smart-infographic.md) | Action | 将文本转成专业信息图 | 1.4.9 |
+| [Flash Card（闪记卡）](actions/flash-card.md) | Action | 生成精美学习卡片 | 0.2.4 |
+| [Export to Excel（导出到 Excel）](actions/export-to-excel.md) | Action | 导出聊天记录为 Excel | 0.3.7 |
+| [Export to Word（导出为 Word）](actions/export-to-word.md) | Action | 将聊天内容导出为 Word (.docx) 并保留格式 | 0.4.3 |
+| [Async Context Compression（异步上下文压缩）](filters/async-context-compression.md) | Filter | 智能上下文压缩 | 1.1.3 |
+| [Context Enhancement（上下文增强）](filters/context-enhancement.md) | Filter | 提升对话上下文 | 0.3.0 |
+| [Multi-Model Context Merger（多模型上下文合并）](filters/multi-model-context-merger.md) | Filter | 合并多个模型的上下文 | 0.1.0 |
+| [Web Gemini Multimodal Filter（Web Gemini 多模态过滤器）](filters/web-gemini-multimodel.md) | Filter | 为任何模型提供多模态能力 | 0.3.2 |
 | [MoE Prompt Refiner](pipelines/moe-prompt-refiner.md) | Pipeline | 多模型提示词优化 | 1.0.0 |

 ---
--- a/docs/plugins/pipes/index.zh.md
+++ b/docs/plugins/pipes/index.zh.md
@@ -15,19 +15,7 @@ Pipes 可以用于：

 ## 可用的 Pipe 插件

-<div class="grid cards" markdown>

-   :material-google:{ .lg .middle } **Gemini Manifold**
-
-    ---
-
-    面向 Google Gemini 的集成流水线，支持完整流式返回。
-
-    **版本：** 1.0.0
-
-    [:octicons-arrow-right-24: 查看文档](gemini-manifold.md)
-
-</div>

 ---