cute-kuma/README.md

81 lines
2.8 KiB
Markdown
Raw Normal View History

2025-01-19 21:55:05 +04:00
<h3 align="center">Cute Kuma</h3>
<p align="center">
2025-06-17 01:05:00 +04:00
Give your <a href="https://github.com/louislam/uptime-kuma">Uptime Kuma</a> status page a cute and modern look with custom CSS
2025-01-19 21:55:05 +04:00
<br>
2025-02-03 12:14:03 +04:00
<a href="https://kuma.denisromanov.ru"><strong>Live demo »</strong></a>
2025-01-19 21:55:05 +04:00
<br>
<br>
2025-06-17 00:04:52 +04:00
<a href="#features">Features</a>
2025-01-19 21:55:05 +04:00
·
2025-06-17 00:04:52 +04:00
<a href="#installation">Installation</a>
2025-01-19 21:55:05 +04:00
·
2025-06-17 00:04:52 +04:00
<a href="#personalization">Personalization</a>
·
<a href="#troubleshooting">Troubleshooting</a>
2025-01-19 21:55:05 +04:00
</p>
<p>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./.github/assets/dark.png">
<source media="(prefers-color-scheme: light)" srcset="./.github/assets/light.png">
2025-01-20 21:54:19 +04:00
<img alt="Cute Kuma" src="./.github/assets/dark.png">
2025-01-19 21:55:05 +04:00
</picture>
</p>
2025-03-01 20:36:48 +04:00
## Features
2025-01-19 21:55:05 +04:00
2025-06-17 00:04:52 +04:00
- Modern design inspired by top monitoring services
2025-10-22 22:22:26 +04:00
- Support for Uptime Kuma v1 and v2
2025-06-17 00:04:52 +04:00
- Support for light and dark themes
- Hidden refresh timer for a cleaner look (can be easily restored)
- Clean, easily customizable and extendable code
2025-01-19 21:55:05 +04:00
2025-06-17 00:04:52 +04:00
## Installation
2025-01-19 21:55:05 +04:00
1. In your Uptime Kuma dashboard, navigate to status page.
2. Click `Edit Status Page`.
2025-06-17 00:04:52 +04:00
3. Scroll down to `Custom CSS` field.
2025-06-01 23:34:10 +04:00
4. Copy the contents of `main.css` and paste it into the `Custom CSS` field.
2025-01-19 21:55:05 +04:00
5. Click `Save` at the bottom.
2025-03-01 20:36:48 +04:00
## Personalization
2025-01-19 21:55:05 +04:00
2025-06-17 00:04:52 +04:00
You can easily customize the theme by modifying the variables inside the `:root {}` block.
2025-07-11 23:32:02 +04:00
### Displaying Tags on the Status Page
If you have enabled the tags feature in your status page settings, you must manually edit the CSS to make them visible. By default, the tags are hidden, even when the feature is active in the settings.
1. Find the `/* Hide-all-tags switch leave commented */`.
2. You need to comment out the block that hides the tags **(OPTION 1)** and uncomment the block that displays them **(OPTION 2)**.
2025-06-17 00:04:52 +04:00
### Restoring the Refresh Timer
The refresh timer is hidden by default. To make it visible again, find the `.refresh-info` rule and remove or comment out the `display: none;` line.
## Troubleshooting
### Country Flag Emojis Not Displaying on Windows
2025-06-17 01:05:00 +04:00
Browsers on Windows can't render country flag emojis correctly.
2025-06-17 00:04:52 +04:00
To fix it, add the following code to the very beginning of your CSS.
```
@font-face {
src: url("https://cdn.jsdelivr.net/npm/country-flag-emoji-polyfill@0.1/dist/TwemojiCountryFlags.woff2") format("woff2");
font-family: "Twemoji Country Flags";
unicode-range: U+1F1E6-1F1FF, U+1F3F4, U+E0062, U+E0063, U+E0065, U+E0067, U+E006C, U+E006E, U+E0073, U+E0074, U+E0077, U+E007F;
}
```
> [!IMPORTANT]
> For **Uptime Kuma v1** you most likely need to add the following code.
2025-01-19 21:55:05 +04:00
```
2025-06-17 00:04:52 +04:00
#app {
font-family: BlinkMacSystemFont, "segoe ui", Roboto, "helvetica neue", Arial, "noto sans", sans-serif, "apple color emoji", "Twemoji Country Flags", "segoe ui emoji", "segoe ui symbol", "noto color emoji";
2025-01-19 21:55:05 +04:00
}
```