merge with upstream

Author: velzie

.remarkignore

@@ -0,0 +1,17 @@
+# Configs
+.vscode/
+
+# Assets
+assets/
+
+# Generated Docs
+_docs/
+_docs-dev/
+_docs-docs/
+existing-typedoc-dev/
+
+# Package Manager
+node_modules/
+
+# Build Directories
+dist/

.remarkrc.js

@@ -0,0 +1,19 @@
+export default {
+	plugins: [
+		"remark-frontmatter",
+		"remark-mdx",
+		[
+			"remark-stringify",
+			{
+				bullet: "-",
+				listItemIndent: "one",
+				emphasis: "*",
+				strong: "*",
+				fences: true,
+				fence: "`",
+				rule: "-",
+				incrementListMarker: true,
+			},
+		],
+	],
+};

docs/contributors/Index.md

@@ -0,0 +1,3 @@
+# Contributors
+
+Here are the docs that haven't been published on the Typedoc.

docs/contributors/Typedoc.md

@@ -0,0 +1,12 @@
+# Typedoc
+
+Scramjet comes with a Typedoc.
+There is information about how to run it locally in the [README](../README.md).
+There are two types of Typedoc generated: user-facing (main) and developer-facing (dev).
+The user-facing documentation is generated at `/typedoc`, and the developer-facing documentation is generated at `/typedoc/dev`.
+The site is generated by the [CI here](../../.github/workflows/) under the job "pages". You can simulate that CI job with the script at `scripts/serve-static.sh`. This includes the demo and the Typedoc.
+
+## How versioning works
+
+Versioning is handled [this plugin](https://www.npmjs.com/package/@shipgirl/typedoc-plugin-versions).
+[This CI script](../../ci/download-existing-docs.sh) downloads the previous Typedoc builds from the artifacts for all Scramjet releases with the latest from the package version.

docs/dev/Typedoc.mdx

@@ -0,0 +1,9 @@
+---
+title: What is this?
+---
+
+The current doc you are reading is generated with [typedoc-plugin-markdown](https://github.com/ElektraInitiative/typedoc-plugin-markdown).
+
+Typedoc documents all of the Scramjet APIs. Specifically, you are on the developer-facing documentation, so you will see APIs documented, which aren't exposed publicly in the package.
+
+[**Switch to user-facing documentation**](/typedoc) to see what you actually need if you aren't a contributor, rather an implementor or someone interested in Scramjet.

docs/user/Typedoc.mdx

@@ -0,0 +1,7 @@
+---
+title: What is this?
+---
+
+You are currently on the user-facing documentation. This only documents APIs, which are exposed to you, so you can implement Scramjet into your site without having to worry about the internals of the library.
+
+[**Switch to developer-facing documentation**](/typedoc-dev) to see all APIs used internally too.

package.json

@@ -18,6 +18,7 @@
 		"prepack": "RELEASE=1 npm run rewriter:build && npm run build:all",
 		"pub": "npm publish --no-git-checks --access public",
 		"format": "prettier --write .",
+		"format:docs": "remark \"docs/**/*.{md,mdx}\" --output",
 		"lint": "eslint ./src/",
 		"lint:fix": "eslint ./src/ --fix",
 		"lint:workflows": "actionlint .github/workflows/*.yml",
@@ -58,6 +59,7 @@
 		"verbose": true
 	},
 	"devDependencies": {
+		"@8hobbies/typedoc-plugin-404": "^3.2.1",
 		"@8hobbies/typedoc-plugin-plausible": "^2.2.0",
 		"@catppuccin/vscode": "^3.18.0",
 		"@eslint/eslintrc": "^3.3.1",
@@ -71,6 +73,7 @@
 		"@mercuryworkshop/wisp-js": "^0.3.3",
 		"@nebula-services/bare-server-node": "^2.0.4",
 		"@playwright/test": "^1.55.0",
+		"@reside-ic/typedoc-plugin-copy-doc": "^1.1.2",
 		"@rsdoctor/rspack-plugin": "^1.2.3",
 		"@rslib/core": "^0.13.2",
 		"@rspack/cli": "^1.5.3",
@@ -91,9 +94,17 @@
 		"glob": "^11.0.3",
 		"playwright": "^1.55.0",
 		"prettier": "^3.6.2",
+		"remark": "^15.0.1",
+		"remark-cli": "^12.0.1",
+		"remark-frontmatter": "^5.0.0",
+		"remark-mdx": "^3.1.1",
+		"remark-stringify": "^11.0.0",
 		"ts-checker-rspack-plugin": "^1.1.5",
 		"tsc-alias": "^1.8.16",
 		"tslib": "^2.8.1",
+		"typedoc": "^0.28.12",
+		"typedoc-material-theme": "^1.4.0",
+		"typedoc-plugin-frontmatter": "^1.3.0",
 		"typedoc-plugin-include-example": "^2.1.2",
 		"typedoc-plugin-markdown": "^4.8.1",
 		"typedoc-plugin-mdn-links": "^5.0.9",
@@ -106,9 +117,8 @@
 		"domutils": "^3.2.2",
 		"htmlparser2": "10.0.0",
 		"libcurl.js": "^0.7.2",
+		"idb": "^8.0.3",
 		"parse-domain": "^8.2.2",
-		"set-cookie-parser": "^2.7.1",
-		"typedoc": "^0.28.12",
-		"typedoc-material-theme": "^1.4.0"
+		"set-cookie-parser": "^2.7.1"
 	}
 }