Contributing to the Documentation

This documentation is hosted by GitLab Pages on drupalcode.org and uses mkdocs-material.

Getting started

There is a mkdocs.yml in the wisski root directory, which contains all the mkdocs configuration. You can start the mkdocs container with:

docker compose -f ./misc/docs/docker-compose.yml up -d

After starting the container you can access the documentation at http://localhost:8000. The pages should automatically update whenever you change the files in this repository.

Note

Automatic live reloading does not work with Docker bind mounts due to file system notification (inotify) limitations. After saving changes to markdown files, manually refresh your browser to see updates. This is a Docker limitation that affects all Linux distributions, not specific to Arch Linux.