Skip to content

Docs: images is not typed for MetadataRoute.Sitemap #78581

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

Closed
softmarshmallow opened this issue Apr 26, 2025 · 1 comment
Closed

Docs: images is not typed for MetadataRoute.Sitemap #78581

softmarshmallow opened this issue Apr 26, 2025 · 1 comment

Comments

@softmarshmallow
Copy link

What is the documentation issue?

https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap#image-sitemaps

states the images but it's not actually valid (by type)

import type { MetadataRoute } from 'next'
 
export default function sitemap(): MetadataRoute.Sitemap {
  return [
    {
      url: 'https://example.com',
      lastModified: '2021-01-01',
      changeFrequency: 'weekly',
      priority: 0.5,
      images: ['https://example.com/image.jpg'],
    },
  ]
}

Is there any context that might help us understand?

Nope. just confusing

Does the docs page already exist? Please link to it.

https://nextjs.org/docs/app/api-reference/file-conventions/metadata/sitemap#image-sitemaps

@softmarshmallow
Copy link
Author

Turns out it's new on next15. (was using 14)

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

No branches or pull requests

1 participant