Skip to content

feat(router-sitemap): Add sitemap package for generating sitemap xml #4543

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 16 commits into
base: main
Choose a base branch
from

Conversation

danecando
Copy link
Contributor

@danecando danecando commented Jun 28, 2025

Add @tanstack/router-sitemap package with XML sitemap generation for TanStack Router applications

Features

Vite Plugin - Generate static XML sitemaps during build process
Runtime Generation - Create sitemaps dynamically in API routes using TanStack Start
Dynamic Routes - Support for parameterized routes with async data fetching
Route Configuration - Flexible route definitions with priority, changefreq, and lastmod options
Type Safety - Inference for routes in the sitemap configuration

Usage Examples

Vite Plugin:

sitemapPlugin({
  sitemap: {
    siteUrl: 'https://example.com',
    routes: ['/', '/about']
  }
})

API Route:

const sitemap = await generateSitemap({
  siteUrl: 'https://example.com',
  routes: [
    '/',
    ['/posts/$postId', async () => posts.map(p => ({ path: `/posts/${p.id}` }))]
  ]
})

return new Response(sitemap, {   
  headers: {
    'Content-Type': 'application/xml',
  }, 
})

@danecando danecando force-pushed the feat/sitemap-generator branch from b8533d0 to a3674e3 Compare July 1, 2025 00:47
Copy link

nx-cloud bot commented Jul 1, 2025

View your CI Pipeline Execution ↗ for commit a3eb3f8.

Command Status Duration Result
nx affected --targets=test:eslint,test:unit,tes... ✅ Succeeded 1m 47s View ↗
nx run-many --target=build --exclude=examples/*... ✅ Succeeded 1s View ↗

☁️ Nx Cloud last updated this comment at 2025-07-01 01:09:40 UTC

@danecando danecando marked this pull request as ready for review July 1, 2025 00:48
Copy link

pkg-pr-new bot commented Jul 1, 2025

More templates

@tanstack/arktype-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/arktype-adapter@4543

@tanstack/directive-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/directive-functions-plugin@4543

@tanstack/eslint-plugin-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/eslint-plugin-router@4543

@tanstack/history

npm i https://pkg.pr.new/TanStack/router/@tanstack/history@4543

@tanstack/react-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router@4543

@tanstack/react-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-devtools@4543

@tanstack/react-router-with-query

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-router-with-query@4543

@tanstack/react-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start@4543

@tanstack/react-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-client@4543

@tanstack/react-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-plugin@4543

@tanstack/react-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/react-start-server@4543

@tanstack/router-cli

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-cli@4543

@tanstack/router-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-core@4543

@tanstack/router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools@4543

@tanstack/router-devtools-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-devtools-core@4543

@tanstack/router-generator

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-generator@4543

@tanstack/router-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-plugin@4543

@tanstack/router-sitemap

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-sitemap@4543

@tanstack/router-utils

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-utils@4543

@tanstack/router-vite-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/router-vite-plugin@4543

@tanstack/server-functions-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/server-functions-plugin@4543

@tanstack/solid-router

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router@4543

@tanstack/solid-router-devtools

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-router-devtools@4543

@tanstack/solid-start

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start@4543

@tanstack/solid-start-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-client@4543

@tanstack/solid-start-plugin

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-plugin@4543

@tanstack/solid-start-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/solid-start-server@4543

@tanstack/start-client-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-client-core@4543

@tanstack/start-plugin-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-plugin-core@4543

@tanstack/start-server-core

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-core@4543

@tanstack/start-server-functions-client

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-client@4543

@tanstack/start-server-functions-fetcher

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-fetcher@4543

@tanstack/start-server-functions-server

npm i https://pkg.pr.new/TanStack/router/@tanstack/start-server-functions-server@4543

@tanstack/valibot-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/valibot-adapter@4543

@tanstack/virtual-file-routes

npm i https://pkg.pr.new/TanStack/router/@tanstack/virtual-file-routes@4543

@tanstack/zod-adapter

npm i https://pkg.pr.new/TanStack/router/@tanstack/zod-adapter@4543

commit: a3eb3f8

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant