docs: standardize plugin READMEs and documentation rules

This commit is contained in:
fujie
2026-01-17 16:26:43 +08:00
parent 87e47fd4b2
commit 71bef146c8
23 changed files with 239 additions and 872 deletions

View File

@@ -2,9 +2,18 @@
快速将文本提炼为精美的学习记忆卡片,自动抽取标题、摘要、关键要点、标签和分类,适合复习与分享。
**作者:** [Fu-Jie](https://github.com/Fu-Jie/awesome-openwebui) | **版本:** 0.2.4 | **项目:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **许可证:** MIT
## 预览 📸
![闪记卡示例](flash_card_cn.png)
## 功能亮点
## 更新日志
### v0.2.4
- **输出优化**: 移除输出中的调试信息。
## 核心特性 🔑
- **一键生成**:输入任意文本,直接产出结构化卡片。
- **要点聚合**:自动提取 3-5 个记忆要点与 2-4 个标签。
@@ -12,7 +21,14 @@
- **渐进合并**:多次调用会将新卡片合并到同一 HTML 容器中;如需重置可启用清空选项。
- **状态提示**:实时推送“生成中/完成/错误”等状态与通知。
## 参数说明
## 使用方法 🛠️
1. **安装**: 在插件市场安装并启用“闪记卡”。
2. **配置**: 根据需要调整 Valves 设置(可选)。
3. **触发**: 将待整理的文本发送到聊天框。
4. **结果**: 等待状态提示,卡片将以 HTML 形式嵌入到最新消息中。
## 配置参数 (Valves) ⚙️
| 参数 | 说明 | 默认值 |
| ------------------- | ------------------------------------- | ------ |
@@ -23,34 +39,9 @@
| CLEAR_PREVIOUS_HTML | 是否清空旧的卡片 HTML否则合并追加 | false |
| MESSAGE_COUNT | 取最近 N 条消息生成卡片 | 1 |
## 使用步骤
## 故障排除 (Troubleshooting) ❓
1. 在插件市场安装并启用“闪记卡”
2. 将待整理的文本发送到聊天框(可多轮对话,受 MESSAGE_COUNT 控制)
3. 等待状态提示,卡片将以 HTML 形式嵌入到最新消息中
4. 若需重新生成,开启 CLEAR_PREVIOUS_HTML 或直接重发文本。
## 输出格式
- JSON 字段:`title``summary``key_points`3-5 条)、`tags`2-4 条)、`category`
- 前端呈现:单卡片带渐变主题、标签胶囊、要点列表,可连续追加多张卡片。
## 使用建议
- 文本过短会提醒补充,可先汇总再生成卡片。
- 长文本无需截断,直接生成;如需深度分析可先用其他工具精炼后再制作卡片。
## 作者
Fu-Jie
GitHub: [Fu-Jie/awesome-openwebui](https://github.com/Fu-Jie/awesome-openwebui)
## 许可证
MIT License
## 更新日志
### v0.2.4
- 移除输出中的调试信息
- **插件不工作?**: 请检查是否在模型设置中启用了该过滤器/动作
- **调试日志**: 在 Valves 中启用 `SHOW_STATUS` 以查看进度更新
- **错误信息**: 如果看到错误,请复制完整的错误信息并报告
- **提交 Issue**: 如果遇到任何问题,请在 GitHub 上提交 Issue[Awesome OpenWebUI Issues](https://github.com/Fu-Jie/awesome-openwebui/issues)