Install typedoc to generate documentation for project

- [x] Install typedoc
- [x] Publish documentation to github pages

.config/typedoc.js

@@ -0,0 +1,6 @@
+/** @type {import('typedoc').TypeDocOptions} */
+module.exports = {
+  entryPoints: ['../src/**/*.ts'],
+  exclude: ['../src/**/*+(.test).ts'],
+  out: '../build/doc',
+}

.github/workflows/typedoc.yml

@@ -0,0 +1,35 @@
+name: Publish Typedoc
+
+on:
+  push:
+    branches:
+      - typedoc
+    # branches:
+    #   - main
+
+jobs:
+  deploy:
+    name: Publish Typedoc
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: pnpm/action-setup@v2.4.0
+        with:
+          version: 8
+
+      - uses: actions/setup-node@v3
+        with:
+          node-version: 20.x
+
+      - run: pnpm install
+
+      - run: pnpm build
+
+      - uses: peaceiris/actions-gh-pages@v3
+        with:
+          github_token: ${{ secrets.GITHUB_TOKEN }}
+          publish_dir: ./build/docs
+          cname: ts-playground.typedoc.kitsuyui.com

.prettierignore

@@ -1,3 +1,4 @@
 coverage
 dist
 node_modules
+build/docs

package.json

@@ -14,12 +14,13 @@
     "build:standalone:win-x64": "pkg dist/main.js -o build/ts-playground-win-x64 -t node18-win-x64 --no-signature",
     "build:standalone:linux-arm64": "pkg dist/main.js -o build/ts-playground-linux-arm64 -t node18-linux-arm64 --no-signature",
     "build:standalone:linux-x64": "pkg dist/main.js -o build/ts-playground-linux-x64 -t node18-linux-x64 --no-signature",
-    "build:all": "pnpm build:lib && pnpm build:bin && pnpm build:standalone:macos-arm64 && pnpm build:standalone:macos-x64 && pnpm build:standalone:win-arm64 && pnpm build:standalone:win-x64 && pnpm build:standalone:linux-arm64 && pnpm build:standalone:linux-x64",
+    "build:all": "pnpm build:lib && pnpm build:bin && pnpm build:standalone:macos-arm64 && pnpm build:standalone:macos-x64 && pnpm build:standalone:win-arm64 && pnpm build:standalone:win-x64 && pnpm build:standalone:linux-arm64 && pnpm build:standalone:linux-x64 && pnpm typedoc",
     "dev:lib": "tsup src/index.ts --dts --format cjs,esm --minify --clean --sourcemap --watch --onSuccess 'node dist/index.js'",
     "dev:bin": "tsup src/main.ts --dts --format cjs,esm --minify --clean --sourcemap --watch --onSuccess 'node dist/main.js'",
     "test": "jest --coverage",
     "lint": "eslint --ext .ts src",
-    "format": "prettier --write ."
+    "format": "prettier --write .",
+    "typedoc": "typedoc"
   },
   "bin": {
     "ts-playground-main": "./dist/main.js"
@@ -39,6 +40,7 @@
     "package.json"
   ],
   "devDependencies": {
+    "@jest/globals": "^29.7.0",
     "@swc/core": "^1.3.62",
     "@swc/jest": "^0.2.26",
     "@typescript-eslint/eslint-plugin": "^6.0.0",
@@ -51,6 +53,7 @@
     "jest": "^29.5.0",
     "pkg": "^5.8.1",
     "prettier": "^3.0.0",
+    "typedoc": "^0.25.2",
     "typescript": "^5.1.3"
   },
   "dependencies": {