docs: warn on zensical offical image compatibility (1454c4ba) · Commits · to be continuous... / MkDocs

README.md

+2 −1

Original line number	Diff line number	Diff line
		@@ -53,7 +53,8 @@ The MkDocs template uses some global configuration used throughout all jobs.
		\| `PIP_INDEX_URL` \| Python repository url \| _none_ \|
		\| `pip-opts` / `PIP_OPTS` \| pip extra [options](https://pip.pypa.io/en/stable/cli/pip/#general-options) \| _none_ \|

		:information_source: `MKD_IMAGE`: To use Zensical, you may use the official image `docker.io/zensical/zensical:latest`.<br/> :information_source: While you can stay on `docker.io/squidfunk/mkdocs-material:latest` for now, please note that maintenance for this image is scheduled to end. Zensical remains also compatible with any standard Python environment `docker.io/library/python:latest` or Astral uv `docker.io/astral/uv:python3.14-trixie-slim`.
		:information_source: While you can stay on `docker.io/squidfunk/mkdocs-material:latest` for now, please note that maintenance for this image is scheduled to end.<br/>
		:information_source: You may utilize any standard Python environment, such as `docker.io/library/python:latest`, or the Astral UV variant `docker.io/astral/uv:python3.14-trixie-slim`. Please be advised, however, that the official Zensical image (zensical:latest) is incompatible with GitLab CI, as it lacks the essential coreutils required for successful pipeline execution.

		:information_source: `MKDOCS_BUILD_SYSTEM`: When using Zensical, you can specify the build tool version by including a [version identifier](https://peps.python.org/pep-0440/). For example: `MKDOCS_BUILD_SYSTEM="zensical==0.0.10"`.