MCI | WING

📚 Visit the site here

---

🛠️ Local development

The site is built with Material for MkDocs.

To serve the site locally, you need a couple of prerequisites (python >= 3.11 < 3.13,pipx and poetry)

Note: This project currently supports Python 3.11 and 3.12 only. While older versions may work, they haven't been tested. We plan to add Python 3.13 support once mkdocs extends compatibility to that version.

---

1️⃣ Prerequisites

pipx

pipx lets you install and run Python applications in isolated environments. We'll use it to install a package manager (poetry) later on.

1. To set it up:

   python -m pip install --user pipx

2. After installation, you'll see a warning that pipx is not in your system PATH. Copy the path shown in the warning message (this path varies by user).

3. Navigate to the copied path.

   cd your_path_from_warning

4. Set pipx to your PATH environment variable.

   .\pipx.exe ensurepath

poetry

The project uses the package manager poetry. In a new terminal window, install poetry with:

pipx install poetry

---

2️⃣ Project setup

To install all project dependencies, clone this repository and within the project directory, run:

poetry install

3️⃣ Serve the site locally (on Windows)

Lastly, build and serve the site locally with:

.\serve-local.bat

The script disables the git-committers plugin for faster local builds. Visit localhost:8000 in your browser to view the site. 🎉

---

✍️ Contributing content

If you properly set up the project, you can now start writing content. While the site is served locally, any changes you make to the content will automatically trigger a reload of the site in your browser.

The sites content is housed in the \docs directory and is written in Markdown. For formatting reference, check out the Material for MkDocs documentation.

---

📄 License

This work is licensed under a Creative Commons Attribution-NonCommercial-ShareAlike 4.0 International License