Math3D Docs

This site combines:

  • Project guides and operational docs (MkDocs content).
  • Full API reference generated from TypeScript sources (TypeDoc output).
  • Architecture docs for cross-runtime workspace planning.
  • Runtime architecture overview: runtime-architecture.md (Electron main thread, React renderer, Python worker with CGAL/VTK).
  • Install and run modes guide: install-and-run-modes.md (desktop, browser, and Docker browser modes, including worker requirements).
  • Repository folder map: repository-layout.md.

Build locally

  1. Generate API docs:
  2. npm run docs:api
  3. Build the MkDocs site:
  4. python -m pip install mkdocs
  5. npm run docs:site

Generated output:

  • TypeDoc HTML: docs/api/
  • Combined site: site/