Summary This version adds search support for CJK languages: Chinese, Japanese, and Korean. Search needs to segment text into individual words before it can index and match them. While many languages separate words with spaces, this is not consistently the case for CJK text, particularly Chinese and Japanese. Search now uses locale-aware segmentation to identify meaningful word boundaries, ensuring…
Summary This version improves cached rebuilds by persisting objects.inv and autorefs data, fixes stale builds after removing files, and upgrades soupsieve to address vulnerabilities. Changelog Bug fixes ec69acc zensical, compat – cache objects.inv to persist it across cached rebuilds (#815) 7e6940f zensical – cache autorefs data for cross-ref resolution across rebuilds (#805)
Summary This version fixes a regression introduced in 0.0.48 which broke search. Changelog Bug fixes 46d9f29 ui – update ui to v0.0.22
Summary This version updates the user interface to v0.0.21, bringing the latest fixes for Pyodide-powered code execution, search, and ANSI color rendering. It also improves configuration parsing, and fixes relative and scoped cross-references for mkdocstrings-python. Changelog Bug fixes 15f138a ui – update ui to v0.0.21 63c9dd3 compat – avoid registering same extension twice (as plugin and extensi…
Summary This version adds support for markdown-exec, an MkDocs plugin that executes Python code blocks during the build and injects the result into the rendered page. In practice, this makes it easier to build interactive technical documentation, generated examples, and executable snippets that integrate directly with the theme in both classic and modern variants. Additionally, the user interface…
Summary This version improves search result quality and includes several bug fixes and refactorings. Search excerpts Search results now include excerpts, making it easier to understand why a result matches. Search remains fully client-side and as fast as before, even for projects with thousands of pages. We still consider search an active area of iteration and expect to further improve it and expo…
Summary This version reverts a behavior change in link validation that was introduced in 0.0.44 which is causing false positives. Changelog Bug fixes 8d9536a compat – revert "fix: brackets in indented code recognized as unresolved references (#700)" (#735)
Summary This version fixes several bugs related to link validation and macros, and ensures that dotfiles are not removed from the site directory during generation. Changelog Bug fixes eb72115 compat – ignore Markdown comments [//]: ... during link validation c40f649 compat – brackets in indented code blocks recognized as unresolved link references (#700) 93cc869 compat – snippet markers recognized…
Summary This version fixes further edge cases in link validation, and adds support for UTF-8 encoding with byte-order-marks. Changelog Bug fixes 1e873a3 compat – ignore links in code after literal dollar during link validation (#691) 62a0feb zensical – report path.md/#anchor as invalid during link validation (#690) 7be40c6 compat – ignore GitHub-style callouts during link validation (#688) 85c3b1e…
Summary This version includes a number of bug fixes and refactorings to improve the stability and accuracy of link validation, and fixes a reload loop when the custom_dir, which is auto-watched, is explicitly added to watch. Moreover, GLightbox is now only downloaded when needed, which fixes an issue when using Zensical in air-gapped environments. Changelog Bug fixes 6b54e14 ui – update ui to v0.0…
Summary This version adds support for integrating tabular data as Markdown tables, covering the functionality of the mkdocs-table-reader-plugin, as well as the watch option to automatically rebuild on changes in unmonitored files. Table reading is implemented as part of macros, which we shipped in 0.0.40. You can now embed CSV and other file formats with: {{ read_csv("data/team.csv") }} Additional…
Summary This version adds support for macros, covering the functionality of the mkdocs-macros-plugin. Macros allow you to define custom variables and functions that can be used in your Markdown files, making it easier to manage and reuse content across your documentation. We've implemented macros support as a Python Markdown extension, since it's essentially a Markdown preprocessor that doesn't ne…
Summary This version fixes several bugs related to link validation and lightbox configuration. Changelog Bug fixes fe42fc4 compat – shim for MkDocs validation syntax overrides Zensical's (#607) acc2620 zensical – validation doesn't correctly map percent-encoded links (#598) da317bf compat – add $...$ and $$...$$ blocks to exclusions for link validation (#599) 94f0d29 zensical – anchor not extracte…
Summary This version adds link and footnote validation and strict mode – two of the most frequently requested features. Zensical now checks all internal references at build time and reports issues with precise source locations, so broken links don't make it into your published documentation. Unlike MkDocs, which only validates final rendered links, Zensical also checks for unresolved references, a…
Summary This version adds support for installable themes. You can now bundle your theme overrides and package them into a custom theme which can be installed via pip. As of now, we closely mirror the process used by MkDocs, where themes just need to register themselves in the mkdocs.themes entrypoint, to allow users that already have derivations of Material for MkDocs to run them on Zensical. In t…