From b9f5eb56c5e30ac95d423f4366a115979672f49e Mon Sep 17 00:00:00 2001 From: Raj Nandan Sharma Date: Fri, 28 Feb 2025 09:59:39 +0530 Subject: [PATCH] feat: enhance documentation and add donation banner for Kener --- docs/home.md | 105 +++++++++---------------------- src/docs.css | 5 +- src/routes/(docs)/+layout.svelte | 47 +++++++++++++- 3 files changed, 79 insertions(+), 78 deletions(-) diff --git a/docs/home.md b/docs/home.md index 03b22bb1..5415a01c 100644 --- a/docs/home.md +++ b/docs/home.md @@ -1,5 +1,5 @@ --- -title: Kener Documentation +title: Kener Documentation | Open Source Status Page description: Kener is a feature-rich and modern status page system built with SvelteKit and NodeJS. It is open-source and free to use. --- @@ -36,86 +36,41 @@ description: Kener is a feature-rich and modern status page system built with Sv
-
- Live Demo -
-
- Quick Start -
-
- Clone -
-
- Deploy -
-
- APIs -
+ + Live Demo + + + Quick Start + + + Clone + + + Deploy + + + APIs +
-## What is Kener? +## Forget Boring Status Pages. Hello Kener! -Kener is status page system built with Sveltekit and NodeJS. It does not try to replace the Datadogs and Atlassian of the world. It tries to help some who wants to come up with a status page that looks nice and minimum overhead, in a modern way. +**Kener** isn't just another status page – it's a beautifully crafted, lightning-fast monitoring system that makes your services look good even when they're down. Built with modern tech (**SvelteKit** + **NodeJS**), it delivers enterprise-grade reliability monitoring without the enterprise price tag (it's completely free!). -It comes with all the basic asks for a status page. It is open-source and free to use. +### Why Teams Are Switching to Kener -Kener name is derived from the word "Kene" which means "how is it going" in Assamese, then .ing because it was a -cheaply available domain. +- **📈 Up and running in minutes**, not days – from Docker to deployment in less time than it takes to make coffee +- **🎭 Dark mode that actually looks good** – because your 3 AM incident responses shouldn't burn your retinas +- **🧩 Ridiculously customizable** – make it match your brand or go wild with a unique design +- **⚡ Blazing fast performance** – server-rendered for speed that both users and search engines love +- **🌐 Works everywhere** – auto-adjusts to visitors' time zones and looks great on any device +- **🔄 Real-time data** with gorgeous visualizations that make your uptime metrics pop +- **🛠️ Modern tooling** without the bloat – everything you need, nothing you don't -## Quick Deployment +### Used by Companies That Value Simplicity and Power -[![Deploy on Railway](https://railway.com/button.svg)](https://railway.com/template/spSvic?referralCode=1Pn7vs) +From indie developers to growing startups, teams are choosing Kener when they need reliability monitoring that doesn't require a dedicated DevOps team to maintain. -## Features +"_My team set up Kener in less than an hour, and our customers love the transparency it provides. The embedded widgets on our pricing page increased conversions by showing our reliability upfront._" – A happy user -### Monitoring and Tracking - -- Advanced application performance monitoring tools -- Types of Monitors: HTTP, TCP, DNS, ICMP etc -- Real-time network monitor software capabilities -- Polls HTTP endpoint or Push data to monitor using Rest APIs -- Handles Timezones for visitors -- Categorize Monitors into different Sections -- Cron-based scheduling for monitors. Minimum per minute -- Construct complex API Polls - Chain, Secrets etc -- Supports a Default Status for Monitors -- Supports base path for hosting in k8s -- Pre-built docker image for easy deployment - -### Customization and Branding - -- Customizable status page -- Badge generation for status and uptime of Monitors -- Support for custom domains -- Embed Monitor as an iframe or widget -- Light + Dark Theme -- Internationalization support -- Beautifully Crafted Status Page - -### Incident Management - -- Incident Management -- Incident Communication -- Comprehensive APIs for Incident Management - -### User Experience and Design - -- 100% Accessibility Score -- Easy installation and setup -- User-friendly interface -- Responsive design for various devices -- Auto SEO and Social Media ready -- Server Side Rendering - -## Technologies used - -- [SvelteKit](https://kit.svelte.dev/) -- [shadcn-svelte](https://www.shadcn-svelte.com/) - -## Support Me - -If you are using Kener and want to support me, you can do so by sponsoring me on GitHub or buying me a coffee. - -[Sponsor Me Using Github](https://github.com/sponsors/rajnandan1) - -[Buy Me a Coffee](https://www.buymeacoffee.com/rajnandan1) +## Ready to Transform Your Status Page? diff --git a/src/docs.css b/src/docs.css index 78cb408b..cafb65ff 100644 --- a/src/docs.css +++ b/src/docs.css @@ -18,9 +18,10 @@ main { text-decoration: none; background-color: var(--bg-background); } -.kener-home-links > div:hover { +.kener-home-links > a:hover { transition: all 0.3s; - box-shadow: 0 0 8px 1.5px #3e9a4b; + border-color: #ed702d; + background-color: #ed702d; } .accm input:checked ~ div { diff --git a/src/routes/(docs)/+layout.svelte b/src/routes/(docs)/+layout.svelte index 4d0243a2..3a7986ce 100644 --- a/src/routes/(docs)/+layout.svelte +++ b/src/routes/(docs)/+layout.svelte @@ -6,6 +6,7 @@ import Sun from "lucide-svelte/icons/sun"; import Menu from "lucide-svelte/icons/menu"; import X from "lucide-svelte/icons/x"; + import Heart from "lucide-svelte/icons/heart"; import { clickOutsideAction, slide } from "svelte-legos"; import Moon from "lucide-svelte/icons/moon"; import { onMount } from "svelte"; @@ -56,6 +57,23 @@ if (window.innerWidth > 768) { sideBarHidden = false; } + const donationBanner = document.getElementById("donation-banner"); + const closeButton = document.getElementById("close-donation"); + + // Check if we should show the banner today + const lastShown = localStorage.getItem("kener_donation_banner_closed"); + const today = new Date().toDateString(); + + // Only show the banner if it hasn't been closed today + if (lastShown !== today) { + donationBanner.style.display = "block"; + } + + // Add close button handler + closeButton.addEventListener("click", () => { + donationBanner.style.display = "none"; + localStorage.setItem("kener_donation_banner_closed", today); + }); }); @@ -107,7 +125,6 @@ API Reference Report Issue - Sponsor @@ -168,6 +185,34 @@
+