feat: add a docs website for Coldark

.cspell/project-words.txt

@@ -5,6 +5,7 @@ cpio
 dircolors
 dtterm
 dvtm
+eslintcache
 Eterm
 flac
 gedit
@@ -20,9 +21,11 @@ MULTIHARDLINK
 Nord
 objc
 pacman
+Poldark
 prereq
 rmvb
 rxvt
+seti
 Stackframe
 svgz
 tzst

.github/workflows/deploy-pages.yml

@@ -0,0 +1,75 @@
+name: Deploy Website
+
+permissions:
+  contents: read
+  pages: write
+  id-token: write
+
+on:
+  push:
+    branches:
+      - main
+    paths:
+      - ".github/workflows/deploy-pages.yml"
+      - "package.json"
+      - "pnpm-lock.yaml"
+      - "pnpm-workspace.yaml"
+      - "website/**"
+  workflow_dispatch:
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CI: true
+  FORCE_COLOR: true
+
+concurrency:
+  group: deploy-pages
+  cancel-in-progress: true
+
+jobs:
+  build:
+    name: Build Website
+    runs-on: ubuntu-latest
+    timeout-minutes: 15
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
+
+      - name: Install Node.js
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          cache: pnpm
+          node-version: 24.14.0
+
+      - name: Configure GitHub Pages
+        uses: actions/configure-pages@983d7736d9b0ae728b81ab479565c72886d7745b # v5.0.0
+
+      - name: Install dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: Build website
+        run: pnpm run website:build
+
+      - name: Upload Pages artifact
+        uses: actions/upload-pages-artifact@56afc609e74202658d3ffba0e8f6dda462b719fa # v4.0.0
+        with:
+          path: website/dist
+
+  deploy:
+    name: Deploy Website
+    needs: build
+    runs-on: ubuntu-latest
+    timeout-minutes: 10
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@5d6d0c8fb1398208bfc3292a3f2d2f14b574f213 # v4.0.5

.github/workflows/tests.yml

@@ -0,0 +1,44 @@
+name: Tests
+permissions: {}
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+
+defaults:
+  run:
+    shell: bash
+
+env:
+  CI: true
+  FORCE_COLOR: true
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.event_name == 'pull_request_target' && github.head_ref || github.ref }}
+  cancel-in-progress: true
+
+jobs:
+  test:
+    name: Tests
+    timeout-minutes: 15
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout Repo
+        uses: actions/checkout@de0fac2e4500dabe0009e67214ff5f5447ce83dd # v6.0.2
+
+      - name: Setup pnpm
+        uses: pnpm/action-setup@41ff72655975bd51cab0327fa583b6e92b6d3061 # v4.2.0
+
+      - name: Install Node.js
+        uses: actions/setup-node@53b83947a5a98c8d113130e565377fae1a50d02f # v6.3.0
+        with:
+          cache: pnpm
+          node-version: 24.14.0
+
+      - name: Install dependencies
+        run: pnpm i --frozen-lockfile
+
+      - name: Run tests
+        run: pnpm test

.gitignore

@@ -1,3 +1,6 @@
+# build output
+dist/
+
 # cache
 .eslintcache
 .npm
@@ -10,6 +13,9 @@ node_modules/
 .env
 !.env.example
 
+# generated types
+.astro/
+
 # logs
 *.log
 npm-debug.log*

.prettierignore

@@ -1,4 +1,7 @@
-CHANGELOG.md
+dist
 node_modules
 pnpm-lock.yaml
-README.md
+
+# Prettier adds unwanted line breaks when using html tags in a paragraph... and I don't like tables formatting.
+*.md
+*.mdx

.vscode/extensions.json

@@ -0,0 +1,4 @@
+{
+  "recommendations": ["astro-build.astro-vscode"],
+  "unwantedRecommendations": []
+}

.vscode/launch.json

@@ -0,0 +1,12 @@
+{
+  "version": "0.2.0",
+  "configurations": [
+    {
+      "command": "./node_modules/.bin/astro dev",
+      "cwd": "${workspaceFolder}/website",
+      "name": "Coldark website dev server",
+      "request": "launch",
+      "type": "node-terminal"
+    }
+  ]
+}

package.json

@@ -27,7 +27,13 @@
     "lint": "pnpm run \"/^lint:.*/\"",
     "lint:formatting": "prettier . --check",
     "lint:spelling": "cspell \"**\" --no-progress",
-    "prepare": "husky install"
+    "prepare": "husky",
+    "test": "pnpm -r --if-present test",
+    "test:coverage": "pnpm -r --if-present test:coverage",
+    "website:build": "pnpm --filter coldark-website build",
+    "website:dev": "pnpm --filter coldark-website dev",
+    "website:test": "pnpm --filter coldark-website test",
+    "website:test:coverage": "pnpm --filter coldark-website test:coverage"
   },
   "devDependencies": {
     "@arphi/commitlint-config": "^1.0.7",