MkDocs Kuma Uptime Badge Plugin – Easy Status Badges for Your Documentation

1 Sibyx 1 7/14/2025, 8:45:29 PM github.com ↗

Comments (1)

Sibyx · 6h ago
I've created a MkDocs plugin that makes it super simple to add Uptime Kuma status badges to your documentation. Instead of writing long URLs, you can use simple shorthand syntax:

{{uptime id=1}} -> converts to a full status badge

{{uptime id=2 type=uptime hours=24}} -> shows 24h uptime stats

Key features:

- Simple shorthand syntax that's easy to remember

- Supports all Uptime Kuma badge types (status, uptime, ping, response times, SSL cert expiry)

- Works with any Uptime Kuma instance

- MIT licensed

Perfect for teams using MkDocs who want to show real-time status of their services right in the documentation.

GitHub: https://github.com/culturepulse/mkdocs-kuma-uptime-badge

PyPI: https://pypi.org/project/mkdocs-kuma-uptime-badge/