web: 404 page for github pages

thomcleary · Jun 22, 2024 · 4c09ad7 · 4c09ad7
1 parent add5c85
commit 4c09ad7
Show file tree

Hide file tree

Showing 4 changed files with 55 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,6 +1,8 @@
 # 🔌 🧱 nand2tetris
 
-<https://www.nand2tetris.org>
+## Web
+
+- <https://thomcleary.github.io/nand2tetris>
 
 ## Part 1: Hardware
 
@@ -23,3 +25,5 @@
 | 10  | Compiler I: Syntax Analysis   | Jack Compiler (Syntax Analyzer) |    ✅     |
 | 11  | Compiler II: Code Generation  | Jack Compiler (Code Generator)  |    ✅     |
 | 12  | Operating System              | Jack OS                         |           |
+
+<https://www.nand2tetris.org>
diff --git a/web/TODO.md b/web/TODO.md
@@ -1,12 +1,5 @@
 # TODO
 
-## deploy
-
-- deploy to github pages
-- test what happens when going to route that doesnt exist
-  - 404 page or does the `goto` in `+error.svelte` work?
-  - does a fallback need to be set in adapter config? (read docs?)
-
 ## cleanup
 
 - organise colors into css variables
diff --git a/web/src/404.html b/web/src/404.html
@@ -0,0 +1,50 @@
+<!doctype html>
+<html>
+	<head>
+		<meta charset="utf-8" />
+		<title>Single Page Apps for GitHub Pages</title>
+		<script type="text/javascript">
+			// Single Page Apps for GitHub Pages
+			// MIT License
+			// https://github.com/rafgraph/spa-github-pages
+			// This script takes the current url and converts the path and query
+			// string into just a query string, and then redirects the browser
+			// to the new url with only a query string and hash fragment,
+			// e.g. https://www.foo.tld/one/two?a=b&c=d#qwe, becomes
+			// https://www.foo.tld/?/one/two&a=b~and~c=d#qwe
+			// Note: this 404.html file must be at least 512 bytes for it to work
+			// with Internet Explorer (it is currently > 512 bytes)
+
+			// If you're creating a Project Pages site and NOT using a custom domain,
+			// then set pathSegmentsToKeep to 1 (enterprise users may need to set it to > 1).
+			// This way the code will only replace the route part of the path, and not
+			// the real directory in which the app resides, for example:
+			// https://username.github.io/repo-name/one/two?a=b&c=d#qwe becomes
+			// https://username.github.io/repo-name/?/one/two&a=b~and~c=d#qwe
+			// Otherwise, leave pathSegmentsToKeep as 0.
+			var pathSegmentsToKeep = 0;
+
+			var l = window.location;
+			l.replace(
+				l.protocol +
+					'//' +
+					l.hostname +
+					(l.port ? ':' + l.port : '') +
+					l.pathname
+						.split('/')
+						.slice(0, 1 + pathSegmentsToKeep)
+						.join('/') +
+					'/?/' +
+					l.pathname
+						.slice(1)
+						.split('/')
+						.slice(pathSegmentsToKeep)
+						.join('/')
+						.replace(/&/g, '~and~') +
+					(l.search ? '&' + l.search.slice(1).replace(/&/g, '~and~') : '') +
+					l.hash
+			);
+		</script>
+	</head>
+	<body></body>
+</html>
diff --git a/web/src/routes/+error.svelte b/web/src/routes/+error.svelte