docs: add tutorial for customizing themes (opening early for reference) #680
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
This PR adds a new documentation page that provides a comprehensive guide on how to customize and add new themes to Open WebUI, particularly animated themes powered by Particle.js.
The new page is located at
docs/tutorials/theming.mdx
and covers how users can propose new themes and provides a step-by-step guide for developers to create and register their own themes, specifically animated themes powered by Particle.js.Motivation
The goal of this new documentation page is to empower the community to contribute to the look and feel of Open WebUI by providing clear and actionable instructions on theme creation. This will hopefully lead to a richer and more diverse set of themes available for all users.
How to Test
Check out this PR.
Install the dependencies:
My apologies for opening up both this PR and #675 on the
main
branch. I need to update my local dev environment so that my changes are being made on thedev
branch.This PR links to a PR I've yet to submit over on the main repo!