Merge pull request #8 from jcbhmr/main

.github/workflows/deploy-pages.yml

@@ -0,0 +1,41 @@
+name: deploy-pages
+on:
+  push:
+    branches: "main"
+    paths-ignore:
+      - README.md
+      - CONTRIBUTING.md
+      - LICENSE
+      - .gitignore
+      - .github/**
+      - "!.github/workflows/deploy-pages.yml"
+  workflow_dispatch:
+concurrency:
+  group: ${{ github.workflow }}
+  cancel-in-progress: true
+jobs:
+  deploy-pages:
+    environment:
+      name: github-pages
+      url: ${{ steps.deploy-pages.outputs.page_url }}
+    permissions:
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-node@v3
+        with:
+          node-version: "20"
+          cache: npm
+      - run: npm ci
+      - id: configure-pages
+        uses: actions/configure-pages@v4
+      - run: npm run build:docs
+        env:
+          BASE_URL: ${{ steps.configure-pages.outputs.base_url }}/
+      - uses: actions/upload-pages-artifact@v2
+        with:
+          path: docs
+      - id: deploy-pages
+        uses: actions/deploy-pages@v3

.gitignore

@@ -1,6 +1,9 @@
 # Ignore Typst PDF outputs
 test/*.pdf
 
+# https://typedoc.org/
+docs
+
 #region https://github.com/github/gitignore/blob/main/Node.gitignore
 # Logs
 logs
@@ -132,4 +135,4 @@ dist
 .yarn/build-state.yml
 .yarn/install-state.gz
 .pnp.*
-#endregion
+#endregion