docs: feat sitemap (tensorchord#239)

* docs: feat sitemap

Signed-off-by: han <suyanhanx@gmail.com>

* docs: sitemap url config update

Since clean url mode is not currently enabled, update the url in the sitemap to have the html suffix.

Signed-off-by: han <suyanhanx@gmail.com>

Signed-off-by: han <suyanhanx@gmail.com>

docs-zh/.vitepress/config.ts

@@ -1,6 +1,13 @@
 import { defineConfig } from 'vitepress'
 import footnote from 'markdown-it-footnote'
 import { sidebar } from './config/sidebar'
+import { SitemapStream } from 'sitemap'
+import { createWriteStream } from 'node:fs'
+import { resolve } from 'node:path'
+
+// This links array is used to temporarily store all page link information, in order to generate sitemap.
+const links: any[] = []
+const siteHostName = 'https://zh.envd.tensorchord.ai/'
 
 export default defineConfig({
   lang: 'zh-CN',
@@ -93,4 +100,23 @@ export default defineConfig({
       md.use(footnote)
     }
   },
+
+  transformHtml: (_, id, { pageData }) => {
+    if (!/[\\/]404\.html$/.test(id))
+      links.push({
+        url: pageData.relativePath.replace(/\.md$/, '.html'),
+        lastmod: pageData.lastUpdated
+      })
+  },
+
+  buildEnd: async ({ outDir }) => {
+    const sitemap = new SitemapStream({
+      hostname: siteHostName
+    })
+    const writeStream = createWriteStream(resolve(outDir, 'sitemap.xml'))
+    sitemap.pipe(writeStream)
+    links.forEach((link) => sitemap.write(link))
+    sitemap.end()
+    await new Promise((r) => writeStream.on('finish', r))
+  },
 })

docs/.vitepress/config.ts

@@ -1,6 +1,13 @@
 import { defineConfig } from 'vitepress'
 import footnote from 'markdown-it-footnote'
 import { sidebar } from './config/sidebar'
+import { SitemapStream } from 'sitemap'
+import { createWriteStream } from 'node:fs'
+import { resolve } from 'node:path'
+
+// This links array is used to temporarily store all page link information, in order to generate sitemap.
+const links: any[] = []
+const siteHostName = 'https://envd.tensorchord.ai/'
 
 export default defineConfig({
   lang: 'zh-CN',
@@ -25,7 +32,7 @@ export default defineConfig({
       'script',
       {
         async: "true",
-        src: 'https://www.googletagmanager.com/gtag/js?id=G-HRD26FG2QW' 
+        src: 'https://www.googletagmanager.com/gtag/js?id=G-HRD26FG2QW'
       }
     ],
     [
@@ -93,4 +100,23 @@ export default defineConfig({
       md.use(footnote)
     }
   },
+
+  transformHtml: (_, id, { pageData }) => {
+    if (!/[\\/]404\.html$/.test(id))
+      links.push({
+        url: pageData.relativePath.replace(/\.md$/, '.html'),
+        lastmod: pageData.lastUpdated
+      })
+  },
+
+  buildEnd: async ({ outDir }) => {
+    const sitemap = new SitemapStream({
+      hostname: siteHostName
+    })
+    const writeStream = createWriteStream(resolve(outDir, 'sitemap.xml'))
+    sitemap.pipe(writeStream)
+    links.forEach((link) => sitemap.write(link))
+    sitemap.end()
+    await new Promise((r) => writeStream.on('finish', r))
+  },
 })

package.json

@@ -14,7 +14,9 @@
   "author": "",
   "license": "ISC",
   "devDependencies": {
+    "@types/markdown-it-footnote": "^3.0.0",
     "prettier": "2.7.1",
+    "sitemap": "^7.1.1",
     "vitepress": "1.0.0-alpha.33",
     "vue": "^3.2.37"
   },