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,60 @@
|
||||
# Flash Card
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v0.2.4</span>
|
||||
Generate polished learning flashcards from any text—title, summary, key points, tags, and category—ready for review and sharing.
|
||||
|
||||
Quickly generates beautiful flashcards from text, extracting key points and categories.
|
||||
| By [Fu-Jie](https://github.com/Fu-Jie) · v0.2.4 | [⭐ Star this repo](https://github.com/Fu-Jie/openwebui-extensions) |
|
||||
| :--- | ---: |
|
||||
|
||||
---
|
||||
|  |  |  |  |  |  |  |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
|
||||
## Overview
|
||||
## What's New
|
||||
|
||||
The Knowledge Card plugin (also known as Flash Card / 闪记卡) transforms content into visually appealing flashcards that are perfect for learning and memorization. Whether you're studying for exams, learning new concepts, or reviewing key points, this plugin helps you create effective study materials.
|
||||
### v0.2.4
|
||||
|
||||
## Features
|
||||
- **Clean Output**: Removed debug messages from output.
|
||||
|
||||
- :material-card-text: **Beautiful Cards**: Modern, clean design for easy reading
|
||||
- :material-animation-play: **Interactive**: Flip cards to reveal answers
|
||||
- :material-export: **Exportable**: Save cards for offline study
|
||||
- :material-palette: **Customizable**: Multiple themes and styles
|
||||
- :material-translate: **Multi-language**: Supports various languages
|
||||
## Key Features 🔑
|
||||
|
||||
---
|
||||
- **One-click generation**: Drop in text, get a structured card.
|
||||
- **Concise extraction**: 3–5 key points and 2–4 tags automatically surfaced.
|
||||
- **Multi-language**: Choose target language (default English).
|
||||
- **Progressive merge**: Multiple runs append cards into the same HTML container; enable clearing to reset.
|
||||
- **Status updates**: Live notifications for generating/done/error.
|
||||
|
||||
## Installation
|
||||
## How to Use 🛠️
|
||||
|
||||
1. Download the plugin file: [`flash_card.py`](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/actions/flash-card)
|
||||
2. Upload to OpenWebUI: **Admin Panel** → **Settings** → **Functions**
|
||||
3. Enable the plugin
|
||||
1. **Install**: Add the plugin to your OpenWebUI instance.
|
||||
2. **Configure**: Adjust settings in the Valves menu (optional).
|
||||
3. **Trigger**: Send text to the chat.
|
||||
4. **Result**: Watch status updates; the card HTML is embedded into the latest message.
|
||||
|
||||
---
|
||||
## Configuration (Valves) ⚙️
|
||||
|
||||
## Usage
|
||||
| Param | Description | Default |
|
||||
| ------------------- | ------------------------------------------------------------ | ------- |
|
||||
| MODEL_ID | Model to use; empty falls back to current session model | empty |
|
||||
| MIN_TEXT_LENGTH | Minimum text length; below this prompts for more text | 50 |
|
||||
| LANGUAGE | Output language (e.g., en, zh) | en |
|
||||
| SHOW_STATUS | Whether to show status updates | true |
|
||||
| CLEAR_PREVIOUS_HTML | Whether to clear previous card HTML (otherwise append/merge) | false |
|
||||
| MESSAGE_COUNT | Use the latest N messages to build the card | 1 |
|
||||
|
||||
1. Have a conversation about a topic you want to learn
|
||||
2. Click the **Flash Card** button in the message action bar
|
||||
3. The plugin will analyze the content and generate flashcards
|
||||
4. Click on cards to flip and reveal answers
|
||||
## ⭐ Support
|
||||
|
||||
---
|
||||
If this plugin has been useful, a star on [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions) is a big motivation for me. Thank you for the support.
|
||||
|
||||
## Configuration
|
||||
## Troubleshooting ❓
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `cards_per_message` | integer | `5` | Maximum cards to generate |
|
||||
| `theme` | string | `"modern"` | Visual theme |
|
||||
| `show_hints` | boolean | `true` | Include hints on cards |
|
||||
- **Plugin not working?**: Check if the filter/action is enabled in the model settings.
|
||||
- **Debug Logs**: Enable `SHOW_STATUS` in Valves to see progress updates.
|
||||
- **Error Messages**: If you see an error, please copy the full error message and report it.
|
||||
- **Submit an Issue**: If you encounter any problems, please submit an issue on GitHub: [OpenWebUI Extensions Issues](https://github.com/Fu-Jie/openwebui-extensions/issues)
|
||||
|
||||
---
|
||||
## Preview 📸
|
||||
|
||||
## Example
|
||||
|
||||
|
||||
=== "Question Side"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ What is the capital of │
|
||||
│ France? │
|
||||
│ │
|
||||
│ [Click to flip] │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
## Changelog
|
||||
|
||||
=== "Answer Side"
|
||||
```
|
||||
┌─────────────────────────────┐
|
||||
│ │
|
||||
│ Paris │
|
||||
│ │
|
||||
│ The city of lights, │
|
||||
│ located on the Seine │
|
||||
│ │
|
||||
└─────────────────────────────┘
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
!!! note "Prerequisites"
|
||||
- OpenWebUI v0.3.0 or later
|
||||
- No additional Python packages required
|
||||
|
||||
---
|
||||
|
||||
## Source Code
|
||||
|
||||
[:fontawesome-brands-github: View on GitHub](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/actions/flash-card){ .md-button }
|
||||
See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions)
|
||||
|
||||
Reference in New Issue
Block a user