Options de configuration

Cette page référence toutes les options de configuration acceptées par l’intégration starlight() dans le fichier astro.config.mjs.

Options générales

title

Type : string Requis : oui

Titre du site de documentation. Affiché dans l’en-tête, l’onglet du navigateur et utilisé pour le SEO.

title: 'Documentation MonProjet';

description

Type : string Requis : non

Description du site utilisée dans les balises meta pour le référencement.

description: 'Guide complet pour utiliser MonProjet.';

logo

Type : object Requis : non

Configuration du logo affiché dans la barre de navigation.

logo: {
  src: './src/assets/logo.svg',
  alt: 'Logo MonProjet',
  replacesTitle: false,
}

Propriété	Type	Par défaut	Description
src	string	—	Chemin vers le fichier image.
alt	string	''	Texte alternatif pour l’accessibilité.
replacesTitle	boolean	false	Remplace le titre textuel par le logo.

tableOfContents

Type : object | false Requis : non

Contrôle la table des matières affichée à droite des pages. Passez false pour la désactiver complètement.

tableOfContents: {
  minHeadingLevel: 2,
  maxHeadingLevel: 3,
}

Propriété	Type	Par défaut	Description
minHeadingLevel	number	2	Niveau minimal de titre à inclure.
maxHeadingLevel	number	3	Niveau maximal de titre à inclure.

defaultTheme

Type : 'light' | 'dark' | 'auto' Par défaut : 'auto'

Thème appliqué lors de la première visite. Le mode 'auto' suit la préférence système de l’utilisateur.

defaultTheme: 'dark';

Navigation

sidebar

Type : SidebarGroup[] Requis : non

Structure de la barre latérale de navigation.

sidebar: [
  {
    label: 'Guide',
    items: [
      { label: 'Introduction', slug: 'docs/introduction' },
      { label: 'Installation', slug: 'docs/installation' },
    ],
  },
  {
    label: 'Référence',
    autogenerate: { directory: 'docs/reference' },
  },
];

Chaque groupe accepte :

Propriété	Type	Description
label	string	Titre du groupe.
translations	Record<string, string>	Traductions du label (i18n).
collapsed	boolean	Groupe replié par défaut.
items	SidebarItem[]	Entrées du groupe.
autogenerate	{ directory: string }	Génère les entrées depuis un répertoire.

Chaque item de sidebar accepte :

Propriété	Type	Description
label	string	Texte affiché.
slug	string	Chemin du fichier (sans src/content/docs/).
badge	string	Petit badge affiché à côté du label.
attrs	object	Attributs HTML ajoutés au lien.

social

Type : SocialLink[] Requis : non

Liens sociaux affichés dans l’en-tête du site.

social: [
  {
    icon: 'github',
    label: 'GitHub',
    href: 'https://github.com/mon-projet',
  },
  {
    icon: 'discord',
    label: 'Discord',
    href: 'https://discord.gg/invitation',
  },
];

Icônes disponibles : github, gitlab, discord, x, mastodon, youtube, twitch, linkedin, instagram, threads, bluesky, facebook, rss.

Pied de page

footer

Type : object Requis : non

Configuration du pied de page.

footer: {
  message: '© 2026 MonProjet. Tous droits réservés.',
  href: 'https://mon-projet.com/legal',
}

credits

Type : boolean Par défaut : false

Affiche la mention « Construit avec Starlight » dans le pied de page.

credits: true;

Internationalisation

locales

Type : Record<string, LocaleConfig> Requis : non

Configure les langues supportées par le site.

locales: {
  root: { label: 'Français', lang: 'fr' },
  en: { label: 'English', lang: 'en' },
}

defaultLocale

Type : object Requis : non

Définit la locale par défaut quand la racine est utilisée pour une langue spécifique.

defaultLocale: {
  label: 'Français',
  lang: 'fr',
}

---

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum.