Version

2.15.4

Reproduction link

https://codesandbox.io/s/xenodochial-tree-xr79x?file=/pages/index.vue

Steps to reproduce

Just added the moduel using yarn add @nuxtjs/sitemap,
this is my config.

Modules

modules: [
        // https://go.nuxtjs.dev/axios
        '@nuxtjs/axios',
        // https://go.nuxtjs.dev/pwa
        '@nuxtjs/pwa',
        // https://go.nuxtjs.dev/content
        '@nuxt/content',
        '@nuxtjs/dayjs',
        // keep this module at the end
        '@nuxtjs/sitemap',
    ],

Sitemap options

 sitemap: {
        // options
        hostname: process.env.main_base_URL,
        gzip: true,
        exclude: ['/secret', '/admin/**'],
        routes: [
            '/about',
            '/contact',
            {
                url: '/view/javascript-tips-tricks-n1',
                changefreq: 'daily',
                priority: 1,
                lastmodISO: '2017-06-30T13:30:00.000Z',
            },
        ],
    },

What is expected ?

Should generate a sitemap

What is actually happening?

instead an error pops up that says: [sitemap-module] The hostname option is mandatory in your config on spa or generate build mode

I'm using nuxt-i18n with the prefix strategy, but in my sitemap the route "/knowledge" is created, even though I only want "/en/knowledge" and "/de/wissen". Is there any way to prevent the module from creating this route?

What problem does this feature solve?

For setups which are extremely customised and dynamic it makes more sense to have hreflang links just be an array rather than use nuxt-i18n module. For my company we cannot use nuxt-i18n because we started with a bootstrapped version of SSR and now we're taking a long time to fix the tech load.

What does the proposed changes look like?

 {
    "url": "fr/free",
    "changefreq": "weekly",
    "links": [
      {
        "url": "free",
        "lang": "en"
      },
      {
        "url": "es/free",
        "lang": "es"
      },
      {
        "url": "de/free",
        "lang": "de"
      },
      {
        "url": "pt/free",
        "lang": "pt"
      },
      {
        "url": "it/free",
        "lang": "it"
      },
      {
        "url": "ru/free",
        "lang": "ru"
      }
    ]
  }

What problem does this feature solve?

Hello there,
I thought of something that I think many users of this package would appreciate. I ran into this issue today.

What's the current problem?

If I use the sitemap package and configure it as following:

...
sitemap: {
  hostname: 'https://example.com'
}

all my pages don't have a <priority> entry in the sitemap.xml. If I do:

...
sitemap: {
  hostname: 'https://example.com',
  defaults: {
    priority: 1
  }
}

all pages get the priority 1, which is not the point of a priority itsself.
What I could do now is to define every subpage myself and set the priority to something like 0.80. But then the whole point of the plugin is gone, since I could also just write & update the sitemap.xml myself.

What does the proposed changes look like?

What would be the solution

Maybe to add a config param like prioritySubpages that sets the priority of all subpages to a specific value.
So this:

...
sitemap: {
  hostname: 'https://example.com',
  defaults: {
    priority: 1,
    prioritySubpages: 0.8
  }
}

would be parsed into:

...
<url>
  <loc>https://example.com/</loc>
  <priority>1.00</priority>
</url>
<url>
  <loc>https://example.com/subpage1</loc>
  <priority>0.80</priority>
</url>
<url>
  <loc>https://example.com/subpage2/subsubpage1</loc>
  <priority>0.80</priority>
</url>
...

how to generate dynamic sitemap from graphql api?

Reproduction link

N/A

Steps to reproduce

I want to set the priority like this with generate.routes

What is expected ?

The output sitemap.xml will have priority field

What is actually happening?

Could not find the priority field.

Additional comments?

I believe it's because here omits all the properties except the url.

I'm using this sitemaps config and I get duplicated routes because the static ones get concatenated to the ones fetched by the API

sitemaps: [
{
path: '/sitemap.xml',
cacheTime: false,
},
{
path: '/sitemap-events.xml',
exclude: [],
routes: async () => {
try {
// set request params
const params = {
sortBy: 'id',
direction: 'asc',
public: true,
};
const {data} = await axios.get(https://${process.env.API_BASE_URL}/api/event, {
params
});
const now = new Date();
const routes = data && data.data ?
data.data.map(event => ({
url: /${event.tenant_name}/event/${event.id},
lastmod: now,
priority: 0.8
})) : [];
return routes;
} catch (e) {
return [];
}
}
}
]

