Zensical

.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 -r docs/requirements.txt
 
       - name: Build documentation
-        run: |
-          mkdocs build --clean
-          mkdocs --version
+        run: zensical build --clean
 
       - name: Adjust permissions
         run: |

.gitignore

@@ -5,6 +5,7 @@ docs/api_reference.md
 !docs/topics/*.md
 /docs/samples/play/
 site/
+.venv/
 .cache
 .DS_Store
 cute_framework.zip

README.md

@@ -123,12 +123,15 @@ 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 setup:
 
 ```
-pip install mkdocs mkdocs-material "mkdocs-material[imaging]" markdown-callouts
+python -m venv .venv
+source .venv/bin/activate
+pip install -r docs/requirements.txt
+zensical serve
 ```
 
 <p align="center"><img src=https://github.com/RandyGaul/cute_framework/blob/master/assets/CF_Logo_Pixel_2x.png></p>

docs/requirements.txt

@@ -0,0 +1,2 @@
+zensical
+markdown-callouts

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