Skip to content

Generate TypeScript API documentation #4

@samuelmaddock

Description

@samuelmaddock

It'd be nice to generate documentation for code exported in index.ts.

Since we're using TypeScript, this can be done easily with https://typedoc.org/

The tsconfig.json likely needs to be updated to output typescript definition files (.d.ts). 21a5ce8

Metadata

Metadata

Assignees

No one assigned

    Labels

    documentationImprovements or additions to documentationhelp wantedExtra attention is needed

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions