Skip to content

Accessing the Docs Locally

If you're updating the documentation and want to see how it looks locally before pushing your changes and deploying, you can do so by following these steps:

  1. Install uv:

    If you don't have uv installed, follow this guide to install it.

  2. Navigate to the Docs Directory: Open your terminal and navigate to the docs directory of the repository:

    cd SlidesGen/docs

  3. Install Dependencies: Run the following command to install the necessary dependencies:

    uv sync

  4. Serve the Documentation: Start the local server with the following command:

    uv run mkdocs serve

  5. View in Browser: Open your web browser and go to http://localhost:3000 to view the documentation.