Merge pull request #65 from poteat/231125-gh-pages-action

Set up workflow for auto-deploying TypeDoc documentation to GitHub Pages

.github/workflows/publish-docs.yml

@@ -0,0 +1,30 @@
+name: Publish docs to GitHub Pages
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+jobs:
+  publish-docs-to-gh-pages:
+    name: Publish docs to GitHub Pages
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - name: Checkout the repository
+        uses: actions/checkout@v3
+      - name: Use Node.js
+        uses: actions/setup-node@v3
+        with:
+          node-version-file: '.nvmrc'
+      - name: Install npm dependencies
+        run: npm install
+      - name: Run build script
+        run: npm run build:docs
+      - name: Deploy to GitHub Pages
+        uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./typedoc

.nvmrc

@@ -0,0 +1 @@
+v18