StandCloud Documentation

This repository contains the source files for the StandCloud project documentation. We use MkDocs with the Material theme to build and serve our docs.

Follow the instructions below to set up your local development environment and preview changes in real-time.

---

Getting Started

Prerequisites

Ensure you have Python 3.x installed on your system. You can verify this by running: python3 --version

Setup Instructions

1. Create a Virtual Environment It is recommended to use a virtual environment to keep dependencies isolated.

   python3 -m venv .venv

2. Activate the Environment On macOS and Linux:

   source .venv/bin/activate

   On Windows:

   .\.venv\Scripts\Activate.ps1

3. Install Dependencies Install the required documentation tools (MkDocs, themes, and plugins):

   pip install -r requirements.txt

Local Development

To start the local development server and preview the documentation, run:

mkdocs serve

Once the server is running, open your browser and navigate to:

http://127.0.0.1:8000

The page will automatically reload whenever you save changes to the .md files in the docs/ directory.