Is there a way to exclude the generated routes and only include the ones returned by the routes function in /sitemap-events.xml?

I am running a Nuxt app in SSR mode on a server. My sitemap can grow pretty big with over a million entries. For an older project, I followed this approach with worked fine:

My API server repo (Express app) regularly generates the list of urls and uploads the same to an S3 bucket.

My Nuxt app fetches the file from S3 bucket and dynamically creates sitemaps array during the build step. Here is how it happens

In my nuxt.config.js file, I have:

  sitemap: {
    sitemaps: [
      {
        path: '/sitemap.xml',
        routes: [],
        gzip: false
      }
    ]
  },

And also in the buildModules section:

  buildModules: [
    // Doc: https://github.com/nuxt-community/eslint-module
    '@nuxtjs/eslint-module',
    '~/modules/loadSitemap.js'
  ],

The file loadSitemap.js downloads the file from S3 bucket and for every 10k urls, creates an object like this

        const sitemap = {
          path: `/sitemap${sitemapIndex}.xml`,
          routes: urls,
          gzip: false
        }

And appends the same to this.options.sitemap.sitemaps.push(sitemap). This is working perfectly fine for an old project of mine but not working for a new project even though I am using the same versions of most of the node modules.

Is there any other recommended way of achieving this?

Hi,

I made a sitemap which contains dynamic routes of my FrontendApp + dynamic routes of my BackEnd Api

I noticed that the sitemap was generated during the build / generate of my app. Is it be possible to be generated when we request the route /sitemap.xml ? If it's not possible I would like to be able to launch a CRON every night, how can I do that?

Thank you

Hi everyone, sorry if it's a really basic question.

I am wondering if it's possible to include a stylesheet for the sitemap.xml file generated? Not too sure how to go about doing this with the generated sitemap.xml file. Thanks.

What problem does this feature solve?

Hi,

I'm using https://github.com/nuxt-community/router-module module and I add some custom routes inside router.js file. But because sitemap uses nuxt extendroutes() feature those custom routes font come into sitemap. I also can't add these manually because they are dynamic and based on static nuxt pages.

I add routes like this in loop =>
// if example-x-page does not exists create it

router.addRoutes([{
  name: `example-${pageNumber}-page`,
  path: `/example-${pageNumber}-page`,
  component: examplePage
}])

What does the proposed changes look like?

Support @nuxtjs/router module or enable to access generated .nuxt/routes.js file in routes() function.

@nuxtjs/sitemap just work for spa mode only?
I'am trying for universal mode sitemap.xml not accessible, just showing 404 page

Nico, thank you very much for your help!

I found my issue.

Incorrect code:

  sitemap: async function () {
    return {
      hostname: '',
      gzip: true,
      cacheTime: 1,
      defaults: {
        priority: 1,
        changefreq: 'daily',
        lastmod: new Date()
      },
      routes: await sitemapDynamicPagesGet()
    }
  },

Correct code:

  sitemap: {
    hostname: '',
    gzip: true,
    cacheTime: 1,
    defaults: {
      priority: 1,
      changefreq: 'daily',
      lastmod: new Date()
    },
    routes: async () => sitemapDynamicPagesGet()
  },

Just for reference (in case if someone needs it for any case), how my sitemapDynamicPagesGet() looks like:

export async function sitemapDynamicPagesGet () {
  return await Promise.all([
    function1(),
    function2()
  ])
    .then((results) => {
      const function1Data = results[0]
      const function2Data = results[1]

      const routes = []

      // Proceed function1Data and function2Data
      // ...
      xyz.forEach((data) => {
        routes.push({
          changefreq: 'daily',
          priority: 1,
          lastmod: data.editedAt,
          url: `http://example.com/${data.url}`
        })
      })

      return routes
    })
    .catch((error) => {
      console.log('sitemapDynamicPagesGet error:', error)
    })
}

