docs: add documentation generation

.gitignore

@@ -1,5 +1,6 @@
 node_modules/
 dist/
+docs/
 coverage/
 lib/**/*.d.ts
 .idea/

package.json

@@ -21,6 +21,9 @@
     "generate-types": "run-s generate-types:*",
     "generate-types:generate": "del-cli \"lib/**/*.d.ts\" && npx bio-dts -r lib",
     "generate-types:test": "tsc --noEmit --noImplicitAny",
+    "generate-docs": "typedoc",
+    "pregenerate-docs": "run-s generate-types",
+    "publish-docs": "scripts/publish-docs.sh",
     "test": "karma start",
     "prepublishOnly": "run-s generate-types"
   },
@@ -77,6 +80,7 @@
     "puppeteer": "^22.0.0",
     "sinon": "^17.0.0",
     "sinon-chai": "^3.7.0",
+    "typedoc": "^0.25.7",
     "typescript": "^5.0.0",
     "webpack": "^5.74.0"
   },

scripts/publish-docs.sh

@@ -0,0 +1,20 @@
+#!/bin/bash
+
+# use provided repository or default to bpmn-io/diagram-js
+REPO="${1:-bpmn-io/diagram-js}" 
+GIT_REMOTE="[email protected]:$REPO.git"
+
+parent_path=$( cd "$(dirname "${BASH_SOURCE[0]}")" ; pwd -P )
+cd "$parent_path"
+cd ..
+
+npm run generate-docs
+
+cd docs
+git init
+git add .
+git commit -m "Deployed to Github Pages"
+git checkout -b gh-pages
+
+git remote add origin $GIT_REMOTE
+git push --force $GIT_REMOTE gh-pages

typedoc.json

@@ -0,0 +1,5 @@
+{
+  "entryPoints": ["lib/**/*.d.ts"],
+  "out": "./docs",
+  "cleanOutputDir": true
+}