自动生成网站sitemap

要在 Next.js 和 Contentlayer 项目中实现自动生成 Sitemap 的功能,你可以编写一个脚本,在每次生成文档后自动生成 Sitemap。以下是一个示例脚本,你可以根据自己的需求进行调整。

步骤 1:安装必要的依赖

首先,你需要安装必要的依赖库,用于生成 Sitemap 和处理文件系统:

bash 复制代码
npm install fs path xmlbuilder contentlayer

步骤 2:编写生成 Sitemap 的脚本

在你的项目根目录下创建一个 generate-sitemap.js 文件,并添加以下代码:

javascript 复制代码
const fs = require('fs');
const path = require('path');
const { xmlbuilder } = require('xmlbuilder');
const { allDocuments } = require('.contentlayer/generated');

// 网站的基础 URL
const BASE_URL = 'https://www.yoursite.com';

// 生成 Sitemap XML
const generateSitemap = () => {
  // 创建根元素
  const urlset = xmlbuilder.create('urlset', { encoding: 'UTF-8' });
  urlset.att('xmlns', 'http://www.sitemaps.org/schemas/sitemap/0.9');

  // 添加文档页面
  allDocuments.forEach((doc) => {
    const url = urlset.ele('url');
    url.ele('loc', `${BASE_URL}/${doc.url}`);
    url.ele('lastmod', new Date(doc.date).toISOString());
    url.ele('changefreq', 'monthly');
    url.ele('priority', '0.8');
  });

  // 生成 XML 字符串
  const xml = urlset.end({ pretty: true });

  // 写入 sitemap.xml 文件
  const sitemapPath = path.join(__dirname, 'public', 'sitemap.xml');
  fs.writeFileSync(sitemapPath, xml);

  console.log('Sitemap generated at', sitemapPath);
};

// 执行生成 Sitemap 的函数
generateSitemap();

步骤 3:在生成文档后自动运行脚本

要确保每次 Contentlayer 生成文档后自动运行这个脚本,可以在 package.json 中添加一个新的脚本命令。你可以使用 postbuild 钩子,确保在构建项目后运行 Sitemap 生成脚本:

json 复制代码
{
  "scripts": {
    "build": "next build && next export",
    "postbuild": "node generate-sitemap.js"
  }
}

步骤 4:确保文档生成路径和 URL 处理正确

在脚本中,我们假设 allDocuments 是从 Contentlayer 生成的文档集合中获取的。如果你的文档集合属性名称或路径不同,请相应地进行调整。

步骤 5:运行构建

现在,你可以运行 npm run build,这个命令将在生成文档后自动生成 Sitemap:

bash 复制代码
npm run build

完成以上步骤后,每次你构建项目时,Sitemap 都会自动生成,并保存在 public/sitemap.xml 中。

总结

以上脚本展示了如何在 Next.js 和 Contentlayer 项目中自动生成 Sitemap。你可以根据自己的需求调整脚本,如更改 Sitemap 的属性、URL 格式等。这个自动化过程确保了每次文档更新后,Sitemap 都能及时更新,提升搜索引擎对网站内容的抓取效率。

参考原文:https://offernow.cn

相关推荐
JieE2123 小时前
LeetCode 226. 翻转二叉树|JS 递归超详细拆解,二叉树入门经典题
javascript·算法
JieE2124 小时前
LeetCode 104. 二叉树的最大深度|递归思路超详细拆解
javascript·算法
kyriewen7 小时前
我用 AI 一周写完了整个项目,上线第一天就崩了——这是我踩过最贵的 5 个坑
前端·javascript·ai编程
Larcher8 小时前
AI Loop:让AI像人一样自主完成任务的核心机制
javascript·人工智能·设计模式
默_笙8 小时前
🃏 JS 只有 8 种数据类型,但我花了 2 天才搞懂 null 和 undefined 的区别
javascript
jump_jump9 小时前
流式 HTML:从 htmx 片段装配到浏览器原生增量渲染
javascript·性能优化·前端工程化
swipe10 小时前
正则表达式入门到进阶:从表单校验到手写模板引擎
前端·javascript·面试
kyriewen10 小时前
前端错误监控最全指南:捕获 JS 异常、Promise 拒绝、资源加载失败,附上报代码
前端·javascript·监控
大家的林语冰11 小时前
ESLint 近期动态大全,新版本正式发布,antfu 大佬推荐的插件也更新了!
前端·javascript·前端工程化
胡志辉12 小时前
深入浅出 call、apply、bind
前端·javascript·后端