typedoc

Signed-off-by: Sora Morimoto <[email protected]>

Author: smorimoto

.github/workflows/typedoc.yml

@@ -0,0 +1,51 @@
+name: Deploy typedoc to Pages
+
+on:
+  push:
+    branches:
+      - main
+  workflow_dispatch:
+
+permissions: read-all
+
+concurrency:
+  group: pages
+  cancel-in-progress: true
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    permissions:
+      contents: read
+      pages: write
+      id-token: write
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout tree
+        uses: actions/checkout@v4
+
+      - name: Set-up Node.js
+        uses: actions/setup-node@v4
+        with:
+          check-latest: true
+          node-version-file: .nvmrc
+
+      - run: corepack enable
+
+      - run: yarn install --immutable
+
+      - run: yarn typedoc
+
+      - name: Set-up Pages
+        uses: actions/configure-pages@v5
+
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v3
+        with:
+          path: docs
+
+      - name: Deploy odoc to GitHub Pages
+        uses: actions/deploy-pages@v4
+        id: deployment

.github/workflows/version-or-publish.yml

@@ -12,11 +12,11 @@ permissions: read-all
 jobs:
   release:
     if: ${{ github.repository_owner == 'acacode' }}
-    runs-on: ubuntu-latest
     permissions:
       contents: write # to create release
       issues: write # to post issue comments
       pull-requests: write # to create pull request
+    runs-on: ubuntu-latest
     steps:
       - name: Checkout tree
         uses: actions/checkout@v4

.gitignore

@@ -1,3 +1,4 @@
 /.yarn/
 /dist/
+/docs/
 /node_modules/