Merge pull request #44 from MovByte/feat-scramjet-typedoc

feat: Scramjet TypeDoc Mirror

Author: QuiteAFancyEmerald

.gitignore

@@ -5,6 +5,7 @@ dist/
 
 # dependencies
 node_modules/
+pnpm-lock.yaml
 
 # logs
 npm-debug.log*
@@ -20,5 +21,9 @@ pnpm-debug.log*
 # macOS-specific files
 .DS_Store
 
+# Starlight-TypeDoc generated
+src/content/docs/api
+
+# Git
 package-lock.json
-pnpm-lock.yaml
+pnpm-lock.yaml

.gitmodules

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

README.md

@@ -11,7 +11,7 @@ Requirements are Node.js (v20+).
 Using `pnpm` is more recommended.
 
 ```
-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.ts

@@ -1,5 +1,6 @@
 import { defineConfig } from "astro/config";
 import starlight from "@astrojs/starlight";
+import starlightTypeDoc, { typeDocSidebarGroup } from "starlight-typedoc";
 import rehypeAstroRelativeMarkdownLinks from "astro-rehype-relative-markdown-links";
 import rehypeShiki from "@shikijs/rehype";
 
@@ -30,10 +31,32 @@ export default defineConfig({
     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,
+          },
+        })
+      ],
       components: {
         Head: "./src/components/MetadataHead.astro",
         PageTitle: "./src/components/PageTitle.astro",
@@ -49,7 +72,12 @@ export default defineConfig({
         },
         {
           label: "Proxies",
-          autogenerate: { directory: "proxies" },
+          items: [
+            "proxies/rammerhead",
+            "proxies/ultraviolet",
+            "proxies/scramjet",
+            typeDocSidebarGroup,
+          ],
         },
         {
           label: "Technologies",

package.json

@@ -23,14 +23,16 @@
   },
   "dependencies": {
     "@astrojs/check": "^0.9.4",
-    "@astrojs/starlight": "^0.29.3",
+    "@astrojs/starlight": "^0.35.2",
     "@fontsource/raleway": "^5.2.6",
     "@shikijs/rehype": "^3.12.0",
     "@shikijs/themes": "^3.12.0",
-    "astro": "^4.16.19",
+    "astro": "^5.13.5",
     "astro-rehype-relative-markdown-links": "^0.18.1",
     "gray-matter": "^4.0.3",
     "sharp": "^0.32.6",
+    "starlight-typedoc": "^0.21.3",
+    "typedoc": "^0.28.11",
     "typescript": "^5.9.2"
   },
   "devDependencies": {

src/components/MetadataHead.astro

@@ -13,7 +13,8 @@ interface MetadataFrontmatter {
 }
 
 const { entry } = Astro.props as Props;
-const { data: frontmatter } = entry;
+
+const frontmatter = entry?.data || {};
 const { title, description } = frontmatter;
 
 /**
@@ -36,15 +37,15 @@ const FRONTMATTER = frontmatter as MetadataFrontmatter;
 /**
  * The image to generate for the metadata
  */
-const IMAGE = FRONTMATTER.image || DEFAULT_METADATA.defaultImage;
+const IMAGE = FRONTMATTER?.image || DEFAULT_METADATA.defaultImage;
 /**
  * The keywords to generate for the metadata
  */
-const KEYWORDS = FRONTMATTER.keywords || [];
+const KEYWORDS = FRONTMATTER?.keywords || [];
 /**
  * The theme color to generate for the metadata
  */
-const THEME_COLOR = FRONTMATTER.themeColor || DEFAULT_METADATA.themeColor;
+const THEME_COLOR = FRONTMATTER?.themeColor || DEFAULT_METADATA.themeColor;
 ---
 
 <!-- Unofficial Web Standards -->

src/content/docs/proxies/scramjet.mdx

@@ -102,3 +102,7 @@ With:
 ## Upgrading from Ultraviolet
 
 Scramjet is easier to setup than UV. You may still use UV alongside Scramjet if you really find it necessary, however UV is unmaintained software and has far less site support than Scramjet.
+
+# Official docs
+
+You can read the [full Scramjet Typedocs](https://scramjet.mercurywork.shop/typedoc) for better API documentation.

tsconfig-scramjet.json

@@ -0,0 +1,33 @@
+{
+  "compilerOptions": {
+    "target": "ES2022",
+    "moduleResolution": "Bundler", 
+    "module": "ES2022",
+    "skipLibCheck": true,
+    "lib": ["ES2022", "WebWorker", "DOM"],
+    "skipDefaultLibCheck": true,
+    "noResolve": false,
+    "isolatedModules": true,
+    "paths": {
+      "@rewriters/*": ["./typedoc-repos/scramjet/src/shared/rewriters/*"],
+      "@client/*": ["./typedoc-repos/scramjet/src/client/*"],
+      "@/*": ["./typedoc-repos/scramjet/src/*"]
+    }
+  },
+  "include": [
+    "typedoc-repos/scramjet/src/entry.ts",
+    "typedoc-scramjet-globals.d.ts"
+  ],
+  "exclude": [
+    "node_modules",
+    "**/__tests__/**",
+    "**/*.spec.ts",
+    "**/*.test.ts", 
+    "**/rewriters/**",
+    "**/shared/rewriters/**",
+    "**/client/**",
+    "**/worker/**",
+    "**/controller/**",
+    "**/*.d.ts"
+  ]
+}

typedoc-repos/scramjet

@@ -0,0 +1,28 @@
+{
+  "$schema": "https://typedoc.org/schema.json",
+  "skipErrorChecking": true,
+  "entryPointStrategy": "resolve",
+  "excludeExternals": true,
+  "exclude": [
+    "**/__tests__/**",
+    "**/*.spec.ts", 
+    "**/*.test.ts",
+    "**/rewriters/**",
+    "**/shared/rewriters/**",
+    "**/worker/fetch/**",
+    "**/worker/rewrite/**",
+    "**/worker/fakesw.ts"
+  ],
+  "excludePrivate": true,
+  "excludeProtected": false,
+  "excludeInternal": true,
+  "excludeNotDocumented": false,
+  "includeVersion": true,
+  "sort": ["source-order"],
+  "categorizeByGroup": true,
+  "categoryOrder": ["Window Context", "Service Worker Context"],
+  "defaultCategory": "Window Context",
+  "searchInComments": true,
+  "searchInDocuments": true,
+  "treatWarningsAsErrors": false
+}