Skip to content

Limitations

zmerge only bridges the gap until Zensical supports merging projects natively (zensical/backlog#22, #44, #110); then zmerge will be retired (#18). These features aren't supported yet; the backlog tracks them:

  • Edit and view links of project pages point to the umbrella repository, because Zensical has no per-page edit URL (#9).
  • Theme overrides, extra and analytics of projects are ignored; only the umbrella's are used (#10).
  • mkdocs.yml projects can't be included, only zensical.toml (#11).
  • Wildcard includes like *include ./projects/*/zensical.toml (#12).
  • Conflicting JavaScript, e.g. one project using MathJax and another KaTeX, is loaded on every page (#13).
  • Links in raw HTML and in snippets aren't rewritten (#14).
  • Versioned docs with mike (#15).
  • zmerge serve doesn't watch mkdocstrings sources and snippet files outside the docs (#16).
  • mkdocstrings handlers other than Python can't restore option defaults per project (#17).