Nuxt Content

Nuxt Sitemap comes with an integration for Nuxt Content that allows you to configure your sitemap entry straight from your content files directly.

Supported content types. The sitemap integration works with all content file types supported by Nuxt Content:

• Markdown (.md)
• YAML (.yml / .yaml)
• JSON (.json)
• CSV (.csv)

Setup Nuxt Content v3

Add defineSitemapSchema() to your collection's schema to enable the sitemap frontmatter key.

import { defineCollection, defineContentConfig } from '@nuxt/content'
import { defineSitemapSchema } from '@nuxtjs/sitemap/content'
import { z } from 'zod'

export default defineContentConfig({
  collections: {
    content: defineCollection({
      type: 'page',
      source: '**/*.md',
      schema: z.object({
        sitemap: defineSitemapSchema(),
      }),
    }),
  },
})

Filtering Content

Pass a filter function to defineSitemapSchema() to exclude entries at runtime. This is useful for filtering out draft posts, future content, or any entries that shouldn't appear in the sitemap.

import { defineCollection, defineContentConfig } from '@nuxt/content'
import { defineSitemapSchema } from '@nuxtjs/sitemap/content'
import { z } from 'zod'

export default defineContentConfig({
  collections: {
    // The `name` option must match the collection key
    blog: defineCollection({
      type: 'page',
      source: 'blog/**/*.md',
      schema: z.object({
        date: z.string().optional(),
        draft: z.boolean().optional(),
        sitemap: defineSitemapSchema({
          name: 'blog',
          filter: (entry) => {
            if (entry.draft)
              return false
            if (entry.date && new Date(entry.date) > new Date())
              return false
            return true
          },
        }),
      }),
    }),
  },
})

The filter function receives the full content entry including your custom schema fields and should return true to include, false to exclude.

Transforming URLs with onUrl

Use the onUrl callback to transform the sitemap entry for each item in a collection. The callback receives the resolved URL object; mutate it directly to change loc, lastmod, priority, or any other field.

This is especially useful when using per-locale collections with @nuxtjs/i18n. If a collection uses prefix: '/' or prefix: '' to strip the locale directory from content paths, the sitemap URLs will be missing the locale prefix. Use onUrl to re-add it:

import { defineCollection, defineContentConfig } from '@nuxt/content'
import { defineSitemapSchema } from '@nuxtjs/sitemap/content'
import { z } from 'zod'

export default defineContentConfig({
  collections: {
    content_en: defineCollection({
      type: 'page',
      source: { include: 'en/**', prefix: '/' },
      schema: z.object({
        sitemap: defineSitemapSchema(),
      }),
    }),
    content_ja: defineCollection({
      type: 'page',
      source: { include: 'ja/**', prefix: '/' },
      schema: z.object({
        sitemap: defineSitemapSchema({
          name: 'content_ja',
          onUrl(url) {
            url.loc = `/ja${url.loc}`
          },
        }),
      }),
    }),
  },
})

Without onUrl, both collections would produce loc: '/about' for their about.md files. With the transform, the ja collection entries correctly produce loc: '/ja/about', allowing the i18n sitemap builder to assign them to the correct per-locale sitemap.

The callback also receives the full content entry and collection name, so you can use any content field to drive sitemap values:

schema: z.object({
  featured: z.boolean().optional(),
  sitemap: defineSitemapSchema({
    name: 'blog',
    onUrl(url, entry, collection) {
      url.loc = url.loc.replace('/posts/', '/blog/')
      url.priority = entry.featured ? 1.0 : 0.5
    },
  }),
})

Due to current Nuxt Content v3 limitations, you must load the sitemap module before the content module.

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/sitemap',
    '@nuxt/content' // <-- Must be after @nuxtjs/sitemap
  ]
})

Setup comark-content

comark-content is a Markdown-only content module. Nuxt Sitemap supports it first-party, with its own data source named @harlan-zw/comark-content:urls.

No schema opt in is needed. Every page collection is in the sitemap by default.

import { defineCollection, defineContentConfig } from '@harlan-zw/comark-content'

export default defineContentConfig({
  collections: {
    content: defineCollection({
      type: 'page',
      source: '**/*.md',
    }),
  },
})

To keep a collection out of the sitemap, set sitemap: false on the collection.

drafts: defineCollection({
  type: 'page',
  source: 'drafts/**/*.md',
  sitemap: false,
}),

The sitemap frontmatter key works the same as it does with Nuxt Content v3. See Usage.

To exclude every comark URL, add the source to excludeAppSources.

export default defineNuxtConfig({
  sitemap: {
    excludeAppSources: ['@harlan-zw/comark-content:urls'],
  },
})

Usage

Frontmatter sitemap

Use the sitemap key in your frontmatter to add a page to your sitemap.

You can provide any data that you would normally provide in the sitemap configuration.

Markdown example:

---
sitemap:
  loc: /my-page
  lastmod: 2021-01-01
  changefreq: monthly
  priority: 0.8
---

# My Page

YAML example:

title: About Page
description: Learn more about us
sitemap:
  lastmod: 2025-05-13
  changefreq: monthly
  priority: 0.8
content: |
  This is the about page content

JSON example:

{
  "title": "Widget Product",
  "price": 99.99,
  "sitemap": {
    "lastmod": "2025-05-14",
    "changefreq": "weekly",
    "priority": 0.9
  }
}

lastmod from frontmatter dates

The module sets lastmod on a content page from its frontmatter dates:

1. A sitemap.lastmod in frontmatter always wins.
2. Otherwise the modification date: seo.articleModifiedTime, updatedAt, modifiedAt, dateModified or lastModified.
3. Otherwise the publication date: seo.articlePublishedTime, publishedAt, datePublished or date.

A value that is not a date is skipped. The collection schema does not need to declare these keys.

---
publishedAt: 2025-03-01
updatedAt: 2025-06-12
---

This page gets <lastmod>2025-06-12</lastmod>. To read no frontmatter dates, set contentLastmod: false.

Exclude from Sitemap

If you'd like to exclude a page from the sitemap, you can set sitemap: false in the frontmatter or robots: false if you'd like to exclude it from search engines. A robots string that contains noindex or none, such as robots: noindex, nofollow, also excludes the page. The collection schema does not need a robots field.

---
sitemap: false
robots: false
---

Troubleshooting exclusions. If sitemap: false or robots: false aren't working, check the following:

Nuxt Content v3 — Ensure your collection schema includes defineSitemapSchema() in content.config.ts:

import { defineCollection, defineContentConfig } from '@nuxt/content'
import { defineSitemapSchema } from '@nuxtjs/sitemap/content'
import { z } from 'zod'

export default defineContentConfig({
  collections: {
    content: defineCollection({
      type: 'page',
      source: '**/*.md',
      schema: z.object({
        sitemap: defineSitemapSchema(),
      }),
    }),
  },
})

Module load order — The sitemap module must be loaded before the content module:

export default defineNuxtConfig({
  modules: [
    '@nuxtjs/sitemap', // Must be before @nuxt/content
    '@nuxt/content'
  ]
})

If pages still appear after these checks, clear .nuxt and rebuild.