GitHub action to write docs

Author: PythonCoderAS

.github/workflows/docs.yml

@@ -0,0 +1,34 @@
+name: "Build Documentation"
+on:
+  push:
+    branches: [master]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      pages: write # to deploy to Pages
+      id-token: write # to verify the deployment originates from an appropriate source
+
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+
+    steps:
+      - uses: actions/checkout@v3
+      - name: Use Node.js 18
+        uses: actions/[email protected]
+        with:
+          node-version: 18
+          cache: "npm"
+      - run: npm ci
+      - run: npm run docs
+      - name: Setup Pages
+        uses: actions/configure-pages@v1
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: "docs"
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@main

package.json

@@ -9,7 +9,8 @@
     "test": "mocha --require ts-node/register tests/**/*.test.ts",
     "build": "tsc -b",
     "lint": "prettier --check . && eslint . --ext .ts",
-    "lint-fix": "prettier --write . && eslint . --ext .ts --fix"
+    "lint-fix": "prettier --write . && eslint . --ext .ts --fix",
+    "docs": "typedoc --out docs src/index.ts"
   },
   "repository": {
     "type": "git",