Commit Graph

101 Commits

Author SHA1 Message Date
squidfunk db8518dc3a feature: add plugin compatibility shim for glightbox
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-23 11:58:00 +02:00
squidfunk 5c1f3817df chore: fix import order
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-23 11:41:00 +02:00
squidfunk 057da7c2c7 feature: add support for image galleries using glightbox (#290)
Co-authored-by: Timothée Mazzucotelli <dev@pawamoy.fr>
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-23 11:36:13 +02:00
squidfunk 98a8e73833 docs: unify wording in comments
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-23 11:29:47 +02:00
Martin Donath 8f5f584b9a feature: update configuration parser to TOML v1.1.0
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-18 17:17:59 +02:00
Florian Scheuner 670834fb04 fix: inhibit instant previews on footnote backrefs
Signed-off-by: Florian Scheuner <github@florian-scheuner.de>
2026-04-18 11:43:52 +02:00
Timothée Mazzucotelli 7076f8d4b3 fix: update README.html links to index.html links when directory URLs aren't set (#531)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-04-15 09:55:35 +00:00
Timothée Mazzucotelli 3593ecc44d chore: remove unused import
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-04-15 09:49:15 +00:00
Alexander Voss bb58c5d5e2 fix: out of date help message (#524)
Signed-off-by: alexvoss <alex@corealization.com>
2026-04-13 18:32:20 -04:00
my1e5 20d94ade33 refactor: update GitHub workflows to Node 24 (#522)
Signed-off-by: my1e5 <10064103+my1e5@users.noreply.github.com>
2026-04-13 16:45:18 +02:00
Martin Donath 9bff25ac68 fix: add missing configuration for default Markdown Extensions
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-09 13:35:35 +02:00
Martin Donath 6871d33339 feature: add default Markdown Extensions to bootstrapped zensical.toml
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-04-08 14:48:45 +02:00
Timothée Mazzucotelli 24be9abba9 fix: support pymdownx blocks tab extension's slugify function (#483)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-03-31 18:10:24 +00:00
Martin Donath 77a08d987f feature: add support for mike
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-03-28 12:35:07 +01:00
Timothée Mazzucotelli 25e8c5390b fix: validate docs-directory and custom-theme-directory (#475)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-03-27 16:06:53 +01:00
Timothée Mazzucotelli c1860cab1e fix: leave absolute links untouched (#466)
We match MkDocs' behavior by leaving absolute links untouched (no scheme, no netloc but starting with /). We do not prepend the configured site URL to these links, as users might rely on this behavior.

Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-03-24 12:42:24 +01:00
Alexander Voss 5196cdbf54 fix: invalid setup of MathJax in bootstrapped zensical.toml
Signed-off-by: alexvoss <alex@corealization.com>
2026-03-19 15:14:37 +01:00
Woody 7514e32295 fix: replace codecs.open, deprecated in Python 3.14 (#429)
Signed-off-by: kwag93 <kwag93@naver.com>
2026-03-11 08:13:15 +01:00
Pratyush Sharma 6c911cafc9 fix: watch auto-appended pymdownx.snippets files for changes (#148)
Signed-off-by: Pratyush Sharma <56130065+pratyush618@users.noreply.github.com>
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
Co-authored-by: squidfunk <martin.donath@squidfunk.com>
2026-03-10 17:00:28 +01:00
Ryan Luu ea57e0ba33 chore: fix typos in zensical.toml
Signed-off-by: Ryan Luu <ryan.luu@ryanluu.dev>
2026-03-06 11:31:26 +01:00
Timothée Mazzucotelli bf930dd84b fix: hash plugins config to trigger page rebuilds (#387)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-26 14:12:17 +01:00
Martin Donath b93d630c0a fix: clarify examples in bootstrapped zensical.toml (#394)
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-02-26 12:58:30 +01:00
Timothée Mazzucotelli 798da3350a fix: ignore virtual environments in mkdocstrings sources (#391)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-24 16:09:55 +01:00
Timothée Mazzucotelli 10b5162aa6 fix: lazy import mkdocstrings (#360)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-11 22:09:10 +01:00
Timothée Mazzucotelli e33c972e03 fix: don't watch mkdocstrings-configured path if it's the root directory
This is a follow-up of commit 6e3d5ef64b which was actually incomplete. Since a/ is relative to a/, we also have to check that a path configured through mkdocstrings-python's  option isn't the project root itself.

Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-11 16:26:36 +01:00
Timothée Mazzucotelli e32ab15b1f feature: support autorefs plugin
This change brings support for using autorefs without mkdocstrings.

In order to support that, we incorporate Zensical-related code from mkdocstrings within our code base, for better control (and much more elegant logic).

Before, mkdocstrings would expose a Markdown extension as "mkdocstrings", that Zensical would add (as a string) to its configured Markdown extensions list when detecting the plugin. Now, Zensical instantiates the extension itself (which simplifies things a lot since we don't have to synchronize releases -and therefore code!- of Zensical and mkdocstrings).

Instead of having several possible sources for autorefs data (mkdocstrings and autorefs itself), we use a global data store that both autorefs and mkdocstrings reuse to register data. Zensical can simply retrieve this data when ready, with a call_method0 Pyo3 call (like before).

We instantiate the autorefs Markdown extension ourselves too, while mocking the classes used by mkdocstrings (autorefs plugin, MkDocs pages) to provide the same interface. What's nice about this is that we can now set the current page being rendered in autorefs without having to inject a dummy Markdown processor (that would before just act as a data store, for mkdocstrings to retrieve the current page and set it on the autorefs plugin instance). Since we control the (mocked) plugin, we can easily change its current page attribute.

This change effectively decouples Zensical from mkdocstrings, which means users upgrading Zensical don't even have to upgrade mkdocstrings.

Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-10 21:35:20 +01:00
Timothée Mazzucotelli e233f9f7d4 fix: fail early if mkdocstrings is enabled but not installed (#338)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-10 12:27:54 +01:00
Timothée Mazzucotelli 7e6ef17382 fix: create previews when target is current page (#330)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-02-04 15:35:50 +01:00
Tyrone Meijn 6643eb922f fix: invalid links to content actions in bootstrapped zensical.toml
Signed-off-by: Tyrone Meijn <tyrone_meijn@outlook.com>
2026-02-01 14:52:54 +01:00
Jens 5e58e169be docs: improve comment on tooltips in boostrapped zensical.toml
Signed-off-by: Jens <64728985+Jens-Unsinn@users.noreply.github.com>
2026-02-01 11:34:11 +01:00
Timothée Mazzucotelli 26fe17dc62 refactor: retrieve autorefs once (#98)
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-01-29 13:18:26 +01:00
Martin Donath dffcb1f5c2 chore: fix typo in bootstrapped zensical.toml (#303)
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-01-25 10:54:55 +01:00
Timothée Mazzucotelli 6e3d5ef64b fix: don't watch external sources (#301)
issue #294

Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-01-23 17:25:59 +01:00
squidfunk 446217e7c6 refactor: switch to conservative auto-reload for source files
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-01-23 13:14:56 +01:00
Martin Donath 1877aeb8cd fix: reload loop when mkdocstrings loads modules from . (#294)
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-01-23 12:52:25 +01:00
Timothée Mazzucotelli 1c5e3646be feature: support API cross-references
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2026-01-19 12:59:10 +01:00
Timothée Mazzucotelli f3e2620e5a fix: watch mkdocstrings source files for auto-reload
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
Co-authored-by: squidfunk <martin.donath@squidfunk.com>
2026-01-19 11:32:22 +01:00
Martin Donath 24e2168d80 feature: allow arbitrary admonition icon keys
* feat: allow arbitrary admonition icon keys

Signed-off-by: banteg <4562643+banteg@users.noreply.github.com>

* fix: non-string values not handled correctly with custom admonitions

Signed-off-by: squidfunk <martin.donath@squidfunk.com>

---------

Signed-off-by: banteg <4562643+banteg@users.noreply.github.com>
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
Co-authored-by: banteg <4562643+banteg@users.noreply.github.com>
2026-01-15 15:56:48 +01:00
Eden Yemini 4e14472f98 chore: update bootstrap copyright year to 2026
Signed-off-by: Eden Yemini <eden881@gmail.com>
2026-01-13 14:30:58 +01:00
squidfunk 50444252d8 chore: update copyright year to 2025-2026
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2026-01-02 12:33:41 +01:00
Timothée Mazzucotelli 76de3b6f9c chore: lint long lines
Signed-off-by: Timothée Mazzucotelli <dev@pawamoy.fr>
2025-12-22 11:50:36 +01:00
Martin Donath 2e31b939b9 fix: missing custom_dir setting crashes build
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2025-12-21 16:02:57 +01:00
squidfunk f5dde30fdf fix: changes to templates do not trigger rebuild (#103)
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2025-12-21 15:22:33 +01:00
squidfunk 0a4663ca36 style: auto-fix formatting
Signed-off-by: squidfunk <martin.donath@squidfunk.com>
2025-12-21 15:15:51 +01:00
Amy Bordenave 6faedd66a9 docs: fix grammar in zensical.toml
Signed-off-by: Amy Kate Bordenave <amykateb@uw.edu>
2025-12-21 10:07:26 +01:00
alexvoss 05feb1e5dd fix: defined repo_name replaced with host name (#205)
A logic error caused a defined `repo_name` to be overwritten by the host name from the `repo_url`.

Signed-off-by: alexvoss <alex@corealization.com>
2025-12-18 11:34:59 -05:00
Timothée Mazzucotelli 3377579796 zensical:fix - Make kwargs unpacking for custom fence/toc slugify function more robust (#197)
Signed-off-by: pawamoy <dev@pawamoy.fr>
2025-12-15 13:04:16 +01:00
Timothée Mazzucotelli e4fa679599 zensical:fix - Support keywords for custom fence formatter/validator (#196)
#193

Signed-off-by: pawamoy <dev@pawamoy.fr>
2025-12-15 13:01:49 +01:00
Alexander Voss 104b5ee62c zensical:fix - content.action buttons not displayed
#188
2025-12-12 14:37:36 -05:00
Martin Donath 3e402ef3be Merge pull request #194 from zensical/fix/stop-setting-extra-defaults
zensical:fix - Stop setting default values for keys under extra
2025-12-12 20:35:26 +01:00