Initial configuration of docs generation (#3)

Author: xuhdev

.github/workflows/lint.yml

@@ -1,5 +1,3 @@
-# @license Apache-2.0
-#
 # Copyright 2024 8 Hobbies, LLC <hong@8hobbies.com>
 #
 # Licensed under the Apache License, Version 2.0(the "License");

.github/workflows/pages.yml

@@ -0,0 +1,63 @@
+# Copyright 2024 8 Hobbies, LLC <hong@8hobbies.com>
+#
+# Licensed under the Apache License, Version 2.0(the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+name: Build and Deploy Pages
+
+on:
+  push:
+    branches: ["master"]
+  pull_request:
+    branches: ["master"]
+
+jobs:
+  build:
+    name: Build Pages
+    runs-on: ubuntu-22.04
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - uses: actions/setup-node@v4
+        with:
+          node-version: 20.x
+          cache: "npm"
+
+      - name: Install Dependencies
+        run: |
+          npm install
+
+      - name: Generate Docs
+        run: |
+          npm run doc
+
+      - name: Upload GitHub Pages Artifact
+        uses: actions/upload-pages-artifact@v3.0.1
+        with:
+          path: docs
+
+  deploy:
+    name: Deploy Pages
+    if: github.ref == 'refs/heads/master'
+    runs-on: ubuntu-22.04
+    permissions:
+      pages: write
+      id-token: write
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    needs: build
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

.gitignore

@@ -13,6 +13,7 @@ dist
 dist-ssr
 *.local
 *.tsbuildinfo
+/docs
 
 # Editor directories and files
 .vscode/*