Bring over docs generation scripts from PR 11044 (#1)

Author: brophdawg11

.github/workflows/sync.yml

@@ -8,7 +8,7 @@ on:
   workflow_dispatch:
     inputs:
       tag:
-        description: "Release tag"
+        description: 'Release tag'
         required: true
 
 jobs:
@@ -27,8 +27,7 @@ jobs:
         with:
           repository: remix-run/remix
           path: remix
-          # TODO: Once merged, update this to checkout the tag
-          ref: brophdawg11/docs-auto-generate
+          ref: ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.tag || github.event.inputs.tag }}
           fetch-depth: 0
           fetch-tags: true
 
@@ -41,22 +40,33 @@ jobs:
         uses: actions/setup-node@v4
         with:
           node-version: 24
-          cache: "pnpm"
+          cache: 'pnpm'
           cache-dependency-path: remix/pnpm-lock.yaml
 
-      - name: Install Remix dependencies
+      - name: Install/Build remix-api-docs
+        working-directory: remix-api-docs
+        run: pnpm install --frozen-lockfile
+
+      - name: Install/Build remix
         id: remix
         working-directory: remix
         run: |
           pnpm install --frozen-lockfile
+          pnpm build
           echo "remix_sha=$(git rev-parse --short HEAD)" >> $GITHUB_OUTPUT
 
       - name: Sync Docs
         working-directory: remix-api-docs
         run: |
-          ./sync.sh ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.tag || github.event.inputs.tag }}
+          rm -f docs/index.html
+          rm -rf docs/assets
+          rm -rf docs/api
+
+          pnpm run docs --tag ${{ github.event_name == 'repository_dispatch' && github.event.client_payload.tag || github.event.inputs.tag }}
+          pnpm run prerender --all
 
           git add docs/
+
           if [ -z "$(git status --porcelain)" ]; then
             echo "No changes detected"
             exit 0

.gitignore

@@ -0,0 +1,2 @@
+build/
+node_modules/

.prettierignore

@@ -0,0 +1,4 @@
+build/
+docs/
+node_modules/
+pnpm-lock.yaml

.prettierrc.json

@@ -0,0 +1,6 @@
+{
+  "printWidth": 100,
+  "semi": false,
+  "singleQuote": true,
+  "useTabs": false
+}

README.md

@@ -1,3 +1,3 @@
 # Remix API Documentation
 
-This repo houses the automatically generated API documentation for [Remix](https://github.com/remix-run/remix)
+This repo builds and houses the automatically generated API documentation for [Remix](https://github.com/remix-run/remix)

package.json

@@ -0,0 +1,31 @@
+{
+  "name": "remix-api-docs",
+  "private": true,
+  "type": "module",
+  "dependencies": {
+    "front-matter": "^4.0.2",
+    "marked": "^17.0.1",
+    "node-html-parser": "^7.0.2",
+    "remix": "github:remix-run/remix#preview/main&path:packages/remix",
+    "semver": "^7.7.3",
+    "shiki": "^3.22.0",
+    "tsx": "^4.21.0",
+    "typedoc": "^0.28.15"
+  },
+  "devDependencies": {
+    "@types/hast": "^3.0.4",
+    "@types/node": "^25.2.3",
+    "@types/semver": "^7.5.8",
+    "prettier": "^3.5.3"
+  },
+  "scripts": {
+    "dev": "tsx --watch src/server/index.ts",
+    "docs": "node src/generate/index.ts",
+    "docs:debug": "DEBUG=1 pnpm run docs",
+    "format": "prettier --write .",
+    "prerender": "tsx src/server/prerender.ts",
+    "prerender:serve": "npx http-server -p 3000 build/site",
+    "serve": "tsx src/server/index.ts",
+    "typecheck": "tsgo --noEmit"
+  }
+}