Skip to content

Commit 65ddf7f

Browse files
committed
📝(docs) add documentation about runtime theming
Add a documentation page about runtime theming. It explains how to use the theming system and provide a example.
1 parent d3a7ee7 commit 65ddf7f

File tree

1 file changed

+33
-0
lines changed

1 file changed

+33
-0
lines changed

docs/theming.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Runtime Theming 🎨
2+
3+
### How to Use
4+
5+
To use this feature, simply set the `FRONTEND_CSS_URL` environment variable to the URL of your custom CSS file. For example:
6+
7+
```javascript
8+
FRONTEND_CSS_URL=http://anything/custom-style.css
9+
```
10+
11+
Once you've set this variable, our application will load your custom CSS file and apply the styles to our frontend application.
12+
13+
### Benefits
14+
15+
This feature provides several benefits, including:
16+
17+
* **Easy customization** 🔄: With this feature, you can easily customize the look and feel of our application without requiring any code changes.
18+
* **Flexibility** 🌈: You can use any CSS styles you like to create a custom theme that meets your needs.
19+
* **Runtime theming** ⏱️: This feature allows you to change the theme of our application at runtime, without requiring a restart or recompilation.
20+
21+
### Example Use Case
22+
23+
Let's say you want to change the background color of our application to a custom color. You can create a custom CSS file with the following contents:
24+
25+
```css
26+
body {
27+
background-color: #3498db;
28+
}
29+
```
30+
31+
Then, set the `FRONTEND_CSS_URL` environment variable to the URL of your custom CSS file. Once you've done this, our application will load your custom CSS file and apply the styles, changing the background color to the custom color you specified.
32+
33+

0 commit comments

Comments
 (0)