From 6f93e6e478e47c905a60f44c2bce742083ec8cd7 Mon Sep 17 00:00:00 2001 From: Michele Mesiti Date: Mon, 9 Feb 2026 22:30:13 +0100 Subject: [PATCH] README: warn about zola version and uikit submodule --- README.md | 17 ++++++++++++++++- 1 file changed, 16 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 3739222..2b680f3 100644 --- a/README.md +++ b/README.md @@ -37,7 +37,8 @@ To use it, follow these instructions: ### How this template works -This template is based on the [Zola](https://www.getzola.org/) static site engine. +This template is based on the [Zola](https://www.getzola.org/) static site engine, +and uses [uikit](https://github.com/uikit/uikit). To install Zola, follow: - https://www.getzola.org/documentation/getting-started/installation/ @@ -46,6 +47,20 @@ To install Zola, follow: Check that Zola is installed with `$ zola --version`. +> [!WARNING] +> +> This template might fail with recent versions of Zola. The workflows are successful with Zola 0.19.1. +> + +The correct version of Uikit is included as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules). +If you have not cloned this repository with the `--recurse-submodules` option, +you can use +```bash +git submodule init +git submodule update +``` +to install the dependencies. + ### Local preview