- Updated README files for the following plugins to include installation instructions using Batch Install Plugins: - deep-dive - export_to_docx - export_to_excel - flash-card - infographic - smart-mind-map - async-context-compression - chat-session-mapping-filter - folder-memory - github_copilot_sdk_files_filter - markdown_normalizer - github-copilot-sdk - iflow-sdk-pipe - openwebui-skills-manager - smart-mind-map-tool - Added important notes regarding the removal of the official OpenWebUI Community version before installation.
1.4 KiB
1.4 KiB
description, globs, always_on
| description | globs | always_on |
|---|---|---|
| Standards for OpenWebUI Plugin Development, specifically README formatting. | plugins/** | true |
Plugin Development Standards
README Documentation
All plugins MUST follow the standard README template.
Reference Template: @docs/PLUGIN_README_TEMPLATE.md
Language Requirements
- English Version (
README.md): The primary documentation source. Must follow the template strictly. - Chinese Version (
README_CN.md): MUST be translated based on the English version (README.md) to ensure consistency in structure and content.
Metadata Requirements
Follow the header table used in the template:
| By [Fu-Jie](https://github.com/Fu-Jie) · vX.Y.Z | [⭐ Star this repo](https://github.com/Fu-Jie/openwebui-extensions) |
Structure Checklist
- Title & Description
- Header Metadata Table (Author, version, repo star link)
- Preview (Screenshot, GIF, or a short note if preview is not ready)
- Install with Batch Install Plugins (Include the fixed prompt block)
Use the generic prompt
Install plugin from Fu-Jie/openwebui-extensionsinstead of hard-coding the plugin name. - What's New (Keep last 1-3 versions)
- Key Features
- How to Use
- Configuration (Valves)
- Troubleshooting (Must include link to GitHub Issues and mention official-version conflict if relevant)