feat(docs): create robots.txt and update sitemap.xml (#4556)

Signed-off-by: Rui Chen <rui@chenrui.dev>
runatlantis · May 14, 2024 · ee103c3 · ee103c3
1 parent f011608
commit ee103c3
Show file tree

Hide file tree

Showing 3 changed files with 152 additions and 3 deletions.
diff --git a/package.json b/package.json
@@ -6,6 +6,7 @@
     "@types/node": "^20.12.10",
     "@vueuse/core": "^10.9.0",
     "sass": "^1.77.0",
+    "sitemap-ts": "^1.6.1",
     "vitepress": "^1.1.4",
     "vue": "^3.4.27"
   },

diff --git a/pnpm-lock.yaml b/pnpm-lock.yaml
diff --git a/runatlantis.io/.vitepress/config.ts b/runatlantis.io/.vitepress/config.ts
@@ -1,3 +1,4 @@
+import { generateSitemap as sitemap } from "sitemap-ts"
 import { defineConfig } from 'vitepress';
 import * as navbars from "./navbars";
 import * as sidebars from "./sidebars";
@@ -54,6 +55,14 @@ export default defineConfig({
           { icon: "github", link: "https://github.com/runatlantis/atlantis" },
         ],
     },
+    // SEO Improvement - sitemap.xml & robots.txt
+    buildEnd: async ({ outDir }) => {
+        sitemap({
+            hostname: "https://www.runatlantis.io/",
+            outDir: outDir,
+            generateRobotsTxt: true,
+        })
+    },
     head: [
         ['link', { rel: 'icon', type: 'image/png', href: '/favicon-196x196.png', sizes: '196x196' }],
         ['link', { rel: 'icon', type: 'image/png', href: '/favicon-96x96.png', sizes: '96x96' }],
@@ -105,9 +114,6 @@ export default defineConfig({
         })();`,
         ]
     ],
-    sitemap: {
-        hostname: 'https://runatlantis.io'
-    },
     vite: {
         server: {
             fs: {