Skip to content

cachethq/docs

Repository files navigation

Cachet Logo

GitHub Sponsors

Cachet Documentation

Cachet is an easy-to-use and powerful open-source status page system. Cachet allows you effectively communicate downtime and system outages to your customers, teams, and shareholders.

This repository contains the source code for the Cachet documentation which is built using Mintlify.

Running Locally

The documentation is kindly hosted by Mintlify. To run the documentation locally:

  1. Clone the repository:
    git clone [email protected]:cachethq/docs.git cachet-docs
  2. Install Mintlify:
    npm install -g mintlify@latest
  3. Run the documentation:
    cd cachet-docs
    mintlify dev

Contributing

Check out the Mintlify Guide to learn more.