Remix Sitemap\n\n \n ![\"Version\"](\"https://img.shields.io/npm/v/remix-sitemap.svg\")
\n \n \n ![\"License:](\"https://img.shields.io/badge/License-MIT-yellow.svg\")
\n \n \n ![\"CI\"](\"https://github.com/fedeya/remix-sitemap/actions/workflows/ci.yml/badge.svg\")
\n \n
\n\n> Sitemap generator for Remix applications\n\n## ✨ Features\n\n- Runtime & Build time Generation\n- Generate `robots.txt`\n- v2 Route Convention Support\n- Splitting Sitemaps\n\n## 📚 Table Of Contents\n\n- [✨ Features](#-features)\n- [📚 Table Of Contents](#-table-of-contents)\n- [🚀 Getting Started](#-getting-started)\n - [Installation](#installation)\n - [Usage](#usage)\n - [Runtime Generation](#runtime-generation)\n - [Build time Generation](#build-time-generation)\n- [📝 Guides](#-guides)\n - [Generate Sitemap for Dynamic Routes](#generate-sitemap-for-dynamic-routes)\n - [Exclude Route](#exclude-route)\n - [Google: News, Image and Video](#google-news-image-and-video)\n - [Splitting Sitemaps](#splitting-sitemaps)\n - [Caching](#caching)\n- [📖 API Reference](#-api-reference)\n - [Config](#config)\n - [RobotsTxtOptions](#robotstxtoptions)\n- [👤 Author](#-author)\n- [🤝 Contributing](#-contributing)\n- [Show your support](#show-your-support)\n- [Acknowledgements](#acknowledgements)\n\n\n## 🚀 Getting Started\n\n### Installation\n\n```sh\nnpm i remix-sitemap\n```\n\n### Usage\n\n#### Runtime Generation\n```ts\n// entry.server.tsx\nimport { createSitemapGenerator } from 'remix-sitemap';\n\n// Step 1. setup the generator\nconst { isSitemapUrl, sitemap } = createSitemapGenerator({\n siteUrl: 'https://example.com',\n generateRobotsTxt: true\n // configure other things here\n})\n\nexport default async function handleRequest(\n request: Request,\n responseStatusCode: number,\n responseHeaders: Headers,\n remixContext: EntryContext\n) {\n // Step 2. add the sitemap response\n if (isSitemapUrl(request)) \n return await sitemap(request, remixContext);\n\n let markup = renderToString(\n \n );\n\n responseHeaders.set('Content-Type', 'text/html');\n\n return new Response('' + markup, {\n status: responseStatusCode,\n headers: responseHeaders\n });\n}\n\n```\n\n\n Usage with sitemap[.]xml route (experimental)
\n\n
\n\n1. Create a `lib/sitemap.ts` file\n```ts\n// lib/sitemap.ts\nexport const { experimental_sitemap, robots } = createSitemapGenerator({\n siteUrl: 'https://example.com',\n // configure other things here\n})\n```\n\n2. Create a `sitemap[.]xml` route\n```ts\n// app/routes/sitemap[.]xml.tsx\nimport { routes } from '@remix-run/dev/server-build';\nimport { experimental_sitemap } from '~/lib/sitemap';\n\nexport const loader: LoaderFunction = async ({ request }) => {\n return await experimental_sitemap(request, routes);\n}\n```\n\n\n3. Create a `robots[.]txt` route\n```ts\n// app/routes/robots[.]txt.tsx\nimport { robots } from '~/lib/sitemap';\n\nexport const loader: LoaderFunction = ({ request }) => {\n return robots();\n}\n```\n \n\n#### Build time Generation \n\nCreate a `remix-sitemap.config.js` file at the project root\n```ts\n/** @type {import('remix-sitemap').Config} */\nmodule.exports = {\n siteUrl: 'https://example.com',\n generateRobotsTxt: true\n // configure other things here\n}\n```\nAdd a script using `remix-sitemap` to `package.json` to run after build.\n\nFor example if you are using `npm-run-all`\n```json\n{\n \"scripts\": {\n \"build\": \"npm-run-all build:*\",\n \"build:remix\": \"remix build\",\n \"build:sitemap\": \"remix-sitemap\" \n }\n}\n```\n\n## 📝 Guides\n\n### Generate Sitemap for Dynamic Routes\n> If you are using build time generation, the request will be empty\n```ts\n// app/routes/posts.$slug.tsx\nimport type { SitemapFunction } from 'remix-sitemap';\n\nexport const sitemap: SitemapFunction = ({ config, request }) => {\n const posts = await getPosts();\n \n return posts.map(post => ({\n loc: `/posts/${post.slug}`, \n lastmod: post.updatedAt,\n exclude: post.isDraft, // exclude this entry\n // acts only in this loc\n alternateRefs: [\n {\n href: `${config.siteUrl}/en/posts/${post.slug}`,\n absolute: true,\n hreflang: 'en'\n },\n {\n href: `${config.siteUrl}/es`,\n hreflang: 'es'\n }\n ]\n }));\n};\n```\n\n### Exclude Route\n```ts\n// app/routes/private.tsx\nimport type { SitemapFunction } from 'remix-sitemap';\n\nexport const sitemap: SitemapFunction = () => ({\n exclude: true\n})\n```\n\n### Google: News, Image and Video\nUrl set can contain additional sitemaps defined by google. These are Google [news](https://developers.google.com/search/docs/crawling-indexing/sitemaps/news-sitemap), [image](https://developers.google.com/search/docs/crawling-indexing/sitemaps/image-sitemaps) or [video](https://developers.google.com/search/docs/crawling-indexing/sitemaps/video-sitemaps).\nYou can add these sitemaps in `sitemap function` by adding the `news`, `images` or `videos` property.\n```ts\nexport const sitemap: SitemapFunction = () => ({\n images: [{ loc: 'https://example.com/example.jpg' }],\n news: [{\n title: 'Random News',\n date: '2023-03-15',\n publication: {\n name: 'The Example Times',\n language: 'en'\n }\n }]\n});\n```\n\n### Splitting Sitemaps\nIf you have a lot of urls, you can split the sitemap in multiple files. You can do this by setting the `size` property in the config.\n> This is only available in build time generation\n```ts\n/** @type {import('remix-sitemap').Config} */\nmodule.exports = {\n siteUrl: 'https://example.com',\n size: 10000\n}\n```\n\n### Caching\nyou have two ways to cache the sitemap, the first one is using the `Cache-Control` header\n> This is only available in runtime generation\n```ts\ncreateSitemapGenerator({\n siteUrl: 'https://example.com',\n headers: {\n 'Cache-Control': 'max-age=3600'\n }\n})\n```\nand the second one is using the `cache` property in the config\n```ts\ncreateSitemapGenerator({\n siteUrl: 'https://example.com',\n cache: {\n get: async () => {\n return await redis.get('sitemap') || null;\n },\n set: async (sitemap) => {\n await redis.set('sitemap', sitemap, 'EX', 3600);\n }\n }\n})\n```\n\n## 📖 API Reference\n\n### Config\n\n- `siteUrl`: the website base url\n- `autoLastmod = true`: (*optional*) Add `` property with the current date.\n- `priority = 0.7`: (*optional*) default priority for all entries.\n- `changefreq = 'daily'`: (*optional*) default changefreq for all entries.\n- `format = false`: (*optional*) format the sitemap for a better view.\n- `alternateRefs = []`: (*optional*) default multi language support by unique url for all entries.\n- `generateRobotsTxt = false`: (*optional*) generate `robots.txt` file.\n- `robotsTxtOptions`: (*optional*) options for generating `robots.txt` [details](#RobotsTxtOptions).\n- `rateLimit`: (*optional*) limits the number of `sitemap` functions that can execute at once.\n\n**Runtime only**\n- `headers = {}`: (*optional*) headers for the sitemap and robots.txt response.\n- `cache`: (*optional*) cache the sitemap [details](#Caching).\n\n**Build Time only**\n- `generateIndexSitemap = true`: (*optional*) generate index sitemap.\n- `sitemapBaseFileName = 'sitemap'`: (*optional*) the name of the generated sitemap file before the file extension.\n- `outDir = 'public'`: (*optional*) the directory to create the sitemaps files.\n- `size = 50000`: (*optional*) max size of the sitemap.\n\n#### RobotsTxtOptions\n- `policies = []`: (*optional*) policies for generating `robots.txt`.\n- `additionalSitemaps = []`: (*optional*) add additionals sitemaps to `robots.txt`.\n\n\n## 👤 Author\n\n **Fedeya **\n\n- Website: [fedeminaya.com](https://fedeminaya.com)\n- Twitter: [@fedeminaya](https://twitter.com/fedeminaya)\n- Github: [@fedeya](https://github.com/fedeya)\n- LinkedIn: [@federico-minaya](https://linkedin.com/in/federico-minaya)\n\n## 🤝 Contributing\n\nContributions, issues and feature requests are welcome!
Feel free to check [issues page](https://github.com/Fedeya/next-sanity-client/issues).\n\n## Show your support\n\nGive a ⭐️ if this project helped you!\n\n## Acknowledgements\n\n- [nasa-gcn/remix-seo](https://github.com/nasa-gcn/remix-seo) for finding the posibility to use the server build at runtime.\n","readmeFilename":"README.md"}