deploy docs

Author: hipstersmoothie

.github/workflows/deploy.yml

@@ -0,0 +1,46 @@
+name: build
+
+on:
+  push:
+    branches:
+      - main
+
+# Enabled permissions on GITHUB_TOKEN
+permissions:
+  # To be able to push to the repo
+  contents: write
+  # To update the pr description with canary info
+  pull-requests: write
+  # For pr-check to create a status
+  statuses: write
+  # Needed to create PR statuses/checks
+  checks: write
+  # To post comments on PRs
+  issues: write
+  # Astro deploy
+  pages: write
+  id-token: write
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v3
+      - uses: ./.github/actions/install-deps
+      - name: Install, build, and upload your site
+        uses: withastro/action@v2
+        with:
+          path: packages/docs
+          node-version: 18
+          package-manager: [email protected]
+
+  deploy:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: github-pages
+      url: ${{ steps.deployment.outputs.page_url }}
+    steps:
+      - name: Deploy to GitHub Pages
+        id: deployment
+        uses: actions/deploy-pages@v4

package.json

@@ -7,7 +7,7 @@
     "node": ">=18"
   },
   "scripts": {
-    "build": "turbo run build",
+    "build": "turbo run build --filter=!docs",
     "dev": "turbo run dev",
     "lint": "turbo run lint",
     "test": "turbo run test -- --watch=false",

packages/docs/astro.config.mjs

@@ -3,9 +3,10 @@ import starlight from "@astrojs/starlight";
 import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc";
 import react from "@astrojs/react";
 import path from "path";
-import { NodeGlobalsPolyfillPlugin } from "@esbuild-plugins/node-globals-polyfill";
 
 export default defineConfig({
+  site: "https://jimp-dev.github.io",
+  base: "jimp",
   integrations: [
     react(),
     starlight({

packages/docs/package.json

@@ -1,39 +1,35 @@
 {
   "name": "@jimp/docs",
   "private": true,
-  "type": "module",
   "version": "1.0.2",
+  "type": "module",
   "scripts": {
     "dev": "astro dev",
     "start": "astro dev",
-    "build-website": "rm -rf dist && astro check && astro build",
+    "build": "rm -rf dist && astro check && astro build",
     "preview": "astro preview",
     "astro": "astro"
   },
   "dependencies": {
-    "@astrojs/check": "^0.5.10",
-    "@astrojs/react": "^3.1.0",
-    "@astrojs/starlight": "^0.21.2",
+    "@astrojs/check": "^0.9.3",
+    "@astrojs/react": "^3.6.2",
+    "@astrojs/starlight": "^0.26.1",
     "@esbuild-plugins/node-globals-polyfill": "^0.2.3",
     "@jimp/core": "workspace:*",
     "@jimp/plugin-print": "workspace:*",
-    "astro": "^4.3.5",
+    "astro": "^4.15.1",
     "eslint": "^8.57.0",
     "jimp": "workspace:*",
     "react": "^18.2.0",
     "react-dom": "^18.2.0",
     "sharp": "^0.32.5",
-    "starlight-typedoc": "^0.10.0",
-    "typedoc": "^0.25.12",
-    "typedoc-plugin-markdown": "next",
+    "starlight-typedoc": "^0.15.0",
+    "typedoc": "^0.26.6",
+    "typedoc-plugin-markdown": "4.2.6",
     "typedoc-plugin-zod": "^1.1.2",
     "typescript": "^5.4.3"
   },
   "devDependencies": {
     "@types/react": "^18.2.73"
-  },
-  "publishConfig": {
-    "access": "public"
-  },
-  "sideEffects": false
+  }
 }

packages/docs/src/typedoc-plugin.js

@@ -5,13 +5,12 @@ export function load(app) {
   const needsUpdate = new Set();
 
   const commentMap = new Map();
-  const needComment = new Set();
 
   let jimpClass;
   let options;
 
   app.converter.on(Converter.EVENT_CREATE_SIGNATURE, onCreateDeclaration);
-  app.converter.on(Converter.EVENT_CREATE_DECLARATION, (c, r) => {
+  app.converter.on(Converter.EVENT_CREATE_DECLARATION, (_, r) => {
     if (r.name === "JimpConstructorOptions") {
       options = r;
     }
@@ -64,7 +63,7 @@ export function load(app) {
     }
   }
 
-  app.converter.on(Converter.EVENT_END, (context) => {
+  app.converter.on(Converter.EVENT_END, () => {
     for (const refOrig of needsUpdate) {
       const i = fullSignaturePath.get(refOrig.name);
 

packages/docs/src/typedoc-zod-extended.js

@@ -1,10 +1,4 @@
-import {
-  Converter,
-  ReflectionKind,
-  ReferenceType,
-  TypeScript,
-  Comment,
-} from "typedoc";
+import { Converter, TypeScript, Comment } from "typedoc";
 
 function sourceKey(source) {
   return source.fileName + ":" + source.line + ":" + source.character;
@@ -38,7 +32,7 @@ export function load(app) {
     toUpdate.set(key, options);
   });
 
-  function onCreateDeclaration(context, refl) {
+  function onCreateDeclaration(_, refl) {
     console.log(refl.name);
     if (refl.name.endsWith("Options")) {
       const declaration = refl.project