From 70784fa05c132a064606be7cb28df7bb95faa2f3 Mon Sep 17 00:00:00 2001 From: Piotr Usewicz Date: Mon, 2 Mar 2026 07:02:12 +0100 Subject: [PATCH 1/5] Migrate to zensical --- .github/workflows/documentation.yml | 6 ++---- mkdocs.yml | 4 ++-- 2 files changed, 4 insertions(+), 6 deletions(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 3eb674df..09ff2727 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -132,12 +132,10 @@ jobs: python-version: 3.x - name: Install Python dependencies - run: pip install mkdocs mkdocs-material "mkdocs-material[imaging]" markdown-callouts + run: pip install zensical markdown-callouts - name: Build documentation - run: | - mkdocs build --clean - mkdocs --version + run: zensical build - name: Adjust permissions run: | diff --git a/mkdocs.yml b/mkdocs.yml index c43e6b70..6123c9a6 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -10,7 +10,7 @@ repo_url: https://github.com/RandyGaul/cute_framework repo_name: RandyGaul/cute_framework # Copyright -copyright: Copyright © 2019—2025 Randy Gaul +copyright: Copyright © 2019—2026 Randy Gaul # Configuration theme: @@ -132,7 +132,7 @@ nav: # Plugins plugins: - search: - separator: '[\s\-\_]+' + separator: '[\\s\\-\\_]+' - social # Extensions From 976935e0b17dda62832581ccf224bdab1c46401d Mon Sep 17 00:00:00 2001 From: Piotr Usewicz Date: Mon, 2 Mar 2026 07:08:44 +0100 Subject: [PATCH 2/5] Disable caching as per recommendation --- .github/workflows/documentation.yml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 09ff2727..6fbf3684 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -135,7 +135,7 @@ jobs: run: pip install zensical markdown-callouts - name: Build documentation - run: zensical build + run: zensical build --clean - name: Adjust permissions run: | From dcb65a5f554764b374f007fa450f0cb09fdfcc92 Mon Sep 17 00:00:00 2001 From: Piotr Usewicz Date: Mon, 2 Mar 2026 07:09:21 +0100 Subject: [PATCH 3/5] Update documentation --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index d366453f..fe2ae2c5 100644 --- a/README.md +++ b/README.md @@ -123,12 +123,12 @@ All of CF's docs for the [CF website](https://randygaul.github.io/cute_framework Please note that the reference pages for functions/structs are automatically generated by CF's [docs parser + generator](https://github.com/RandyGaul/cute_framework/blob/master/tools/docs_parser.c). You can run this executable to regenerate all of the docs files for all of CF. If you wish to edit any of the reference pages be sure to edit the appropriate file in CF's actual source code and regenerate the docs by running [docs_parser](https://github.com/RandyGaul/cute_framework/blob/master/tools/docs_parser.c). -CF uses [MkDocs](https://www.mkdocs.org/) with the [Material theme](https://squidfunk.github.io/mkdocs-material/) to generate the website, so you can run `mkdocs serve` to preview the docs locally. +CF uses [Zensical](https://zensical.org/) to generate the website, so you can run `zensical serve` to preview the docs locally. -MkDocs requirements: +Zensical requirements: ``` -pip install mkdocs mkdocs-material "mkdocs-material[imaging]" markdown-callouts +pip install zensical markdown-callouts ```

From 407bee750468991ec35f7f1b9a5fdf3ae4c2ddb7 Mon Sep 17 00:00:00 2001 From: Piotr Usewicz Date: Mon, 2 Mar 2026 07:10:31 +0100 Subject: [PATCH 4/5] Add requirements.txt --- .github/workflows/documentation.yml | 2 +- README.md | 2 +- docs/requirements.txt | 2 ++ 3 files changed, 4 insertions(+), 2 deletions(-) create mode 100644 docs/requirements.txt diff --git a/.github/workflows/documentation.yml b/.github/workflows/documentation.yml index 6fbf3684..83a6f877 100644 --- a/.github/workflows/documentation.yml +++ b/.github/workflows/documentation.yml @@ -132,7 +132,7 @@ jobs: python-version: 3.x - name: Install Python dependencies - run: pip install zensical markdown-callouts + run: pip install -r docs/requirements.txt - name: Build documentation run: zensical build --clean diff --git a/README.md b/README.md index fe2ae2c5..c3ff0e94 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,7 @@ CF uses [Zensical](https://zensical.org/) to generate the website, so you can ru Zensical requirements: ``` -pip install zensical markdown-callouts +pip install -r docs/requirements.txt ```

diff --git a/docs/requirements.txt b/docs/requirements.txt new file mode 100644 index 00000000..2eafd849 --- /dev/null +++ b/docs/requirements.txt @@ -0,0 +1,2 @@ +zensical +markdown-callouts From 2d808440352f2137ac7a590932c4fafbef43a286 Mon Sep 17 00:00:00 2001 From: Piotr Usewicz Date: Mon, 2 Mar 2026 07:11:40 +0100 Subject: [PATCH 5/5] Add info about venv --- .gitignore | 1 + README.md | 5 ++++- 2 files changed, 5 insertions(+), 1 deletion(-) diff --git a/.gitignore b/.gitignore index 50c58002..7a07ecbb 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ docs/api_reference.md !docs/topics/*.md /docs/samples/play/ site/ +.venv/ .cache .DS_Store cute_framework.zip diff --git a/README.md b/README.md index c3ff0e94..836c78f9 100644 --- a/README.md +++ b/README.md @@ -125,10 +125,13 @@ Please note that the reference pages for functions/structs are automatically gen CF uses [Zensical](https://zensical.org/) to generate the website, so you can run `zensical serve` to preview the docs locally. -Zensical requirements: +Zensical setup: ``` +python -m venv .venv +source .venv/bin/activate pip install -r docs/requirements.txt +zensical serve ```