This is the MkDocs repository that hosts the website for Universal Blue.

You will need Python version 3.10 or higher and Poetry.

1. Setup project dependencies poetry install
2. Run the local development server poetry run mkdocs serve
3. Open a browser to localhost:8000. This will auto-reload on file changes

If you have access to mkdocs-material-insiders, run the following to install it:

poetry run pip install git+ssh:https://[email protected]/squidfunk/mkdocs-material-insiders.git@29bd630bf94c3a3c0eef8118cf1289c226252636

Then use

poetry run mkdocs serve -f mkdocs.insiders.yml

1. Create a fork of this repository
2. Create a new branch for your contribution git checkout -b my-new-branch
3. Add your contributions! Make changes, use poetry run mkdocs serve to validate those changes
4. Commit and push your changes to your branch
5. Open a pull request to have it reviewed

Edit .github/ublue-scan.yml to add images to the ignore list. Use this for images that you don't want to be shown on ublue.it/images. Typically we only want to show user-facing images on the site.