chore: update CI

jacob-ebey · Jan 11, 2024 · 9b2f43e · 9b2f43e
1 parent c96dbb8
commit 9b2f43e
Show file tree

Hide file tree

Showing 4 changed files with 177 additions and 8 deletions.
diff --git a/.github/workflows/docs.yaml b/.github/workflows/docs.yaml
@@ -22,12 +22,11 @@ jobs:
         with:
           node-version: 20
 
-      - name: TSDoc Action
-        uses: erikyo/tsdoc-action@v1
-        with:
-          entryPoints: ./src/index.ts
-          output_dir: ./docs
-          front_page: README.md
+      - name: Install dependencies
+        run: npm ci
+
+      - name: Generate docs
+        run: npm run docs
 
       - name: Setup Pages
         uses: actions/configure-pages@v3

diff --git a/.gitignore b/.gitignore
@@ -4,4 +4,5 @@ transformed-modules-server.json
 *.tgz
 
 dist/
+docs/
 node_modules/
diff --git a/package-lock.json b/package-lock.json
diff --git a/package.json b/package.json
@@ -18,6 +18,7 @@
   },
   "scripts": {
     "build": "tsc",
+    "docs": "npx typedoc --out docs src/index.ts",
     "test": "vitest"
   },
   "keywords": [
@@ -30,6 +31,8 @@
   "author": "Jacob Ebey <jacob.ebey@live.com>",
   "license": "ISC",
   "devDependencies": {
+    "typedoc": "^0.25.7",
+    "typedoc-plugin-markdown": "^3.17.1",
     "typescript": "^5.3.3",
     "vite": "^5.0.11",
     "vitest": "^1.1.3"
-Original file line number
+Diff line change
@@ Expand Up / @@ -4,4 +4,5 @@ transformed-modules-server.json @@
     *.tgz
     dist/
+    docs/
     node_modules/