1.1 KiB
1.1 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
The metadata line must follow this format:
**Author:** [Name](Link) | **Version:** [X.Y.Z] | **Project:** [Awesome OpenWebUI](https://github.com/Fu-Jie/awesome-openwebui) | **License:** MIT
Structure Checklist
- Title & Description
- Metadata Line (Author, Version, Project, License)
- Preview (Screenshots/GIFs)
- What's New (Keep last 3 versions)
- Key Features
- How to Use
- Configuration (Valves)
- Troubleshooting (Must include link to GitHub Issues)