docs: Implement automatic site generation of package documentation.

.github/workflows/pages.yml

@@ -0,0 +1,63 @@
+name: Generate and Deploy Documentation
+
+on:
+  # Runs on pushes targeting the default branch
+  push:
+    branches: ["omo"]
+
+  # Allows you to run this workflow manually from the Actions tab
+  workflow_dispatch:
+
+# Sets permissions of the GITHUB_TOKEN to allow deployment to GitHub Pages
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+# Allow one concurrent deployment
+concurrency:
+  group: "pages"
+  cancel-in-progress: true
+
+env:
+  BUILD_PATH: "." # default value when not using subfolders
+  # BUILD_PATH: subfolder
+
+jobs:
+  build:
+    name: Build
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v3
+      - name: Setup Node
+        uses: actions/setup-node@v3
+        with:
+          node-version: "16"
+          cache: npm
+          cache-dependency-path: ${{ env.BUILD_PATH }}/package-lock.json
+      - name: Setup Pages
+        id: pages
+        uses: actions/configure-pages@v2
+      - name: Install dependencies
+        run: npm install
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Build with Astro
+        run: npm run docs:build
+        working-directory: ${{ env.BUILD_PATH }}
+      - name: Upload artifact
+        uses: actions/upload-pages-artifact@v1
+        with:
+          path: ${{ env.BUILD_PATH }}/.docs
+
+  deploy:
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    runs-on: ubuntu-latest
+    name: Deploy
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v1

.gitignore

@@ -0,0 +1,2 @@
+node_modules
+.docs

package.json

@@ -29,7 +29,9 @@
 		".": "./lib/index.js"
 	},
 	"scripts": {
+		"docs:build": "typedoc"
 	},
 	"devDependencies": {
+		"typedoc": "^0.23.23"
 	}
 }

tsconfig.json

@@ -0,0 +1,9 @@
+{
+  "exclude": [
+    "node_modules"
+  ],
+  "compilerOptions": {
+    "allowJs": true,
+    "strict": false
+  }
+}

typedoc.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "cleanOutputDir": true,
+  "out": ".docs",
+  "tsconfig": "tsconfig.json",
+  "entryPointStrategy": "packages",
+  "entryPoints": ["."],
+  "exclude": ["node_modules/**/*"],
+  "name": "@musakui/fedi",
+  "readme": "./README.md",
+  "includeVersion": true,
+  "navigationLinks": {
+    "GitHub": "https://github.com/musakui/fedi"
+  }
+}