docs(readme): refresh plugin badge layout and mirrors
- update plugin README badge rows and mirrored docs - sync README template and scaffolder guidance Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
This commit is contained in:
fujie
@@ -1,88 +1,58 @@
|
||||
# Flash Card（闪记卡）
|
||||
# 闪记卡 (Flash Card)
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v0.2.4</span>
|
||||
快速将文本提炼为精美的学习记忆卡片，自动抽取标题、摘要、关键要点、标签和分类，适合复习与分享。
|
||||
|
||||
快速生成精美的学习记忆卡片，适合学习和速记。
|
||||
| 作者：[Fu-Jie](https://github.com/Fu-Jie) · v0.2.4 | [⭐ 点个 Star 支持项目](https://github.com/Fu-Jie/openwebui-extensions) |
|
||||
| :--- | ---: |
|
||||
|
||||
---
|
||||
|  |  |  |  |  |  |  |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
|
||||
## 概览
|
||||
## 🔥 最新更新 v0.2.4
|
||||
|
||||
Knowledge Card 插件（又名 Flash Card / 闪记卡）会把内容转成视觉友好的记忆卡片，帮助你高效学习和记忆。无论备考、理解新概念或复习要点，都能用它快速生成学习素材。
|
||||
* **输出优化**: 移除输出中的调试信息。
|
||||
|
||||
## 功能特性
|
||||
## 核心特性 🔑
|
||||
|
||||
- :material-card-text: **精美卡片**：现代简洁的版式，便于阅读
|
||||
- :material-animation-play: **可交互**：点击翻转查看答案
|
||||
- :material-export: **可导出**：支持保存离线学习
|
||||
- :material-palette: **可定制**：多种主题与样式
|
||||
- :material-translate: **多语言**：支持多语言内容
|
||||
* **一键生成**：输入任意文本，直接产出结构化卡片。
|
||||
* **要点聚合**：自动提取 3-5 个记忆要点与 2-4 个标签。
|
||||
* **多语言支持**：可设定目标语言（默认中文）。
|
||||
* **渐进合并**：多次调用会将新卡片合并到同一 HTML 容器中；如需重置可启用清空选项。
|
||||
* **状态提示**：实时推送“生成中/完成/错误”等状态与通知。
|
||||
|
||||
---
|
||||
## 使用方法 🛠️
|
||||
|
||||
## 安装
|
||||
1. **安装**: 在插件市场安装并启用“闪记卡”。
|
||||
2. **配置**: 根据需要调整 Valves 设置（可选）。
|
||||
3. **触发**: 将待整理的文本发送到聊天框。
|
||||
4. **结果**: 等待状态提示，卡片将以 HTML 形式嵌入到最新消息中。
|
||||
|
||||
1. 下载插件文件：[`flash_card.py`](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/actions/flash-card)
|
||||
2. 上传到 OpenWebUI：**Admin Panel** → **Settings** → **Functions**
|
||||
3. 启用插件
|
||||
## 配置参数 (Valves) ⚙️
|
||||
|
||||
---
|
||||
| 参数 | 说明 | 默认值 |
|
||||
| ------------------- | ------------------------------------- | ------ |
|
||||
| MODEL_ID | 指定推理模型；为空则使用当前会话模型 | 空 |
|
||||
| MIN_TEXT_LENGTH | 最小文本长度，不足时提示补充 | 50 |
|
||||
| LANGUAGE | 输出语言（如 zh、en） | zh |
|
||||
| SHOW_STATUS | 是否显示状态更新 | true |
|
||||
| CLEAR_PREVIOUS_HTML | 是否清空旧的卡片 HTML（否则合并追加） | false |
|
||||
| MESSAGE_COUNT | 取最近 N 条消息生成卡片 | 1 |
|
||||
|
||||
## 使用方法
|
||||
## ⭐ 支持
|
||||
|
||||
1. 与 AI 就你想学习的主题进行对话
|
||||
2. 点击消息操作栏的 **Flash Card** 按钮
|
||||
3. 插件会分析内容并生成卡片
|
||||
4. 点击卡片翻面查看答案
|
||||
如果这个插件对你有帮助，欢迎到 [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) 点个 Star，这将是我持续改进的动力，感谢支持。
|
||||
|
||||
---
|
||||
## 故障排除 (Troubleshooting) ❓
|
||||
|
||||
## 配置项
|
||||
* **插件不工作？**: 请检查是否在模型设置中启用了该过滤器/动作。
|
||||
* **调试日志**: 在 Valves 中启用 `SHOW_STATUS` 以查看进度更新。
|
||||
* **错误信息**: 如果看到错误，请复制完整的错误信息并报告。
|
||||
* **提交 Issue**: 如果遇到任何问题，请在 GitHub 上提交 Issue：[OpenWebUI Extensions Issues](https://github.com/Fu-Jie/openwebui-extensions/issues)
|
||||
|
||||
| 选项 | 类型 | 默认值 | 说明 |
|
||||
|--------|------|---------|-------------|
|
||||
| `cards_per_message` | integer | `5` | 每条消息最多生成的卡片数量 |
|
||||
| `theme` | string | `"modern"` | 视觉主题 |
|
||||
| `show_hints` | boolean | `true` | 是否在卡片上显示提示 |
|
||||
## 预览 📸
|
||||
|
||||
---
|
||||
|
||||
|
||||
## 示例
|
||||
## 更新日志
|
||||
|
||||
=== "问题面"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ What is the capital of │
|
||||
│ France? │
|
||||
│ │
|
||||
│ [Click to flip] │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
|
||||
=== "答案面"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ Paris │
|
||||
│ │
|
||||
│ The city of lights, │
|
||||
│ located on the Seine │
|
||||
│ │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 运行要求
|
||||
|
||||
!!! note "前置条件"
|
||||
- OpenWebUI v0.3.0 及以上
|
||||
- 无需额外 Python 依赖
|
||||
|
||||
---
|
||||
|
||||
## 源码
|
||||
|
||||
[:fontawesome-brands-github: 在 GitHub 查看](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/actions/flash-card){ .md-button }
|
||||
完整历史请查看 GitHub 项目： [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions)
|
||||
|
||||
Reference in New Issue
Block a user