diff --git a/.github/workflows/typedoc.yaml b/.github/workflows/typedoc.yaml
new file mode 100644
index 0000000..13ddce9
--- /dev/null
+++ b/.github/workflows/typedoc.yaml
@@ -0,0 +1,54 @@
+# Simple workflow for deploying static content to GitHub Pages
+name: Deploy typedoc to Pages
+
+on:
+ # Runs on pushes targeting the default branch
+ push:
+ branches: ["master"]
+
+ # Allows you to run this workflow manually from the Actions tab
+ workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+ contents: read
+ pages: write
+ id-token: write
+
+# Allow only one concurrent deployment, skipping runs queued between the run in-progress and latest queued.
+# However, do NOT cancel in-progress runs as we want to allow these production deployments to complete.
+concurrency:
+ group: "pages"
+ cancel-in-progress: false
+
+jobs:
+ # Single deploy job since we're just deploying
+ deploy:
+ environment:
+ name: github-pages
+ url: ${{ steps.deployment.outputs.page_url }}
+ runs-on: ubuntu-latest
+ steps:
+ - name: Checkout
+ uses: actions/checkout@v3
+ - name: Set up Node.js
+ uses: actions/setup-node@v3
+ with:
+ node-version: 18
+ cache: npm
+ - name: Install TS Project dependencies
+ run: npm ci
+ - name: build packages
+ run: npm run build
+ - name: build docs
+ run: npx typedoc
+ - name: Setup Pages
+ uses: actions/configure-pages@v3
+ - name: Upload artifact
+ uses: actions/upload-pages-artifact@v1
+ with:
+ # Upload docs directory
+ path: './docs'
+ - name: Deploy to GitHub Pages
+ id: deployment
+ uses: actions/deploy-pages@v2
\ No newline at end of file
diff --git a/README.md b/README.md
index 930d794..0ad98c6 100644
--- a/README.md
+++ b/README.md
@@ -9,6 +9,10 @@ this package provides common Map-Colonies types
$ npm install @map-colonies/types
```
+
+## Documentation
+All the code in the package is documented using TypeDoc. The auto generated site is available at [here](https://mapcolonies.github.io/types/).
+
### Usage
```typescript
diff --git a/docs/enums/Artifact3DType.html b/docs/enums/Artifact3DType.html
index 300f077..2c78247 100644
--- a/docs/enums/Artifact3DType.html
+++ b/docs/enums/Artifact3DType.html
@@ -16,7 +16,7 @@
Artifact3DType
Enumeration Artifact3DType
+Defined in enums/common/artifact.ts:21
-MODEL_3D
+MODEL_3D
MODEL_3D: "MODEL_3D"
+Defined in enums/common/artifact.ts:22
-THUMBNAILS_LARGE
+THUMBNAILS_LARGE
THUMBNAILS_LARGE: "THUMBNAILS_LARGE"
+Defined in enums/common/artifact.ts:26
-THUMBNAILS_MEDIUM
+THUMBNAILS_MEDIUM
THUMBNAILS_MEDIUM: "THUMBNAILS_MEDIUM"
+Defined in enums/common/artifact.ts:25
-THUMBNAILS_SMALL
+THUMBNAILS_SMALL
THUMBNAILS_SMALL: "THUMBNAILS_SMALL"
+Defined in enums/common/artifact.ts:24
+Artifact3DType
+ArtifactDEMType
+ArtifactRasterType
+Domain
+Kind
+Unit
+Epsg
+EpsgCode
+TilesMimeFormat
+EPSGDATA
+contentType
+lookup