Summary Zensical now supports Material for MkDocs’ social plugin natively, generating social cards and Open Graph and Twitter metadata with bundled or custom layouts. This release also adds native llmstxt and exclude plugins for Markdown exports and file exclusions. Additionally, the user interface is updated to v0.0.34, adding a Copy as Markdown button. Changelog Features 9f9b25b zensical, zensic…
Summary This version adds compatibility with mkdocs-autoapi and mkdocs-api-autonav, making it easier to document Python projects. These plugins discover modules and packages, generate API reference pages, and organize them in your site's navigation. They build on mkdocstrings, which renders the reference content from your code and docstrings, so you can skip manually creating a page for each modul…
Summary This version expands MkDocs compatibility with a native replacement for the rss plugin and support for mkdocstrings backlinks. Zensical can now generate RSS 2.0 and JSON Feed 1.1 feeds for created and updated pages. Python API documentation can also show which pages reference a documented object, with backlinks kept current across cached builds. Changelog Features e7876ab zensical, compat…
Summary Many of you have been waiting for this one: Zensical now includes native blog support. As a direct port of the Material for MkDocs blog plugin, it preserves the familiar configuration, metadata, URLs, archives, categories, authors, pagination, and more. We're happy to finally put it into your hands, with more flexible blogging functionality planned for the future. Changelog Features 582538…
Summary This version ensures pages containing snippets rebuild when source files change during local preview and excludes hidden files and directories from the generated site. It also fixes preview-site root redirects and returns proper 404 responses while preserving custom error pages. Additionally, the user interface is updated to v0.0.31, fixing empty submenus for sections containing only an in…
Summary This version adds support for the mkdocs-callouts plugin, which renders Obsidian-style callouts as admonitions. It also improves compatibility with existing MkDocs projects by accepting more plugin settings and fixes builds when the project configuration file is included in watch. Additionally, the user interface is updated to v0.0.30, ensuring that anchor links reveal targets inside colla…
Summary This version adds more comprehensive support for documentation redirects in mkdocs.yml and zensical.toml. Zensical supports page and anchor redirects, resolves redirect chains, rejects cycles, and preserves links when pages are moved or split. Anchor redirects Renaming a heading normally breaks bookmarks and external links to its old anchor. For example, after renaming ## Installation to #…
Summary This version updates the user interface to 0.0.28, fixing navigation pruning and alternate-link handling while adding 51 new icons. It also adds direct support for the table-reader plugin and fixes template inclusion with macros on Windows extended-length paths. Changelog Features 3b929cc compat – support table-reader plugin directly (not through macros) Bug fixes 82ece74 ui – update ui to…
Summary This version fixes navigation title precedence, Windows custom_dir paths, material/meta activation, and inline SVG icons processed by the minify plugin. Changelog Bug fixes 005f01f zensical – minify plugin breaks icons circle and rect elements 05f297e zensical, compat – respect navigation title precedence (#906) 96d43cd compat – custom_dir path interpreted incorrectly on Windows (#902) 9f1…
Summary This version marks a major evolution of Zensical's build architecture and completes the most essential MkDocs plugin replacements. Six new plugin replacements are now included: meta redirects minify tags literate-nav awesome-nav The existing search, mkdocstrings, and autorefs replacements have also been migrated to the new architecture. We kept their behavior close to the upstream plugins…
Summary This version improves compatibility with markdown-exec by supporting pymdownx blocks, raises the maximum HTTP header value size to 8 KiB for proxy-generated cookies, and updates the UI dependency stack and bundled icons. UI performance and palette tooltip behavior were also improved, especially on large pages and in Safari. Changelog Bug fixes 325758f ui – update ui to v0.0.26 7372e5b comp…
Summary This version fixes a regression introduced in 0.0.55, making Zensical report false positives for the deprecated unresolved_references setting. Additionally, checking of autorefs is moved to the invalid_links setting. Please disable unresolved_references - it is not supported anymore, and will be replaced by the reference parser that we're currently testing in Zensical Studio. Changelog Bug…
Summary This version fixes two false positives in the reference extractor and reverts Zensical's bootstrapped zensical.toml to TOML 1.0, since most editor tooling does not yet support TOML 1.1. Zensical understands both, TOML 1.0 and TOML 1.1, so this change does not affect the functionality of Zensical itself. Changelog Bug fixes 91d9d50 compat – ignore surrounding whitespace in inline link targe…
Summary This version reduces peak memory usage by 8–10x, making builds of large documentation projects substantially more efficient. It also improves reference validation by preventing false positives for links successfully resolved through autorefs. Additionally, the user interface is updated to v0.0.25, fixing instant navigation for inline scripts and version aliases created with mike. This rele…
Summary This version adds support for enabling strict mode directly in mkdocs.yml or zensical.toml, allowing warnings to fail builds consistently without the --strict command-line option. It also reduces memory usage by sharing cross-reference data between navigation clones. Additionally, the user interface is updated to v0.0.24, improving search rendering for right-to-left languages and adding fo…
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…