Summary

This version updates the user interface to v0.0.12, which includes the removal of 19 brand icons due to the update of Lucide to v1, and the addition of 166 new icons, most of them in SimpleIcons and FontAwesome. Additionally, there are bug fixes related to the latest changes of the table of contents in the modern theme and instant navigation on anchor links.

Changelog

Bug fixes

• 198c1d6 ui – update ui to v0.0.12
• 24be9ab compat – support pymdownx blocks tab extension's slugify function (#483)

Summary

This version adds support for mike, a tool for managing multiple versions of MkDocs projects on GitHub Pages. We created a tailored fork of mike for Zensical – all mike commands should work as expected. Please refer to our documentation for setup instructions, and mike's documentation for advanced usage patterns and options.

Note that this is a temporary solution. Zensical will ship native support for versioning in the near future, which will remove the GitHub Pages constraint and offer more flexibility in how versions are deployed and served.

The user interface is updated to v0.0.11, which adds a floating table of contents menu for mobile to the modern theme. The toggle sits at the bottom of the screen for easy thumb access, and the sidebar scrolls to accommodate arbitrarily long tables of contents. This release also includes several improvements: snappier sidebar animations, better tooltip readability, and improved inline code block sizing.

Changelog

Features

• 77a08d9 compat – add support for mike

Bug fixes

• 97cdbc8 ui – update ui to v0.0.11
• 25e8c53 compat – validate docs-directory and custom-theme-directory (#475)

Summary

This version fixes an issue with absolute paths in links, as well as changed files not being picked up by Zensical on Windows 11.

Changelog

Bug fixes

• c1860ca compat – leave absolute links untouched (#466)
• 6775b75 zensical – canonicalize watched paths (#451)

Summary

This version updates the user interface to v0.0.10, which fixes a couple of bugs related to search and code annotation rendering. Additionally, it adds support for version selectors in the modern theme, paving the way for adding support for mike to manage multiple versions of documentation on GitHub Pages.

In addition, this release adds new configuration options for the file watcher to improve compatibility in certain environments.

File watcher

You can now opt into using a polling-based file watcher, which is particularly useful when running Docker on Windows, where filesystem event limitations (e.g., inotify constraints) can cause issues.

To enable the polling watcher:

export ZENSICAL_POLL_WATCHER=1

The polling interval is configurable and defaults to 500 milliseconds (aligned with MkDocs behavior):

export ZENSICAL_POLL_INTERVAL=500

Changelog

Bug fixes

• 5196cdb compat – invalid setup of MathJax in bootstrapped zensical.toml
• b710744 ui – update ui to v0.0.10
• f014425 zensical-watch – auto-reload not working for Docker on Windows (#340, #446)

Summary

This version fixes a reload loop for when auto-appended snippets are located inside of the docs directory, and auto-reload for pages with Chinese path segments.

Changelog

Bug fixes

• 062a972 zensical – printed URLs of built pages shouldn't be percent-encoded
• e326ae3 zensical – auto-reload not working for URLs with Chinese path segments (#436)
• 9654132 zensical-watch – skip queuing redundant watch paths (#434)

Summary

This version fixes a regression introduced in 0.0.25 where the wheels built for manylinux x86 would be based on Python 3.8 instead of Python 3.10, making Zensical unusable on those architectures. This is related to a recent bug in our upstream dependency maturin, which was introduced in version 1.12.5. Additionally, it fixes a deprecation warning on Python 3.14 when using the emoji extension.

Changelog

Bug fixes

• 66ca0e7 – missing wheels for CPython 3.10 manylinux x86 (#425)
• 7514e32 compat – replace codecs.open, deprecated in Python 3.14 (#429)

Summary

This version updates the user interface to v0.0.9, which improves on accessibility and fixes some minor rendering issues. Additionally, it fixes some bugs related to configuration parsing and plugin handling in zensical serve, ensuring a smoother development experience.

Highlights

• zensical serve now keeps running on configuration parsing errors
• Auto-appended pymdownx.snippets files are now watched for changes
• Search highlighting now works with keyboard navigation

Changelog

Bug fixes

• 657c685 ui – update ui to v0.0.9
• b5c8767 zensical – config parse errors shouldn't terminate zensical serve (#403)
• 6c911ca zensical, compat – watch auto-appended pymdownx.snippets files for changes (#148)
• bf930dd zensical, compat – hash plugins config to trigger page rebuilds (#387)
• b93d630 compat – clarify examples in bootstrapped zensical.toml (#394)

Summary

This version updates the user interface to v0.0.8, which fixes issues with instant previews for Chinese and other non-ASCII languages, and layout shifts when switching from short to long pages in the modern theme. Additionally, same-page links for when directory URLs are disabled where not resolved correctly, which is fixed as well.

Changelog

Bug fixes

• 1a9d034 ui – update ui to v0.0.8
• 798da33 compat – ignore virtual environments in mkdocstrings sources (#391)
• 4b1ac98 zensical – same page links '.' with directory URLs disabled (regression) (#389)

Summary

This version fixes a regression introduced in 0.0.22, where builds would error with mkdocstrings being not found, although the plugin wasn't configured.

Changelog

Bug fixes

• 10b5162 compat – lazy import mkdocstrings (#360)

Summary

This version adds support for the autorefs plugin, and further improves performance for large mkdocstrings projects. The user interface is updated to v0.0.7, which fixes some isses with the mobile browsering experience.

Changelog

Features

• e32ab15 zensical, compat – support autorefs plugin

Bug fixes

• 1b1fd84 zensical – reset global data in compatibility modules between each rebuild
• e33c972 compat – don't watch mkdocstrings-configured path if it's the root directory
• b3c699b ui – update ui to v0.0.7
• e233f9f compat – fail early if mkdocstrings is enabled but not installed (#338)
• e3fc49f zensical – relative URLs with : need to start with ./ (#345)