feat(sitemap): add sitemap generation to docs

apps/docs/package.json

@@ -27,6 +27,7 @@
  "prettier-config": "workspace:*",
  "rimraf": "4.4.1",
  "sass": "1.62.1",
+ "sitemap": "7.1.1",
  "tsconfig": "workspace:*",
  "typescript": "5.0.3",
  "vitepress": "1.0.0-alpha.64"

apps/docs/src/.vitepress/config.ts

@@ -1,10 +1,21 @@
+import { createWriteStream } from 'node:fs'
+import { resolve } from 'node:path'
+import { SitemapStream } from 'sitemap'
+// import { generateSitemap } from 'sitemap-ts'
 import { defineConfig, type HeadConfig } from 'vitepress'
 import { nav, sidebar } from './menu'
 
 /* Base URL for production deployment on Github Pages = shaggytech.com/nhtsa-api-wrapper */
 /* Set env variable VITEPRESS_BASE to '/' for Vercel deployment previews */
 const { VITEPRESS_BASE = '/nhtsa-api-wrapper/' } = process.env
 
+interface SiteMapLink {
+ url: string
+ lastmod?: number
+}
+
+const sitemapLinks: SiteMapLink[] = []
+
 export default defineConfig({
  base: VITEPRESS_BASE,
  lang: 'en-US',
@@ -44,6 +55,38 @@ export default defineConfig({
  copyright: 'Copyright © 2017-present Brandon Eichler',
  },
  },
+
+ // buildEnd: async () => {
+ // return await new Promise((resolve) => {
+ // return resolve(
+ // generateSitemap({
+ // basePath: VITEPRESS_BASE,
+ // hostname: 'https://vpic.shaggytech.com/',
+ // outDir: 'src/.vitepress/dist',
+ // })
+ // )
+ // })
+ // },
+
+ transformHtml: (_, id, { pageData }) => {
+ if (!/[\\/]404\.html$/.test(id))
+ sitemapLinks.push({
+ // you might need to change this if not using clean urls mode
+ url: pageData.relativePath.replace(/((^|\/)index)?\.md$/, '$2'),
+ lastmod: pageData.lastUpdated,
+ })
+ },
+
+ buildEnd: async ({ outDir }) => {
+ const sitemap = new SitemapStream({
+ hostname: 'https://vpic.shaggytech.com/',
+ })
+ const writeStream = createWriteStream(resolve(outDir, 'sitemap.xml'))
+ sitemap.pipe(writeStream)
+ sitemapLinks.forEach((link) => sitemap.write(link))
+ sitemap.end()
+ await new Promise((r) => writeStream.on('finish', r))
+ },
 })
 
 function getHeadTags(): HeadConfig[] {

apps/docs/src/public/robots.txt

@@ -1,3 +1,4 @@
-User-agent: * 
-Disallow:
+User-agent: *
+Allow: /
+
 Sitemap: https://vpic.shaggytech.com/sitemap.xml