README.md

This repository contains the documentation for the Dispatcharr project.

Visit the actual docs here! https://dispatcharr.github.io/Dispatcharr-Docs/

🚀 Getting Started

Follow these steps to clone the repo, set up a virtual environment, install dependencies, and serve the docs locally.

1. Clone the Repository

git clone https://github.com/Dispatcharr/Dispatcharr-Docs.git
cd Dispatcharr-Docs

2. Create a Virtual Environment

python3 -m venv venv source venv/bin/activate # On Windows use: venv\Scripts\activate

3. Install Requirements

pip install -r requirements.txt

4. Serve the Documentation Site

mkdocs serve

Then visit http://127.0.0.1:8000 in your browser to view the site.