feat: Scramjet TypeDoc Mirror

Author: MovByte

.gitignore

@@ -19,3 +19,6 @@ pnpm-debug.log*
 
 # macOS-specific files
 .DS_Store
+
+# Starlight-TypeDoc generated
+src/content/docs/api

.gitmodules

@@ -0,0 +1,3 @@
+[submodule "typedoc-repos/scramjet"]
+	path = typedoc-repos/scramjet
+	url = https://github.com/MercuryWorkshop/scramjet.git

README.md

@@ -10,7 +10,7 @@ This composes from advanced URL rewriting proxies, webOS projects, web-based emu
 Requirements are Node.js (v20+).
 
 ```
-git clone https://github.com/titaniumnetwork-dev/Oxide-Docs.git
+git clone https://github.com/titaniumnetwork-dev/Oxide-Docs.git --recursive
 cd Oxide-Docs
 npm i
 

astro.config.mjs

@@ -1,17 +1,40 @@
 // @ts-check
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
+import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc";
 
 // https://astro.build/config
 export default defineConfig({
   integrations: [
     starlight({
       title: "Titanium Network",
       favicon: "/favicon.png",
-      social: {
-        github: "https://github.com/titaniumnetwork-dev/Oxide-Docs",
-        discord: "https://discord.gg/unblock",
-      },
+      social: [
+        {
+          icon: "github",
+          label: "GitHub",
+          href: "https://github.com/titaniumnetwork-dev/Oxide-Docs",
+        },
+        {
+          icon: "discord",
+          label: "Discord",
+          href: "https://discord.gg/unblock",
+        },
+      ],
+      plugins: [
+        starlightTypeDoc({
+          entryPoints: ["./typedoc-repos/scramjet/src/entry.ts"],
+          tsconfig: "./tsconfig-scramjet.json",
+          sidebar: {
+            label: "Scramjet API",
+          },
+          typeDoc: {
+            skipErrorChecking: true,
+            excludeNotDocumented: false,
+            treatWarningsAsErrors: false,
+          },
+        })
+      ],
       sidebar: [
         {
           label: "Guides",
@@ -23,7 +46,11 @@ export default defineConfig({
         },
         {
           label: "Proxies",
-          autogenerate: { directory: "proxies" },
+          items: [
+            "proxies/rammerhead",
+            "proxies/ultraviolet", 
+            typeDocSidebarGroup,
+          ],
         },
         {
           label: "Technologies",
@@ -39,7 +66,6 @@ export default defineConfig({
         },
       ],
       customCss: [
-        // Relative path to your custom CSS file
         "./src/styles/custom.css",
         "@fontsource/raleway/400.css",
         "@fontsource/raleway/600.css",

package.json

@@ -15,10 +15,12 @@
   },
   "dependencies": {
     "@astrojs/check": "^0.9.4",
-    "@astrojs/starlight": "^0.29.0",
-    "@fontsource/raleway": "^5.1.0",
-    "astro": "^4.16.10",
-    "sharp": "^0.32.5",
-    "typescript": "^5.6.3"
+    "@astrojs/starlight": "^0.35.2",
+    "@fontsource/raleway": "^5.2.6",
+    "astro": "^5.13.5",
+    "sharp": "^0.32.6",
+    "starlight-typedoc": "^0.21.3",
+    "typedoc": "^0.28.11",
+    "typescript": "^5.9.2"
   }
 }