Skip to content

README.md

Latest commit

 

History

History
55 lines (35 loc) · 1.21 KB

README.md

File metadata and controls

55 lines (35 loc) · 1.21 KB

LabyMod 4 API Wiki

This is the official wiki for the LabyMod 4 API. It contains guides, documentation, and examples on how to use and extend the API.

Contributing

Have you found something missing from this wiki that you think is important, or are you unhappy with something? We welcome contributions! Simply fork this repository, add or improve the content, and then open a pull request.

Please make sure your changes are clear, well-formatted, and accurate before submitting.

Live Build

The live version of this wiki can be found here.

Preview Locally

To run the wiki locally, follow these steps:

Requirements

Setup

  1. Create a virtual environment

    python -m venv .venv

  2. Activate the virtual environment

    # Windows (cmd)
.venv\Scripts\activate.bat

# macOS / Linux
source .venv/bin/activate

  3. Install dependencies

    pip install -r requirements.txt

  4. Start the development server

    mkdocs serve

    The wiki will now be available at http://127.0.0.1:8000.