docs: Setup typedoc (#27)

* docs: add typedoc dependency * add workflow to deploy to github pages * use peaceiris/actions-gh-pages * fix: use "just docs" in release workflow --------- Co-authored-by: Chris Dickinson <[email protected]>
extism · Nov 15, 2023 · 8e4fc5a · 8e4fc5a
1 parent f6f7b1d
commit 8e4fc5a
Show file tree

Hide file tree

Showing 3 changed files with 95 additions and 5 deletions.
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
@@ -46,3 +46,12 @@ jobs:
       uses: JS-DevTools/[email protected]
       with:
         token: ${{ secrets.NPM_TOKEN }}
+
+    - name: typedoc
+      run: just docs
+
+    - name: Deploy docs to GitHub Pages
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -55,7 +55,9 @@
     "playwright": "^1.39.0",
     "prettier": "^2.7.1",
     "tape": "^5.7.1",
-    "typedoc": "^0.25.2",
+    "typedoc": "^0.25.3",
+    "typedoc-github-wiki-theme": "^1.1.0",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.2.2"
   }
 }