Merge pull request #130 from neherlab/docs/fix-routing

chore: rewrite url in docs site

Author: ivan-aksamentov

Diff for: docs/bun.lockb

@@ -22,9 +22,6 @@ pushd "build" >/dev/null
   # Remove non-HTML files
   find . -type f \( ! -iname "*.html" \) -exec rm {} \+
 
-  # Remove .html extension
-  rename --filename 's/\.html//' **/*.html || true
-
   # Upload extensionless HTML files
   aws s3 sync \
     --delete \
@@ -33,6 +30,7 @@ pushd "build" >/dev/null
     --cache-control "max-age=0, must-revalidate" \
     --metadata-directive REPLACE \
     --exclude "*.*" \
+    --include "*.html" \
     . "s3://${AWS_S3_BUCKET}/"
 
   # Update Cloudfront cache

Diff for: docs/deploy

@@ -0,0 +1,22 @@
+// Add index.html to request URLs without a file name in a CloudFront Functions viewer request event
+// https://docs.aws.amazon.com/AmazonCloudFront/latest/DeveloperGuide/example_cloudfront_functions_url_rewrite_single_page_apps_section.html
+async function handler(event) {
+  const request = event.request;
+  let uri = request.uri;
+
+  // Check whether the URI ends with a slash (indicating it's likely a directory)
+  if (uri.endsWith('/')) {
+    request.uri += 'index.html';
+  }
+
+  // Check whether the URI is missing a file extension (indicating it might be a directory)
+  else if (!uri.includes('.')) {
+    request.uri += '/index.html';
+  }
+
+  return request;
+}
+
+if (typeof module !== 'undefined') {
+  module.exports = handler;
+}

Diff for: docs/infra/serve-index-html-for-directories.js

@@ -0,0 +1,23 @@
+import { describe, expect, it } from 'vitest';
+import handler from './serve-index-html-for-directories.js';
+
+const testCases = [
+  { uri: '', expected: '/index.html' },
+  { uri: '/', expected: '/index.html' },
+  { uri: '/foo', expected: '/foo/index.html' },
+  { uri: '/foo/', expected: '/foo/index.html' },
+  { uri: '/foo.html', expected: '/foo.html' },
+  { uri: '/foo/bar', expected: '/foo/bar/index.html' },
+  { uri: '/foo/bar/', expected: '/foo/bar/index.html' },
+  { uri: '/foo/bar/baz.html', expected: '/foo/bar/baz.html' },
+];
+
+describe('CloudFront URL Rewriter Tests', () => {
+  testCases.forEach(({ uri, expected }) => {
+    it(`handles URI '${uri}' correctly`, async () => {
+      const event = { request: { uri } };
+      const result = await handler(event);
+      expect(result.uri).toBe(expected);
+    });
+  });
+});

Diff for: docs/infra/serve-index-html-for-directories.test.js

@@ -32,7 +32,8 @@
     "@docusaurus/tsconfig": "3.5.2",
     "@docusaurus/types": "3.5.2",
     "prettier": "^3.3.3",
-    "typescript": "~5.5.2"
+    "typescript": "~5.5.2",
+    "vitest": "^3.0.5"
   },
   "browserslist": {
     "production": [