chore(deps): update dependency zensical to v0.0.43#764
Merged
Conversation
b628b0e to
7d47afb
Compare
7d47afb to
112d456
Compare
112d456 to
89f4c8f
Compare
89f4c8f to
de2c066
Compare
de2c066 to
edbcd30
Compare
adef2e6 to
f8a656a
Compare
f8a656a to
8b69e9c
Compare
0de9274 to
eb1093b
Compare
1a5d8da to
61c2957
Compare
61c2957 to
e0d2c65
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
This PR contains the following updates:
==0.0.28→==0.0.43Release Notes
zensical/zensical (zensical)
v0.0.43: 0.0.43Compare Source
Summary
This version fixes further edge cases in link validation, and adds support for UTF-8 encoding with byte-order-marks.
Changelog
Bug fixes
1e873a3compat – ignore links in code after literal dollar during link validation (#691)62a0febzensical – reportpath.md/#anchoras invalid during link validation (#690)7be40c6compat – ignore GitHub-style callouts during link validation (#688)85c3b1ecompat – ignore[TOC]marker during link validation (#686)daafc8bzensical – filter out icons folder when watching theme directories (#693)913fd61zensical – strip Byte-Order-Mark (BOM) from Markdown files (#687)v0.0.42: 0.0.42Compare Source
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 towatch. Moreover, GLightbox is now only downloaded when needed, which fixes an issue when using Zensical in air-gapped environments.Changelog
Bug fixes
6b54e14ui – update ui to v0.0.18cdee1e8zensical – disabling link validation doesn't disable link and reference collection (#659)4355dadcompat – harden link validation for files with CRLF line endingsa418c6bcompat – link validation doesn't ignore fenced code blocks when\ris presentb31dd14compat –$at end of line breaks link validation (#659)17c67a2compat – remove abbreviations from table of contents (#669)6eb2f4dcompat – reserve theme namezensicala5a8641zensical – only wait for config update after a first successful build (#670)8207554compat – don't consider[]and[][]link references (#663)c338b27compat – two backticks with no closing run trip up link parser (#663, #665)d707aa9compat – prevent reload loop by de-duplicating watched theme files (#655)Refactorings
53f593fcompat – avoid mutating configurations lista77087acompat – reorganize config modulev0.0.41: 0.0.41Compare Source
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
watchoption 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: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
d24ea24compat – support table reader functionality2cbb33dcompat – support watch option (#643)Bug fixes
9e466fcui – update ui to v0.0.17bee1c3fcompat – give higher priority than superfences to macros preprocessor (#638)Refactorings
67b6ef1compat – make extensions consistentbf26d1bzensical, compat – implement parser for link validationv0.0.40: 0.0.40Compare Source
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
36b5131compat – exclude macros blocks from link validationf7fe088compat – support macros pluginBug fixes
bdc3471ui – update ui to v0.0.164be2374compat – link validation doesn't catch end of MathJax when\rpresent (#615)c6cffeccompat – link validation exclusions don't catch\r\nline feeds6efe0a3compat – link validation exclusions require empty line after code block (#618)645bbe8zensical – clear site directory contents instead of removing it (#621)814d2e9zensical – link validation yields false positives on Windows (#616)b229baczensical-serve –zensical servereturns 404 after suspend (#574)b5492cecompat – shim formkdocs-glightboxfails when only defaults are set (#611)Refactorings
91090e9zensical, compat – combine file watching for extensionsb2fdc78zensical, compat – pass rendering context into preprocessorv0.0.39: 0.0.39Compare Source
Summary
This version fixes several bugs related to link validation and lightbox configuration.
Changelog
Bug fixes
fe42fc4compat – shim for MkDocs validation syntax overrides Zensical's (#607)acc2620zensical – validation doesn't correctly map percent-encoded links (#598)da317bfcompat – add$...$and$$...$$blocks to exclusions for link validation (#599)94f0d29zensical – anchor not extracted from combined anchor-text-fragment273dd23compat – auto-themed gallery takes precedence over explicit groupingc050addcompat – error when settingcaption_positiononglightboxextension (#604)699d3bezensical – add Python backtrace on Markdown rendering errorRefactorings
3e27d69compat – moveglightboxconfig options to dataclassv0.0.38: 0.0.38Compare Source
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, as well as unused and shadowed definitions – covering the full lifecycle of a reference from definition to use.
Validation
Zensical scans every Markdown file in your project and resolves all internal references against each other: inline links, reference-style links, footnotes, link definitions, and anchor targets. Every check is individually configurable and enabled by default.
The following checks for links and footnotes are now available:
unresolved_referencesunresolved_footnotesunused_definitionsunused_footnotesshadowed_definitionsshadowed_footnotesinvalid_linksinvalid_link_anchorsStrict mode
The new
--strictcommand line flag causes the build to fail when any enabled validation check triggers, turning warnings into errors. This is useful for CI pipelines where you want to enforce link integrity and prevent broken documentation from being published:Upgrading
No changes to your configuration are required – all checks are enabled by default. It's quite likely that you'll run into at least some warnings – as we did – when upgrading, since before, it was easy to miss unused link definitions or unresolved references. If you want to disable validation entirely, you can use:
As always, if you run into any problems, please open an issue.
Changelog
Features
201c615zensical, compat – add link and footnote validation and--strictmode (#175)Refactorings
b3c1d91zensical, compat – add custom Markdown subclassesce8cbf8zensical – simplify function definitions afterzrxupgradev0.0.37: 0.0.37Compare Source
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.themesentrypoint, to allow users that already have derivations of Material for MkDocs to run them on Zensical. In the coming months, with the advent of the component system, we'll make this process much more flexible and foster reuse at the component level. For now, this is a first step to allow sharing of theme overrides and default configurations inside organizations with dozens or even thousands of projects.Changelog
Features
7694535zensical, compat – installable theme extensions (#511)Bug fixes
72ba122compat – sanitize nested metadata (#582)2fb663ecompat – text adjacent to image included in link to open image in lightbox (#579)dc32bafcompat – anchor links preserved in table of content section titles (#578)127648ecompat – attributes not applied to lightbox imagesRefactorings
9872092compat – subclassMarkdownprocessors to extend functionalityfdeb061compat – use identical name for tree- and post-processorv0.0.36: 0.0.36Compare Source
Summary
This version adds the missing update of the user interface that should've been included with v0.0.35.
Changelog
Bug fixes
d4d88f8ui – update ui to v0.0.15v0.0.35: 0.0.35Compare Source
Summary
This version adds native support for GLightbox, a JavaScript lightbox library to add zoom and gallery features to images. Images can be automatically annotated with the new
glightboxMarkdown extension. Add the following tozensical.toml:HTML in the table of contents
Additionally, section titles in the table of contents will now render with HTML markup, so you can use emojis and other inline features in section titles and have them render correctly in the table of contents. In Material for MkDocs, this functionality was implemented with the
typesetplugin. Zensical now supports this natively.Relative links in raw HTML
Relative links in raw HTML are now correctly resolved. Initially, we carried over the link processing and resolution logic from MkDocs, which does not support relative links in raw HTML to this day. We implemented a Python Markdown postprocessor, to ensure that relative links in raw HTML are handled as well.
Changelog
Features
5519730zensical, compat – render section title with markup in table of contentsdb8518dcompat – add plugin compatibility shim forglightbox057da7ccompat – add support for image galleries usingglightbox(#290)Bug fixes
64f3f33compat – relative links in raw HTML not correctly resolved (#258)87abb2acompat – removeimgattributes moved to parent inGLightboxExtensionf7531afcompat – images in raw HTML are double-processed byGLightboxExtension1d8dc83compat – ensureNoneattributes are not added byGlightboxExtension773fa76zensical – support uv's symlink mode (#557)Refactorings
7c977a8compat – moveGLightboxextension to regularPostprocessorv0.0.34: 0.0.34Compare Source
Summary
This version moves Zensical to the latest version of ZRX, the foundation for Zensical and its ecosystem. It includes the module system, as well as a ground up rewrite of the scheduler and streaming API. We did extensive testing with several hundred projects we obtained from GitHub, so we don't expect any issues. However, if you encounter any problems, please let us know.
Moreover, this version ships support for usage of TOML v1.1.0 in
zensical.toml, which allows new lines in inline tables. Thus, configuration files can now be made more readable, especially when they contain long lists of items. For example:Prior to this version
With this version
Additionally, Markdown pages with snippets are now rebuilt when snippets are updated, and an issue with breadcrumbs was fixed when the top-level
index.mdwas not at the root of explicit navigation.Changelog
Features
8f5f584compat – update configuration parser to TOML v1.1.0Bug fixes
2461bd6ui – update ui to v0.0.14670834fcompat – inhibit instant previews on footnote backrefsd24ba8azensical – Markdown pages with snippets not rebuilt when snippet changes (#526)7076f8dcompat – updateREADME.htmllinks toindex.htmllinks when directory URLs aren't set (#531)4b9ed87zensical – don't consider non-rootindex.mda homepage, like MkDocs (#476)25f9ad6– bumprandto 0.9.4 to mitigate CVERefactorings
50aa8a5zensical, zensical-watch – update to zrx to v0.0.21v0.0.33: 0.0.33Compare Source
Summary
This version updates our official Docker image to be based on Alpine Linux for better compatibility and ease of use. It also adds all recommended Markdown Extensions to the generated
zensical.tomlfile when bootstrapping a project withzensical new, ensuring a smoother setup experience. Additionally, the user interface is updated to v0.0.13, which includes two bug fixes for anchor links in the table of contents.Changelog
Breaking changes
4eb05a2docker – switch base image to Alpine Linux for ease of use (#510)Features
6871d33compat – add default Markdown Extensions to bootstrappedzensical.tomlBug fixes
bb8a7e5ui – update ui to v0.0.13bb58c5dcompat – out of date help message (#524)9bff25acompat – add missing configuration for default Markdown ExtensionsRefactorings
20d94adcompat – update GitHub workflows to Node 24 (#522)v0.0.32: 0.0.32Compare Source
Summary
This version fixes a bug where Markdown files used as snippets were included into auto-generated navigation, and a bug with prefix stripping when the site URL contains a path component. Additionally, the Pygments dependency was updated to mitigate a vulnerability.
Changelog
Bug fixes
ca5d2d5zensical-serve – strip base URL prefix as URL segment, not string (#499)3a2358a– update to latest Pygments to mitigate vulnerability (#485)92b5622zensical – only collect markdown pages in docs directory (#490)v0.0.31: 0.0.31Compare Source
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
198c1d6ui – update ui to v0.0.1224be9abcompat – support pymdownx blocks tab extension's slugify function (#483)v0.0.30: 0.0.30Compare Source
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
77a08d9compat – add support formikeBug fixes
97cdbc8ui – update ui to v0.0.1125e8c53compat – validate docs-directory and custom-theme-directory (#475)v0.0.29: 0.0.29Compare Source
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
c1860cacompat – leave absolute links untouched (#466)6775b75zensical – canonicalize watched paths (#451)Configuration
📅 Schedule: (UTC)
🚦 Automerge: Disabled by config. Please merge this manually once you are satisfied.
♻ Rebasing: Whenever PR is behind base branch, or you tick the rebase/retry checkbox.
🔕 Ignore: Close this PR and you won't be reminded about this update again.
This PR was generated by Mend Renovate. View the repository job log.