Generate docs with typedoc

.github/workflows/docs.yml

@@ -0,0 +1,50 @@
+name: Docs
+
+on:
+  push:
+    branches:
+    - main
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+jobs:
+  docs:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Pages
+      uses: actions/configure-pages@v1
+    - name: Set up Node.js
+      uses: actions/setup-node@v3
+      with:
+        node-version: 17
+    - name: Install dependencies
+      run: npm install
+    - name: Generate Docs
+      run: npm run generate-docs
+    - name: Upload artifact
+      uses: actions/upload-pages-artifact@v1
+      with:
+        path: ./docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    needs: docs
+
+    steps:
+    - name: Deploy Docs
+      uses: actions/deploy-pages@v1

.gitignore

@@ -4,3 +4,4 @@ out
 lib
 *.tsbuildinfo
 .env
+docs

README.md

@@ -1,6 +1,7 @@
 # Nighthouse
 
 [![Build](https://github.com/fwcd/nighthouse/actions/workflows/build.yml/badge.svg)](https://github.com/fwcd/nighthouse/actions/workflows/build.yml)
+[![Docs](https://github.com/fwcd/nighthouse/actions/workflows/docs.yml/badge.svg)](https://fwcd.github.io/nighthouse)
 
 A lightweight, asynchronous Project Lighthouse client for JavaScript that runs both in the browser and Node.js environments.
 

package.json

@@ -3,15 +3,22 @@
   "version": "0.0.1",
   "description": "Lightweight Project Lighthouse client for JavaScript",
   "private": true,
-  "workspaces": ["packages/*", "examples/*"],
+  "workspaces": [
+    "packages/*",
+    "examples/*"
+  ],
   "scripts": {
     "build": "tsc -b tsconfig.json",
     "watch": "tsc -b tsconfig.json -w",
-    "prepare": "npm run build"
+    "prepare": "npm run build",
+    "generate-docs": "typedoc --entryPointStrategy packages packages/browser packages/common packages/node --tsconfig ./tsconfig.json"
   },
   "author": "fwcd",
   "license": "MIT",
   "dependencies": {
     "@msgpack/msgpack": "^2.7.2"
+  },
+  "devDependencies": {
+    "typedoc": "^0.23.10"
   }
 }

packages/browser/package.json

@@ -4,6 +4,10 @@
   "description": "Lightweight Project Lighthouse client for the browser",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "typedoc": {
+    "entryPoint": "src/index.ts",
+    "displayName": "Nighthouse Browser"
+  },
   "scripts": {
     "build": "tsc -b tsconfig.json",
     "watch": "tsc -b tsconfig.json -w",

packages/common/package.json

@@ -4,6 +4,10 @@
   "description": "Shared Project Lighthouse client structures",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "typedoc": {
+    "entryPoint": "src/index.ts",
+    "displayName": "Nighthouse Common"
+  },
   "scripts": {
     "build": "tsc -b tsconfig.json",
     "watch": "tsc -b tsconfig.json -w",

packages/node/package.json

@@ -4,6 +4,10 @@
   "description": "Lightweight Project Lighthouse client for Node.js",
   "main": "lib/index.js",
   "types": "lib/index.d.ts",
+  "typedoc": {
+    "entryPoint": "src/index.ts",
+    "displayName": "Nighthouse Node"
+  },
   "scripts": {
     "build": "tsc -b tsconfig.json",
     "watch": "tsc -b tsconfig.json -w",