Add sitemap (#670)

ngnijland · web-flow · commit 590db1eedc0b · 2025-03-26T10:12:05.000+01:00
* feat: add sitemap

* chore: run formatter
diff --git a/docs/astro.config.mjs b/docs/astro.config.mjs
@@ -1,7 +1,23 @@
 // @ts-check
 import { defineConfig } from "astro/config";
 
+import sitemap from "@astrojs/sitemap";
+
 // https://astro.build/config
 export default defineConfig({
   site: "https://www.rocketsim.app",
+  /**
+   * Add the sitemap plugin
+   *
+   * Configurations:
+   *  - filter: We're filtering the terms and privacy pages, since we don't want them to be indexed.
+   *  - LATER: Add `lastmod`, `changefreq`, and `priority` to the feature and blog pages.
+   */
+  integrations: [
+    sitemap({
+      filter: (page) =>
+        page !== "https://www.rocketsim.app/terms/" &&
+        page !== "https://www.rocketsim.app/privacy/",
+    }),
+  ],
 });
diff --git a/docs/package-lock.json b/docs/package-lock.json
diff --git a/docs/package.json b/docs/package.json
@@ -13,6 +13,7 @@
     "knip": "knip"
   },
   "dependencies": {
+    "@astrojs/sitemap": "^3.3.0",
     "astro": "^5.2.5",
     "marked": "^15.0.7"
   },
diff --git a/docs/public/robots.txt b/docs/public/robots.txt
@@ -0,0 +1,4 @@
+User-agent: *
+Allow: /
+
+Sitemap: https://www.rocketsim.app/sitemap-index.xml
diff --git a/docs/src/layouts/BaseLayout.astro b/docs/src/layouts/BaseLayout.astro
@@ -20,15 +20,19 @@ const ogImage = `${Astro.site}og-banner-rocketsim.jpg`;
   <head>
     <meta charset="UTF-8" />
     <meta name="viewport" content="width=device-width" />
-    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
+
     <meta name="generator" content={Astro.generator} />
+
+    <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
     <link rel="icon" type="image/png" href="/favicon-96x96.png" sizes="96x96" />
     <link rel="icon" type="image/svg+xml" href="/favicon.svg" />
     <link rel="shortcut icon" href="/favicon.ico" />
     <link rel="apple-touch-icon" sizes="180x180" href="/apple-touch-icon.png" />
     <meta name="apple-mobile-web-app-title" content="RocketSim" />
     <link rel="manifest" href="/site.webmanifest" />
 
+    <link rel="sitemap" href="/sitemap-index.xml" />
+
     <title>{pageTitle}</title>
     <meta name="description" content={pageDescription} />
     <link rel="canonical" href={cannonicalUrl} />
