VitePress 站点地图中 lastmod 时间戳的优化方案

问题背景

在使用 VitePress 构建文档网站时，站点地图(sitemap.xml)中的 lastmod 时间戳默认仅使用 Git 提交时间，而忽略了 frontmatter 中设置的 lastUpdated 值。这可能导致站点地图显示的最后更新时间与实际内容更新时间不一致。

问题分析

VitePress 内置的站点地图生成功能存在以下行为特点：

1. 默认情况下，lastmod 属性仅从 Git 提交历史中获取时间戳
2. 即使在前置元数据(frontmatter)中明确设置了 lastUpdated 字段，该值也不会被站点地图采用
3. 这种设计在某些场景下不够灵活，特别是当内容更新不通过 Git 提交时

解决方案

我们可以通过配置 VitePress 的 sitemap 选项，自定义 transformItems 方法来实现更灵活的时间戳控制。以下是完整的实现方案：

import fs from "fs";

export default defineConfig({
    sitemap: {
        hostname: "您的域名",
        transformItems: (items) => {
            items.forEach(item => {
                const url = item.url;
                const file = "docs/" + url + ".md"; // 根据实际项目结构调整路径
                try {
                    const data = fs.readFileSync(file, "utf-8");
                    const getUpdatedTime = data => {
                        const allLines = data.split("\n");
                        for (let i = 0; i < allLines.length; i++) {
                            const currentLine = allLines[i];
                            if (i > 1 && currentLine === "---") {
                                console.warn("前置元数据中未设置lastUpdated时间");
                                return null;
                            }
                            if (currentLine.indexOf("lastUpdated") >= 0) {
                                return currentLine.replace("lastUpdated:", "").trim();
                            }
                        }
                    }
                    const newUpdatedTime = getUpdatedTime(data);
                    if (newUpdatedTime) {
                        item.lastmod = newUpdatedTime;
                    }
                } catch (err) {
                    console.error(err);
                }
            });
            return items;
        }
    },
});

实现原理

1. 文件读取：通过 Node.js 的 fs 模块直接读取对应的 Markdown 文件内容
2. 前置元数据解析：逐行扫描文件内容，查找包含 lastUpdated 字段的行
3. 时间戳提取：从找到的行中提取出时间戳字符串
4. 时间戳替换：将站点地图项中的 lastmod 属性替换为从前置元数据中提取的时间

注意事项

1. 路径配置需要根据实际项目结构调整，示例中使用的是 docs/ 目录
2. 该方法会捕获并处理文件读取错误，但不会中断站点地图生成过程
3. 如果前置元数据中没有设置 lastUpdated，将保持原有的 Git 提交时间
4. 性能考虑：对于大型站点，频繁的文件读取可能影响构建速度

最佳实践建议

1. 在前置元数据中使用标准化的时间格式，如 ISO 8601 格式
2. 考虑添加缓存机制来优化大型站点的构建性能
3. 可以将此逻辑封装为插件，提高代码复用性
4. 在 CI/CD 流程中验证站点地图生成结果

通过这种定制化方案，我们可以更精确地控制站点地图中的最后更新时间，确保其与实际内容更新保持同步，这对于 SEO 优化和内容管理都有重要意义。