cute-kuma/README.md

67 lines
2.2 KiB
Markdown
Raw Permalink 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-11-23 19:08:15 +04:00
<a href="https://kuma.denisro.com"><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>
2025-01-19 21:55:05 +04:00
</p>
<p>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./.github/assets/2-col/dark.png">
<source media="(prefers-color-scheme: light)" srcset="./.github/assets/2-col/light.png">
<img alt="Cute Kuma" src="./.github/assets/2-col/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
- Support for Uptime Kuma 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
### Columns layout
2025-06-17 00:04:52 +04:00
<details>
<summary>Preview</summary>
<picture>
<source media="(prefers-color-scheme: dark)" srcset="./.github/assets/1-col/dark.png">
<source media="(prefers-color-scheme: light)" srcset="./.github/assets/1-col/light.png">
<img alt="Cute Kuma: 2 columns" src="./.github/assets/1-col/dark.png">
</picture>
</details>
2025-06-17 00:04:52 +04:00
By default, 2 columns are shown on wide screens. If you prefer a single column everywhere, disable the 2column rule.
2025-06-17 00:04:52 +04:00
> [!IMPORTANT]
> If you enable tag display (monitor tags), it is strongly recommended to use a 1column layout.
2025-06-17 00:04:52 +04:00
1. Search for this comment:
`/* Enable 2 columns on wider screens; comment out to disable */`
2. Comment out the block immediately below it.
2025-06-17 00:04:52 +04:00
### Restoring the Refresh Timer
2025-01-19 21:55:05 +04:00
2025-11-23 19:08:15 +04:00
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.