@@ -21,13 +21,23 @@ $ uv run mkdocs serve
2121
2222This will install all dependencies and run ` mkdocs serve ` .
2323
24- ### Windows
24+ ### Minification
2525
26- On Windows with MSYS2, there is [ an issue] that breaks the minifier we're using.
27- Instead, install Python with the Python installer and install uv with pip,
28- then run the commands above.
26+ The website uses [ pub-minifier] to create minified JS, CSS and HTML code
27+ when running ` mkdocs build ` .
28+ The minification is optional and will only take place if you have the tools.
29+ To use this feature, run the following commands instead of ` uv run mkdocs build ` :
2930
30- You might also need [ GTK Runtime] to support all the imaging stuff (e.g. social cards).
31+ ``` sh
32+ $ npm ci
33+ $ npm run build
34+ ```
35+
36+ These commands assume that you have node.js installed.
37+
38+ ### Windows
39+
40+ You might need [ GTK Runtime] to support all the imaging stuff (e.g. social cards).
3141
3242The server supports auto code reloading, so the website will automatically
3343refresh if changes were made.
@@ -51,6 +61,10 @@ It is required if you plan to host the website on another domain
5161This is the URL of the website repository.
5262You might want to change this so that the ` Edit ` buttons work properly.
5363
64+ ##### ` LITE_XL_VERSION `
65+
66+ This is the version of Lite XL to download in the setup page.
67+
5468## Site organization
5569
5670This project follows typical [ MkDocs] file structure.
@@ -87,7 +101,7 @@ This can be found in `fix-keymap.py`.
87101[ MkDocs ] : https://www.mkdocs.org/
88102[ mkdocs-material ] : https://squidfunk.github.io/mkdocs-material/
89103[ mkdocs-macros-plugin ] : https://mkdocs-macros-plugin.readthedocs.io/en/latest/
90- [ an issue ] : https://github.com/tdewolff/minify/issues/679
104+ [ pub-minifier ] : https://mkdocs-publisher. github.io/setup/seo-and-sharing/pub-minifier/
91105[ GTK Runtime ] : https://github.com/tschoonj/GTK-for-Windows-Runtime-Environment-Installer
92106[ uv ] : https://docs.astral.sh/uv/
93- [ pymdown ] : https://facelessuser.github.io/pymdown-extensions/extensions/keys
107+ [ pymdown ] : https://facelessuser.github.io/pymdown-extensions/extensions/keys
0 commit comments