Also useful example: https://sitemap.nuxtjs.org/usage/sitemap-options/#from-a-function-which-returns-a-promise

I have sitemap config like this:

  sitemap: async function () {
    return {
      hostname: '',
      cacheTime: 1000, // also tried -1
      gzip: true,
      defaults: {
        priority: 1,
        changefreq: 'daily',
        lastmod: new Date()
      },
      routes: await sitemapDynamicPagesGet()
    }
  },

sitemapDynamicPagesGet returns array like this:

[
  {
    changefreq: 'daily',
    priority: 1,
    lastmod: '2020-12-30T17:18:03.566Z'
    url: 'http://localhost:3000/tour/name123'
  },
  {
    changefreq: 'daily',
    priority: 1,
    lastmod: '2021-01-08T19:31:33.636Z'
    url: 'http://localhost:3000/tour/name456'
  }
]

lastmod and url generated based on data received from API.

When I update/re-save tour details on the server (through admin page), I refresh Last edited datetime, but when I refresh sitemap.xml page in the browser I see old/previous lastmod (which was generated/received during "npm run build" process). I have tried to change cacheTime to -1 and to 1000, but this does not help.

I have read this from https://sitemap.nuxtjs.org/usage/sitemap-options#cachetime-optional---number:

Defines how frequently sitemap routes should be updated (value in milliseconds).
Setting a negative value will disable the cache.

Please note that after each invalidation, routes will be evaluated again (see routes declaration section).

and I understand it like in case of "cacheTime: 1000" the function "await sitemapDynamicPagesGet()" must be called, but it is not, so it looks like I do not understand what the cacheTime does/how it works.

What is the way to refresh/update lastmod? Is there a way to run "await sitemapDynamicPagesGet()" every X hours or on each sitemap.xml load in order to keep lastmod up to date?

Thanks a lot.

What problem does this feature solve?

I'm generating the sitemap like the below code.

export default {
  sitemaps: [
    // ...other routes

    {
      path: '/sitemap-users.xml',
      exclude: ['/**'],
      routes() {
        return axios.get('/api/sitemap-users').then(({ data }) => {
          return data.map(user => `/${user.display_name}`)
        })
      }
    },
  ]
}

But my app has about 100k users, so I want to divide sitemap-users.xml into the specified size. (e.g. sitemap-users-1.xml sitemap-users-2.xml)

Not sure if this is the right place, just wanted to notify that the website https://sitemap.nuxtjs.org/ is currently not available and shows Not found

Hi, I'm currently experiencing some issues with Google Search Console marking my Nuxt JS pages as "Duplicate, submitted URL not selected as canonical".

At first, I thought it might've been related to the Nuxt JS content module, but upon further investigation it appears to be many pages. I've used Nuxt JS many times and launched many sites with it, but this is the first site launched that uses the sitemap module and content module.

Rather than me duplicating everything I've mentioned, please review the screenshots and discussion here -> https://github.com/nuxt/content/issues/674 and let me know your thoughts

The project I'm working on is a website that has several stores, and each store has multiple products

I want to create:

1. a basic /sitemap.xml for static routes (about us, privacy policy, etc..)
2. sitemap index(es) to generate a sitemap for each store. The website contains a lot of stores, so here I need something like
   /sitemap_index.xml then /sitemap_index-2.xml and so on
3. sitemap for each store to list urls of its products /:store/sitemap.xml which surprisingly won't need to be paginated due to some limits we apply to product quantities for stores

Now 1 and 3 were easily doable, but for 2, I had to fetch all stores in the system into one sitemap index, which I suppose is not desirable.

Here's my configuration:

sitemap: getSitemapConfig();

function getSitemapConfig() {
  const stores = await getStores({ limit: 8000 });

  return [
    {
      path: '/sitemap.xml',
      i18n: true,
    },
    {
      path: 'sitemap_index.xml',
      sitemaps: stores.map(store => ({
        path: `/${store.name}/sitemap.xml`,
        exclude: ['/**'],
        routes: async () => {
          const { products } = await getProducts();
          return products.map(product => `/${store.name}/${product.sku}`);
        },
      })),
    },
  ];
}

Is there any possible way to achieve such paginated indexes? Thank you lots.