Zensical

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") }}

Additionally, the stability of link validation has been drastically improved, reducing the rate of false positives. We're working on support for validating links using autorefs, which we'll provide in one of the next versions.

Changelog

Features

• d24ea24 compat – support table reader functionality
• 2cbb33d compat – support watch option (#643)

Bug fixes

• 9e466fc ui – update ui to v0.0.17
• bee1c3f compat – give higher priority than superfences to macros preprocessor (#638)

Refactorings

• 67b6ef1 compat – make extensions consistent
• bf26d1b zensical, compat – implement parser for link validation

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 need to be aware of the rest of Zensical's rendering process, except for the current page and configuration. The benefit is that it can now also be used in Python docstrings to build API documentation with mkdocstrings.

Changelog

Features

• 36b5131 compat – exclude macros blocks from link validation
• f7fe088 compat – support macros plugin

Bug fixes

• bdc3471 ui – update ui to v0.0.16
• 4be2374 compat – link validation doesn't catch end of MathJax when \r present (#615)
• c6cffec compat – link validation exclusions don't catch \r\n line feeds
• 6efe0a3 compat – link validation exclusions require empty line after code block (#618)
• 645bbe8 zensical – clear site directory contents instead of removing it (#621)
• 814d2e9 zensical – link validation yields false positives on Windows (#616)
• b229bac zensical-serve – zensical serve returns 404 after suspend (#574)
• b5492ce compat – shim for mkdocs-glightbox fails when only defaults are set (#611)

Refactorings

• 91090e9 zensical, compat – combine file watching for extensions
• b2fdc78 zensical, compat – pass rendering context into preprocessor

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 extracted from combined anchor-text-fragment
• 273dd23 compat – auto-themed gallery takes precedence over explicit grouping
• c050add compat – error when setting caption_position on glightbox extension (#604)
• 699d3be zensical – add Python backtrace on Markdown rendering error

Refactorings

• 3e27d69 compat – move glightbox config options to dataclass