Configuration

The Starlight Table of Contents Overview Customizer plugin can be configured inside the astro.config.mjs configuration file of your project:

astro.config.mjs

import starlight from "@astrojs/starlight";
import { defineConfig } from "astro/config";
import starlightTocOverviewCustomizer from "starlight-toc-overview-customizer";

export default defineConfig({
  integrations: [
    starlight({
      plugins: [
        starlightTocOverviewCustomizer({
          // Configuration options go here.
        }),
      ],
      title: "My Docs",
    }),
  ],
});

Configuration options

The Starlight Table of Contents Overview Customizer plugin accepts the following configuration options:

overviewTitle

Type: string | Record<string, string>
Default: undefined

Define the table of contents overview title for all pages on the site. This can be a string or an object with keys that match the locales of your site.

export default defineConfig({
  integrations: [
    starlight({
      locales: {
        root: {
          label: "English",
          lang: "en",
        },
        fr: {
          label: "Français",
        },
      }
      plugins: [
        starlightTocOverviewCustomizer({
          overviewTitle: {
            en: "Overview",
            fr: "Aperçu",
          },
        });
      ],
    }),
  ],
});