Remix Sitemap 使用教程
2025-05-20 06:11:45作者:殷蕙予
1. 项目介绍
remix-sitemap
是一个为 Remix 应用程序生成站点地图(sitemap)的开源工具。站点地图是一个文件,用来告诉搜索引擎网站上的所有可用页面,有助于搜索引擎更好地索引网站内容。remix-sitemap
支持运行时和构建时生成站点地图,同时还能生成 robots.txt
文件,用于控制搜索引擎的抓取和索引行为。
2. 项目快速启动
安装
首先,您需要在 Remix 项目中安装 remix-sitemap
:
npm i remix-sitemap
运行时生成
在 entry.server.tsx
文件中,配置并使用 createSitemapGenerator
函数:
import { createSitemapGenerator } from 'remix-sitemap';
// 配置站点地图生成器
const { isSitemapUrl, sitemap } = createSitemapGenerator({
siteUrl: 'https://example.com',
generateRobotsTxt: true,
// 其他配置项...
});
export default async function handleRequest(
request: Request,
responseStatusCode: number,
responseHeaders: Headers,
remixContext: EntryContext
) {
// 判断是否为站点地图请求
if (isSitemapUrl(request)) {
return await sitemap(request, remixContext);
}
// 渲染页面内容
let markup = renderToString(
<RemixServer context={{ remixContext }} url={{ request.url }} />
);
// 设置响应头
responseHeaders.set('Content-Type', 'text/html');
// 返回响应
return new Response(`<!DOCTYPE html>${markup}`, {
status: responseStatusCode,
headers: responseHeaders,
});
};
构建时生成
在项目根目录创建一个 remix-sitemap.config.js
配置文件:
module.exports = {
siteUrl: 'https://example.com',
generateRobotsTxt: true,
// 其他配置项...
};
然后在 package.json
中添加一个构建脚本:
{
"scripts": {
"build": "npm-run-all build:*",
"build:remix": "remix build",
"build:sitemap": "remix-sitemap"
}
}
运行构建脚本时,remix-sitemap
将会在构建过程中生成站点地图。
3. 应用案例和最佳实践
动态路由的站点地图
如果您的应用程序有动态路由,您可以在相应的路由文件中定义一个 sitemap
函数来生成动态内容的站点地图条目。
export const sitemap: SitemapFunction = async ({ config, request }) => {
const posts = await getPosts();
return posts.map(post => ({
loc: `/posts/${post.slug}`,
lastmod: post.updatedAt,
exclude: post.isDraft,
alternateRefs: [
{ href: `${config.siteUrl}/en/posts/${post.slug}`, hreflang: 'en' },
{ href: `${config.siteUrl}/es`, hreflang: 'es' }
]
}));
};
排除特定路由
如果某些页面不应该包含在站点地图中,可以设置 exclude
属性为 true
。
export const sitemap: SitemapFunction = () => ({
exclude: true
});
缓存站点地图
为了提高性能,可以使用缓存机制来存储站点地图内容。
createSitemapGenerator({
siteUrl: 'https://example.com',
cache: {
get: async () => await redis.get('sitemap') || null,
set: async (sitemap) => await redis.set('sitemap', sitemap, 'EX', 3600)
}
});
4. 典型生态项目
由于 remix-sitemap
是为 Remix 应用程序设计的,因此它是 Remix 生态系统的一部分。在 Remix 应用中,您可以结合使用其他 Remix 相关的库和工具,例如 remix-run
、remix-seo
等,以构建完整且功能丰富的 Web 应用程序。
登录后查看全文
热门项目推荐
- QQwen3-Omni-30B-A3B-InstructQwen3-Omni是多语言全模态模型,原生支持文本、图像、音视频输入,并实时生成语音。00
community
本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息09GitCode-文心大模型-智源研究院AI应用开发大赛
GitCode&文心大模型&智源研究院强强联合,发起的AI应用开发大赛;总奖池8W,单人最高可得价值3W奖励。快来参加吧~0274get_jobs
💼【AI找工作助手】全平台自动投简历脚本:(boss、前程无忧、猎聘、拉勾、智联招聘)Java01Hunyuan3D-2
Hunyuan3D 2.0:高分辨率三维生成系统,支持精准形状建模与生动纹理合成,简化资产再创作流程。Python00Spark-Chemistry-X1-13B
科大讯飞星火化学-X1-13B (iFLYTEK Spark Chemistry-X1-13B) 是一款专为化学领域优化的大语言模型。它由星火-X1 (Spark-X1) 基础模型微调而来,在化学知识问答、分子性质预测、化学名称转换和科学推理方面展现出强大的能力,同时保持了强大的通用语言理解与生成能力。Python00GOT-OCR-2.0-hf
阶跃星辰StepFun推出的GOT-OCR-2.0-hf是一款强大的多语言OCR开源模型,支持从普通文档到复杂场景的文字识别。它能精准处理表格、图表、数学公式、几何图形甚至乐谱等特殊内容,输出结果可通过第三方工具渲染成多种格式。模型支持1024×1024高分辨率输入,具备多页批量处理、动态分块识别和交互式区域选择等创新功能,用户可通过坐标或颜色指定识别区域。基于Apache 2.0协议开源,提供Hugging Face演示和完整代码,适用于学术研究到工业应用的广泛场景,为OCR领域带来突破性解决方案。00- HHowToCook程序员在家做饭方法指南。Programmer's guide about how to cook at home (Chinese only).Dockerfile09
- PpathwayPathway is an open framework for high-throughput and low-latency real-time data processing.Python00
热门内容推荐
最新内容推荐
项目优选
收起

OpenHarmony documentation | OpenHarmony开发者文档
Dockerfile
152
1.96 K

deepin linux kernel
C
22
6

本项目是CANN提供的数学类基础计算算子库,实现网络在NPU上加速计算。
C++
431
34

本项目是CANN开源社区的核心管理仓库,包含社区的治理章程、治理组织、通用操作指引及流程规范等基础信息
251
9

openGauss kernel ~ openGauss is an open source relational database management system
C++
145
190

旨在打造算法先进、性能卓越、高效敏捷、安全可靠的密码套件,通过轻量级、可剪裁的软件技术架构满足各行业不同场景的多样化要求,让密码技术应用更简单,同时探索后量子等先进算法创新实践,构建密码前沿技术底座!
C
989
394

Nop Platform 2.0是基于可逆计算理论实现的采用面向语言编程范式的新一代低代码开发平台,包含基于全新原理从零开始研发的GraphQL引擎、ORM引擎、工作流引擎、报表引擎、规则引擎、批处理引引擎等完整设计。nop-entropy是它的后端部分,采用java语言实现,可选择集成Spring框架或者Quarkus框架。中小企业可以免费商用
Java
8
0

React Native鸿蒙化仓库
C++
193
274

🎉 (RuoYi)官方仓库 基于SpringBoot,Spring Security,JWT,Vue3 & Vite、Element Plus 的前后端分离权限管理系统
Vue
936
554

为非计算机科班出身 (例如财经类高校金融学院) 同学量身定制,新手友好,让学生以亲身实践开源开发的方式,学会使用计算机自动化自己的科研/创新工作。案例以量化投资为主线,涉及 Bash、Python、SQL、BI、AI 等全技术栈,培养面向未来的数智化人才 (如数据工程师、数据分析师、数据科学家、数据决策者、量化投资人)。
Python
75
69