mirror of
https://github.com/aphrody-labs/typesafe-sdk-js.git
synced 2026-10-14 04:09:12 +00:00
8cba243dab
Co-authored-by: Allie Laabs <OverloadUT@gmail.com> Co-authored-by: Allie Laabs <allie@typesafe.ai> Co-authored-by: Evin Sellin <evinism@gmail.com>
760 B
760 B
Generate the API reference
From the SDK source checkout, run:
npm run docs
This installs the locked documentation dependencies and generates Markdown
reference pages and navigation.json in build/docs/. No API key is needed.
To regenerate after editing source comments without reinstalling dependencies:
npm run --prefix docs build
TypeDoc reads the public exports from src/index.ts and their JSDoc comments.
Update the source comments to change the reference. Generated files are ignored
by Git, and generation fails on warnings.
The documentation toolchain uses TypeScript 6 because TypeDoc does not yet
support the SDK's TypeScript 7 compiler. Its dependencies are isolated in
docs/; the SDK build uses its own compiler.