deps: make puppeteer a peer dependency

examples/sample-docs/package.json

@@ -10,6 +10,7 @@
     "ci:build": "run-s clean build"
   },
   "devDependencies": {
-    "@climateinteractive/docs-builder": "workspace:*"
+    "@climateinteractive/docs-builder": "workspace:*",
+    "puppeteer": "^25.10.0"
   }
 }

packages/docs-builder/README.md

@@ -27,6 +27,15 @@ Once the `.npmrc` file is updated, you can install the package the usual way:
 npm install @climateinteractive/docs-builder
 ```
 
+Note that PDF files are generated using [Puppeteer](https://pptr.dev), which is
+declared as a peer dependency so that your project can control which version is
+used (many projects already depend on Puppeteer for end-to-end tests), so you
+will need to install it alongside `docs-builder`:
+
+```sh
+npm install --save-dev puppeteer
+```
+
 ## Usage
 
 ### Command Line

packages/docs-builder/package.json

@@ -48,16 +48,19 @@
     "open": "^11.0.2",
     "postcss": "^8.5.6",
     "postcss-rtlcss": "^5.7.1",
-    "puppeteer": "^25.10.0",
     "rev-hash": "^3.0.0",
     "semver-compare": "^1.0.0",
     "sirv": "^3.0.2",
     "tinyglobby": "^0.2.15"
   },
+  "peerDependencies": {
+    "puppeteer": ">=24.0.0"
+  },
   "devDependencies": {
     "@types/lunr": "^2.3.4",
     "@types/marked": "^4.0.1",
-    "@types/node": "^22.20.1"
+    "@types/node": "^22.20.1",
+    "puppeteer": "^25.10.0"
   },
   "author": "Climate Interactive",
   "license": "MIT",

packages/docs-builder/src/gen-pdf.ts

@@ -7,6 +7,11 @@ import puppeteer from 'puppeteer'
 
 import type { Context } from './context'
 
+/**
+ * Generate a PDF file from the complete HTML page for the project.
+ *
+ * @param context The language-specific context.
+ */
 export async function writePdfFile(context: Context): Promise<void> {
   // Launch a headless browser instance
   const browser = await puppeteer.launch({ headless: true })