Skip to content

README: warn about zola version and uikit submodule #80

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bast merged 1 commit into from
Feb 10, 2026
Merged

README: warn about zola version and uikit submodule #80

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
17 changes: 16 additions & 1 deletion README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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/
Expand All @@ -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

Expand Down