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,101 +1,81 @@
|
||||
# Smart Mind Map
|
||||
# Smart Mind Map - Mind Mapping Generation Plugin
|
||||
|
||||
<span class="category-badge action">Action</span>
|
||||
<span class="version-badge">v1.0.0</span>
|
||||
Smart Mind Map is a powerful OpenWebUI action plugin that intelligently analyzes long-form text content and automatically generates interactive mind maps, helping users structure and visualize knowledge.
|
||||
|
||||
Intelligently analyzes text content and generates interactive mind maps for better visualization and understanding.
|
||||
| By [Fu-Jie](https://github.com/Fu-Jie) · v1.0.0 | [⭐ Star this repo](https://github.com/Fu-Jie/openwebui-extensions) |
|
||||
| :--- | ---: |
|
||||
|
||||
> 🏆 **Featured by OpenWebUI Official** — Recommended in the official OpenWebUI Community Newsletter: [February 3, 2026](https://openwebui.com/blog/open-webui-community-newsletter-february-3rd-2026)
|
||||
|  |  |  |  |  |  |  |
|
||||
| :---: | :---: | :---: | :---: | :---: | :---: | :---: |
|
||||
|
||||
> 🏆 **Featured by OpenWebUI Official** — This plugin was recommended in the official OpenWebUI Community Newsletter: [February 3, 2026](https://openwebui.com/blog/open-webui-community-newsletter-february-3rd-2026)
|
||||
|
||||
## What's New in v1.0.0
|
||||
|
||||
### Direct Embed & UI Refinements
|
||||
|
||||
- **Native Multi-language UI (i18n)**: The plugin interface (buttons, settings, status) now automatically adapts to your browser's language setting for a seamless global experience.
|
||||
- **Direct Embed Mode**: Introduced a native-like inline display mode for Open WebUI 0.8.0+, enabling a seamless full-width canvas.
|
||||
- **Adaptive Auto-Sizing**: Mind map now dynamically scales its height and perfectly refits to the window to eliminate scrollbar artifacts.
|
||||
- **Subdued & Compact UI**: Completely redesigned the header tooling bar to a slender, single-line configuration to maximize visual rendering space.
|
||||
- **Configurable Experience**: Added `ENABLE_DIRECT_EMBED_MODE` valve to explicitly toggle the new inline rendering behavior.
|
||||
|
||||
## Key Features 🔑
|
||||
|
||||
- ✅ **Intelligent Text Analysis**: Automatically identifies core themes, key concepts, and hierarchical structures.
|
||||
- ✅ **Native Multi-language UI**: Automatic interface translation (i18n) based on system language for a native feel.
|
||||
- ✅ **Interactive Visualization**: Generates beautiful interactive mind maps based on Markmap.js.
|
||||
- ✅ **Direct Embed Mode**: (Optional) For Open WebUI 0.8.0+, render natively inline to fill entire UI width.
|
||||
- ✅ **High-Resolution PNG Export**: Export mind maps as high-quality PNG images (9x scale).
|
||||
- ✅ **Complete Control Panel**: Zoom controls, expand level selection, and fullscreen mode within a compact toolbar.
|
||||
- ✅ **Theme Switching**: Manual theme toggle button with automatic theme detection.
|
||||
- ✅ **Image Output Mode**: Generate static SVG images embedded directly in Markdown for cleaner history.
|
||||
|
||||
## How to Use 🛠️
|
||||
|
||||
1. **Install**: Upload the `smart_mind_map.py` file in OpenWebUI Admin Settings -> Plugins -> Actions.
|
||||
2. **Configure**: Ensure you have an LLM model configured (e.g., `gemini-2.5-flash`).
|
||||
3. **Trigger**: Enable the "Smart Mind Map" action in chat settings and send text (at least 100 characters).
|
||||
4. **Result**: The mind map will be rendered directly in the chat interface.
|
||||
|
||||
## Configuration (Valves) ⚙️
|
||||
|
||||
| Parameter | Default | Description |
|
||||
| :--- | :--- | :--- |
|
||||
| `show_status` | `true` | Whether to display operation status updates. |
|
||||
| `LLM_MODEL_ID` | `gemini-2.5-flash` | LLM model ID for text analysis. |
|
||||
| `MIN_TEXT_LENGTH` | `100` | Minimum text length required for analysis. |
|
||||
| `CLEAR_PREVIOUS_HTML` | `false` | Whether to clear previous plugin-generated HTML content. |
|
||||
| `MESSAGE_COUNT` | `1` | Number of recent messages to use for generation (1-5). |
|
||||
| `OUTPUT_MODE` | `html` | Output mode: `html` (interactive) or `image` (static). |
|
||||
| `ENABLE_DIRECT_EMBED_MODE` | `false` | Enable Direct Embed Mode (Open WebUI 0.8.0+ native layout) instead of Legacy Mode. |
|
||||
|
||||
## ⭐ 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.
|
||||
|
||||
## Troubleshooting ❓
|
||||
|
||||
- **Plugin not working?**: Check if the action is enabled in the chat settings.
|
||||
- **Text too short**: Ensure input text contains at least 100 characters.
|
||||
- **Rendering failed**: Check browser console for errors related to Markmap.js or D3.js.
|
||||
- **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)
|
||||
|
||||
---
|
||||
|
||||
## Overview
|
||||
## Technical Architecture
|
||||
|
||||
The Smart Mind Map plugin transforms text content into beautiful, interactive mind maps. It uses AI to analyze the structure of your content and creates a hierarchical visualization that makes complex information easier to understand.
|
||||
- **Markmap.js**: Open-source mind mapping rendering engine.
|
||||
- **PNG Export**: 9x scale factor for print-quality output (~1-2MB file size).
|
||||
- **Theme Detection**: 4-level priority detection (Manual > Meta > Class > System).
|
||||
- **Security**: XSS protection and input validation.
|
||||
|
||||
## Features
|
||||
## Best Practices
|
||||
|
||||
- :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: **i18n Embedded**: One code file smartly detects frontend languages and translates the output.
|
||||
- :material-arrow-all: **Auto-Sizing & Direct Embed**: Seamlessly scales to display massive canvas inline (requires setting toggle).
|
||||
1. **Text Preparation**: Provide text with clear structure and distinct hierarchies.
|
||||
2. **Model Selection**: Use fast models like `gemini-2.5-flash` for daily use.
|
||||
3. **Export Quality**: Use PNG for presentations and SVG for further editing.
|
||||
|
||||
---
|
||||
## Changelog
|
||||
|
||||
## Installation
|
||||
|
||||
1. Download the plugin file: [`smart_mind_map.py`](https://github.com/Fu-Jie/openwebui-extensions/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. 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**
|
||||
|
||||
---
|
||||
|
||||
## Configuration
|
||||
|
||||
| Option | Type | Default | Description |
|
||||
|--------|------|---------|-------------|
|
||||
| `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) |
|
||||
| `ENABLE_DIRECT_EMBED_MODE` | boolean | `false` | Enable inline full-width UI for OpenWebUI 0.8.0+ |
|
||||
|
||||
---
|
||||
|
||||
## Example Output
|
||||
|
||||
The plugin generates an interactive HTML mind map embedded in the chat:
|
||||
|
||||
```
|
||||
📊 Mind Map Generated
|
||||
├── Main Topic
|
||||
│ ├── Subtopic 1
|
||||
│ │ ├── Detail A
|
||||
│ │ └── Detail B
|
||||
│ ├── Subtopic 2
|
||||
│ └── Subtopic 3
|
||||
└── Related Concepts
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## Requirements
|
||||
|
||||
!!! 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 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 "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
|
||||
|
||||
---
|
||||
|
||||
## Source Code
|
||||
|
||||
[:fontawesome-brands-github: View on GitHub](https://github.com/Fu-Jie/openwebui-extensions/tree/main/plugins/actions/smart-mind-map){ .md-button }
|
||||
See the full history on GitHub: [OpenWebUI Extensions](https://github.com/Fu-Jie/openwebui-extensions)
|
||||
|
||||
Reference in New Issue
Block a user