UptimeKit Documentation

This repository contains the official documentation for UptimeKit, an open-source, modern, and powerful status page and monitoring solution.

The documentation is built using Mintlify and is hosted at docs.uptimekit.io.

🚀 Development

To preview the documentation locally, you need to install the Mintlify CLI.

Prerequisites

• Node.js (version 18 or higher)
• npm

Installation

npm i -g mint

Local Preview

Run the following command at the root of this repository:

mint dev

The documentation will be available at http://localhost:3000.

� Structure

• docs.json: Configuration for the documentation (navigation, theme, etc.).
• index.mdx: The homepage of the documentation.
• installation/: Guides for setting up the dashboard and workers.
• configuration/: Detailed configuration options.
• integrations/: Documentation for third-party integrations (Discord, Telegram, etc.).
• logo/: Brand assets.
• snippets/: Reusable MDX components.

🤝 Contributing

We welcome contributions to the documentation! If you find a typo, outdated information, or want to add a new guide:

1. Fork the repository.
2. Create a new branch for your changes.
3. Submit a Pull Request with a clear description of your improvements.

📄 License

The documentation is licensed under the MIT License. See LICENSE for more information.