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
- Generate API docs:
npm run docs:api- Build the MkDocs site:
python -m pip install mkdocsnpm run docs:site
Generated output:
- TypeDoc HTML:
docs/api/ - Combined site:
site/