Skip to content

Installation

Ce guide détaille les différentes méthodes pour installer Lumen, que vous partiez d’un nouveau projet ou d’un projet Astro existant.

La méthode la plus rapide consiste à utiliser l’assistant de création :

Terminal window
pnpm create astro@latest -- --template starlight

Cette commande crée un nouveau dossier avec tous les fichiers nécessaires et installe les dépendances.

Si vous avez déjà un projet Astro, ajoutez Lumen comme intégration :

Terminal window
pnpm add @astrojs/starlight

Puis modifiez votre fichier astro.config.mjs :

import { defineConfig } from 'astro/config';
import starlight from '@astrojs/starlight';
export default defineConfig({
integrations: [
starlight({
title: 'Ma Documentation',
description: 'Un site de documentation propulsé par Lumen.',
}),
],
});

Le moteur de recherche est activé par défaut. Aucune dépendance supplémentaire n’est nécessaire : il fonctionne entièrement côté client avec Pagefind.

Pour générer automatiquement des images responsives et optimisées, installez Sharp :

Terminal window
pnpm add sharp

Pour utiliser des composants React, Vue ou Svelte dans vos pages MDX, ajoutez l’intégration correspondante :

Terminal window
# React
pnpm add @astrojs/react
# Vue
pnpm add @astrojs/vue
# Svelte
pnpm add @astrojs/svelte

Pour vérifier que l’installation s’est bien déroulée, lancez le serveur de développement :

Terminal window
pnpm dev

Si tout est correct, vous verrez la page d’accueil de votre documentation à l’adresse http://localhost:4321.

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.