Skip to content

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

@softmarshmallow

Description

@softmarshmallow

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

Metadata

Metadata

Assignees

No one assigned

    Labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions