Files
Fu-Jie_openwebui-extensions/docs/index.md

137 lines
3.9 KiB
Markdown

---
hide:
- navigation
- toc
---
# Welcome to OpenWebUI Extensions
<div class="hero-section" markdown>
<div class="hero-content" markdown>
# 🚀 Supercharge Your OpenWebUI Experience
**OpenWebUI Extensions** is a curated collection of plugins, prompts, and enhancements designed to extend the functionality of [OpenWebUI](https://github.com/open-webui/open-webui).
[Get Started :material-arrow-right:](#quick-navigation){ .md-button .md-button--primary }
[View on GitHub :fontawesome-brands-github:](https://github.com/Fu-Jie/openwebui-extensions){ .md-button }
</div>
</div>
---
## Quick Navigation
<div class="grid cards" markdown>
- :material-puzzle:{ .lg .middle } **Plugin Center**
---
Browse our collection of powerful plugins including Actions, Filters, Pipes, and Pipelines to enhance your AI interactions.
[:octicons-arrow-right-24: Explore Plugins](plugins/index.md)
- :material-message-text:{ .lg .middle } **Prompt Library**
---
Discover carefully crafted prompts for coding, writing, marketing, and more. Copy and use them instantly.
[:octicons-arrow-right-24: Browse Prompts](prompts/index.md)
- :material-tools:{ .lg .middle } **Enhancements**
---
Learn tips and tricks to optimize your OpenWebUI experience with advanced configurations and customizations.
[:octicons-arrow-right-24: View Guides](enhancements/index.md)
- :material-rocket-launch:{ .lg .middle } **Extensions**
---
Standalone frontend extensions to supercharge your Open WebUI interface.
[:octicons-arrow-right-24: Browse Extensions](extensions/index.md)
- :material-book-open-page-variant:{ .lg .middle } **Development**
---
Comprehensive guides for developing your own plugins, from beginner tutorials to advanced patterns.
[:octicons-arrow-right-24: Start Developing](development/index.md)
</div>
---
## Featured Plugins
<div class="grid cards" markdown>
- :material-brain:{ .lg .middle } **Smart Mind Map**
---
Intelligently analyzes text content and generates interactive mind maps for better visualization.
[:octicons-arrow-right-24: Learn More](plugins/actions/smart-mind-map.md)
- :material-card-text:{ .lg .middle } **Flash Card**
---
Quickly generates beautiful flashcards from text, extracting key points and categories.
[:octicons-arrow-right-24: Learn More](plugins/actions/flash-card.md)
- :material-arrow-collapse-vertical:{ .lg .middle } **Async Context Compression**
---
Reduces token consumption in long conversations through intelligent summarization while maintaining coherence.
[:octicons-arrow-right-24: Learn More](plugins/filters/async-context-compression.md)
</div>
---
## Quick Start
### Using Plugins
1. **Install from OpenWebUI Community (Recommended)**:
- Visit my profile: [Fu-Jie's Profile](https://openwebui.com/u/Fu-Jie)
- Browse the plugins and select the one you like.
- Click "Get" to import it directly into your OpenWebUI instance.
2. **Quick Install All Plugins**: To install all plugins to your local OpenWebUI instance at once, clone this repo and run `python scripts/install_all_plugins.py` after configuring your API key in `.env` — see [Deployment Guide](https://github.com/Fu-Jie/openwebui-extensions/blob/main/scripts/DEPLOYMENT_GUIDE.md) for details.
### Using Prompts
1. Browse the [Prompt Library](prompts/library.md) and select a prompt
2. Click the **Copy** button to copy the prompt to your clipboard
3. In OpenWebUI, click the "Prompt" button above the input box
4. Paste the content and save
---
## Contributing
We welcome contributions! Whether it's a new plugin, a helpful prompt, or documentation improvements.
[:octicons-heart-fill-24:{ .heart } Check out our Contributing Guide](contributing.md){ .md-button }
---
<div class="footer-stats" markdown>
**OpenWebUI Extensions** - Making AI interactions more powerful and productive.
</div>