Intro

This page contains information pertaining the configuration of the sitemap generation process, if you are looking for ways to configure the graph component, see the graph configuration.

The sitemap configuration can be set in one of two ways:

Via Plugin Settings

astro.config.mjs

import starlight from '@astrojs/starlight'
import { defineConfig } from 'astro/config'
import starlightSiteGraph from 'starlight-site-graph'
export default defineConfig({
  integrations: [
    starlight({
      plugins: [starlightSiteGraph({
        sitemapConfig: {
          // Global sitemap configuration
        }
      })],
    }),
  ],
})

Via Frontmatter

Note

This only applies to the <PageGraph/> and <PageBacklinks/> components. Furthermore, this does not affect the whole sitemap, but only the sitemap data for the current page.

src/content/docs/my-page.md

---
 title: My Page
 sitemap:
   include: true
   config: ...
---

My page content goes here!

Sections

General Settings Configure the general settings for the sitemap generation.

Inclusion Settings Configure which pages/links will get included in the sitemap.

Post-Processing Settings Configure what additional information gets added to the sitemap.