Skip to main content
Version: v0.0.1

API reference

This site publishes two “reference-mode” artifacts in addition to the narrative deep-dive:

  • C API reference (Doxygen): Open
  • Zig wrapper reference (Zig HTML docs): Open
Pitfall

These pages are generated during the docs build. If you are running locally and the links 404, generate them first (see below). The C API reference requires doxygen to be installed.

Checklist

From docs/:

  • npm run gen:api
  • npm run build (or npm run start)