1
0
Fork
You've already forked zig-mathdoc
0
Augment zig's docs generation to enable math rendering.
  • HTML 52.9%
  • JavaScript 35.8%
  • Shell 11.3%
2025年12月06日 20:27:57 +05:30
links.html Update KaTeX version 2025年12月06日 20:27:57 +05:30
math.sh Initial commit 2025年12月06日 19:36:56 +05:30
README.md Initial commit 2025年12月06日 19:36:56 +05:30
script.js Initial commit 2025年12月06日 19:36:56 +05:30

zig-mathdoc

zig-mathdoc augments generated docs for zig code to enable rendering math equations. It does this by stitching in <link>s to KaTeX stuff to docs/index.html and the necessary code to transform text in the document to rendered math in like 668 of docs/main.js (which is the end of the navigate() function).

Usage

Usage is pretty simple: Generate docs with whatever setup you have (zig-mathdoc does not do this for you), and then run math.sh. Both links.html and script.js should be alongside math.sh so perhaps put these 3 files in their own folder and add that to PATH or something.