Add GitHub Actions workflow for documentation deployment and update related configurations

Author: sergiodxa

.github/workflows/docs.yml

@@ -0,0 +1,32 @@
+name: Deploy Documentation
+
+on:
+  push:
+    branches: ["main"]
+  workflow_dispatch:
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+concurrency:
+  group: "docs"
+  cancel-in-progress: false
+
+jobs:
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: oven-sh/setup-bun@v2
+      - run: bun install --frozen-lockfile && bunx typedoc
+      - uses: actions/configure-pages@v5
+      - uses: actions/upload-pages-artifact@v3
+        with:
+          path: "./pages"
+      - uses: actions/deploy-pages@v4
+        id: deployment

.gitignore

@@ -1,28 +1,7 @@
-# Logs
-logs
-*.log
-npm-debug.log*
-
-# Runtime data
-pids
-*.pid
-*.seed
-*.pid.lock
-
-# Coverage directory used by tools like istanbul
-coverage
-*.lcov
-
-# Dependency directories
-node_modules/
+/build
+/coverage
+/pages
+/node_modules
 
-# TypeScript cache
-*.tsbuildinfo
-
-# Optional npm cache directory
-.npm
-
-# Optional eslint cache
-.eslintcache
-
-/build
+*.log
+.DS_Store

bun.lockb

@@ -109,6 +109,8 @@
 		"@types/bun": "^1.1.14",
 		"i18next": "^23.0.0",
 		"remix-i18next": "^7.0.0",
+		"typedoc": "^0.27.3",
+		"typedoc-plugin-mdn-links": "^4.0.3",
 		"typescript": "^5.7.2",
 		"vite": "^6.0.3",
 		"vite-tsconfig-paths": "^5.1.3",

package.json

@@ -0,0 +1,20 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "name": "Remix Hono",
+  "includeVersion": true,
+  "entryPoints": [
+    "./src/cloudflare.ts",
+    "./src/handler.ts",
+    "./src/i18next.ts",
+    "./src/security.ts",
+    "./src/session.ts",
+    "./src/trailing-slash.ts",
+    "./src/typed-env.ts"
+  ],
+  "out": "pages",
+  "json": "pages/index.json",
+  "cleanOutputDir": true,
+  "projectDocuments": ["./docs/*.md"],
+  "plugin": ["typedoc-plugin-mdn-links"],
+  "categorizeByGroup": false
+}