Add typedoc (#9)

.github/workflows/check.yml

@@ -124,3 +124,14 @@ jobs:
           node_version: ${{ matrix.node }}
       - name: Typecheck
         run: npm run typecheck
+  docs:
+    name: Docs
+    runs-on: ubuntu-latest
+    timeout-minutes: 30
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v4
+      - name: Setup
+        uses: ./.github/actions/setup
+      - name: Build docs
+        run: npm run docs:build

.gitignore

@@ -13,6 +13,7 @@
 !ava.config.js
 
 # Build directories
+docs
 package
 
 # Environment versions file

package.json

@@ -49,6 +49,7 @@
     "prebuild:ts": "del 'index.*' lib",
     "postbuild:ts": "tsc-alias --project tsconfig.build.json",
     "typecheck": "tsc",
+    "docs:build": "typedoc",
     "test": "c8 ava",
     "pretest": "tsx src/index.ts",
     "test:update": "ava --update-snapshots",
@@ -84,6 +85,7 @@
     "tsc-alias": "^1.8.2",
     "tsup": "^8.0.1",
     "tsx": "^4.6.2",
+    "typedoc": "^0.26.2",
     "typescript": "~5.3.3",
     "zod": "^3.23.8"
   }

typedoc.json

@@ -0,0 +1,10 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "includeVersion": true,
+  "entryPoints": ["src/index.ts"],
+  "out": "docs",
+  "tsconfig": "./tsconfig.build.json",
+  "navigationLinks": {
+    "GitHub": "https://github.com/seamapi/blueprint"
+  }
+}

vercel.json

@@ -0,0 +1,48 @@
+{
+  "buildCommand": "npm run docs:build",
+  "installCommand": "npm ci",
+  "outputDirectory": "docs",
+  "github": {
+    "silent": true
+  },
+  "cleanUrls": true,
+  "headers": [
+    {
+      "source": "/(.*)",
+      "headers": [
+        {
+          "key": "Content-Security-Policy",
+          "value": "default-src 'self'; script-src 'self' 'unsafe-inline'; connect-src 'self' data:; img-src 'self' https://img.shields.io https://github.com; style-src 'self' 'unsafe-inline'"
+        },
+        {
+          "key": "X-DNS-Prefetch-Control",
+          "value": "on"
+        },
+        {
+          "key": "Referrer-Policy",
+          "value": "same-origin"
+        },
+        {
+          "key": "Strict-Transport-Security",
+          "value": "max-age=63072000; includeSubdomains; preload"
+        },
+        {
+          "key": "X-Content-Type-Options",
+          "value": "nosniff"
+        },
+        {
+          "key": "X-Frame-Options",
+          "value": "SAMEORIGIN"
+        },
+        {
+          "key": "X-XSS-Protection",
+          "value": "1; mode=block"
+        },
+        {
+          "key": "Permissions-Policy",
+          "value": "geolocation=(), camera=(), microphone=(), payment=()"
+        }
+      ]
+    }
+  ]
+}