Back in March this year I dipped my toe into trying out Zensical as a replacement for MkDocs/mkdocs-material. At the time I had success with using it as a drop-in replacement for a project, and following that used it for a couple more. All was good.
In that post, towards the end, I also said:
The next test will be to try the docs for something like Hike. They're a little bit more involved, with SVG-based screenshots being generated at build time, etc. If that just works out of the box too, without incident, I think I'm all sorted.
I did try this, but ran into a problem: the screenshots took ages to build. At that point I decided to put the PR on the back-burner and only use Zensical for more static-like sites.
A couple of days ago I noticed that v0.1.0 had been released, and with it this claim:
This release closes the major remaining compatibility gaps with MkDocs, including support for many of its most widely used plugins. You can bring your existing MkDocs project to Zensical and continue using the workflows you're familiar with.
With this I was reminded that I'd not gone back and tried to use it again. So I took the Hike PR, upgraded Zensical, rebuilt the docs and... pretty much as fast as MkDocs! The result, style changes aside, looked the same too.
Given that it seemed to be working fine, I decided to start again from scratch with my current pet project of choice: Rogallo. I removed MkDocs/mkdocs-material, added Zensical, tweaked the Makefile, ran make
rtfm and... crash! The error being along the lines of:
RuntimeError: Python error: FileNotFoundError: [Errno 2] No such file or directory: '[...]/site-packages/zensical/templates/.icons/simple/cplusplus.svg'
I tweaked a couple of things to eliminate anything particular about my environment (in the case of Rogallo, SmolServe is used to run Zensical, to ensure there's a test server available for making the screenshots, so I wanted to ensure that it wasn't some fallout from that setup), but the problem remained.
I then hit the issues and did a quick search; it turned out it was a known issue and, in my case, was easily fixed with a quick make
update (resolving the issue that markdown-exec had a small bug that had subsequently been addressed).
So, as of today, I've swapped Rogallo over to using Zensical for its documentation and, so far, it looks to be working out well. From my perspective the claim of it being a drop-in replacement is 100% true.
My only quibble: I wish they supported a zensical.yml configuration file. From what I can tell it's zensical.toml or mkdocs.yml, so no satisfying mv mkdocs.yml zensical.yml to be had here.
I think I can cope with that, though.










