docs: add sitemap

Author: damienwebdev

docs/.vitepress/config.mts

@@ -1,9 +1,12 @@
 import { defineConfig } from 'vitepress'
+import { buildLinks, buildSitemap } from './sitemap-config'
 
 const description = 'A production-like Docker development environment for Magento 2'
+const links: { url: string; lastmod: number | undefined }[] = []
 
 // https://vitepress.dev/reference/site-config
 export default defineConfig({
+  lastUpdated: true,
   title: "Magento 2 Devcontainer",
   description,
   head: [
@@ -12,6 +15,12 @@ export default defineConfig({
     ['meta', { name: 'twitter:description', content: description }],
     ['link', { rel: 'me', href: 'https://twitter.com/graycoreio' }],
   ],
+  transformHtml(_, id, { pageData }) {
+    buildLinks(id, pageData, links)
+  },
+  buildEnd({ outDir }) {
+    buildSitemap(outDir, links)
+  },
   themeConfig: {
     // https://vitepress.dev/reference/default-theme-config
     nav: [

docs/.vitepress/sitemap-config.ts

@@ -0,0 +1,21 @@
+import { createWriteStream } from 'node:fs';
+import { resolve } from 'node:path';
+import { SitemapStream } from 'sitemap';
+import { PageData } from 'vitepress';
+
+export const buildLinks = (id, pageData: PageData, links: { url: string; lastmod: number | undefined }[] = []) => {
+  if (!/[\\/]404\.html$/.test(id)) {
+    links.push({
+      url: pageData.relativePath.replace(/\.md$/, '.html'),
+      lastmod: pageData.lastUpdated,
+    });
+  }
+};
+
+export const buildSitemap = (outDir: string, links: { url: string; lastmod: number | undefined }[] = []) => {
+  const sitemap = new SitemapStream({ hostname: 'https://devcontainer.mappia.io/' });
+  const writeStream = createWriteStream(resolve(outDir, 'sitemap.xml'));
+  sitemap.pipe(writeStream);
+  links.forEach((link) => sitemap.write(link));
+  sitemap.end();
+};

package-lock.json

@@ -23,6 +23,7 @@
     "docs:preview": "vitepress preview docs"
   },
   "devDependencies": {
+    "sitemap": "^9.0.0",
     "vitepress": "^2.0.0-alpha.16"
   }
-}
+}