Skip to content

Swap to Zensical - #152

Draft
davep wants to merge 2 commits into
mainfrom
zensical
Draft

davep wants to merge 2 commits into
mainfrom
zensical

Conversation

@davep

@davep davep commented Mar 7, 2026 •

Copy link
Copy Markdown
Owner

Experiment with swapping from MkDocs to Zensical.

Currently keeping this in draft because I'm finding that Zensical takes about 10 times longer to generate the docs than MkDocs does; it seems to get bogged down badly when doing the screenshots.

To compare, here's the times when building the docs on my 2019 Intel MacBook Pro:

Executed in   57.17 secs    fish           external
   usr time   38.55 secs    0.22 millis   38.55 secs
   sys time    1.30 secs    1.56 millis    1.30 secs

same machine, but with this PR's branch (and so using Zensical):

Executed in  541.86 secs    fish           external
   usr time  542.42 secs    0.26 millis  542.42 secs
   sys time    3.39 secs    1.82 millis    3.39 secs

In both cases this was building the docs from scratch, clean clone, make setup performed first.

@davep davep self-assigned this Mar 7, 2026
@davep davep added Documentation Improvements or additions to documentation Enhancement New feature or request labels Mar 7, 2026
@davep

davep commented Mar 18, 2026

Copy link
Copy Markdown
Owner Author

@davep

davep commented Nov 5, 2026

Copy link
Copy Markdown
Owner Author

Somewhat later in the year.... Zensical v0.1.0 is working out much better. The docs look pretty much one-for-one (style changes aside) and the build speed seems on par with what I would expect from MkDocs.

This branch has not been deployed

No deployments
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Documentation Improvements or additions to documentation Enhancement New feature or request

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant