@astrojs/sitemap is an npm package designed to generate sitemaps for Astro projects. It helps in creating XML sitemaps that are essential for SEO, allowing search engines to crawl and index your website more effectively.

What are @astrojs/sitemap's main functionalities?

Basic Sitemap Generation

This feature allows you to generate a basic sitemap for your Astro project. By specifying the site URL and integrating the sitemap plugin, you can automatically create a sitemap.xml file.

import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
  site: 'https://example.com',
  integrations: [sitemap()]
});

Customizing Sitemap Options

This feature allows you to customize various options for your sitemap, such as change frequency, priority, excluding specific pages, and adding custom pages.

import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
  site: 'https://example.com',
  integrations: [
    sitemap({
      changefreq: 'daily',
      priority: 0.8,
      exclude: ['/exclude-this-page'],
      customPages: ['/custom-page-1', '/custom-page-2']
    })
  ]
});

Dynamic Sitemap Generation

This feature allows for dynamic generation of the sitemap by filtering and serializing pages. You can exclude certain pages and customize the sitemap entries dynamically.

import { defineConfig } from 'astro/config';
import sitemap from '@astrojs/sitemap';

export default defineConfig({
  site: 'https://example.com',
  integrations: [
    sitemap({
      filter: (page) => !page.includes('/exclude-this-page'),
      serialize: (page) => ({
        url: page,
        lastmod: new Date().toISOString(),
        changefreq: 'weekly',
        priority: 0.5
      })
    })
  ]
});

Other packages similar to @astrojs/sitemap

@astrojs/sitemap 🗺

This Astro integration generates a sitemap based on your pages when you build your Astro project.

Documentation

Read the @astrojs/sitemap docs

Support

Get help in the Astro Discord. Post questions in our #support forum, or visit our dedicated #dev channel to discuss current development and more!
Check our Astro Integration Documentation for more on integrations.
Submit bug reports and feature requests as GitHub issues.

Contributing

This package is maintained by Astro's Core team. You're welcome to submit an issue or PR! These links will help you get started:

License

MIT

Keywords

FAQs

What is @astrojs/sitemap?

Is @astrojs/sitemap popular?

Is @astrojs/sitemap well maintained?

Package last updated on 18 Apr 2024

Did you know?

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install