Démarrage rapide
Ce guide vous accompagne dans la création de votre premier site de documentation avec Lumen. À la fin de ce tutoriel, vous aurez un site fonctionnel, prêt à être enrichi avec votre contenu.
Prérequis
Section titled “Prérequis”Avant de commencer, assurez-vous d’avoir installé les outils suivants sur votre machine :
- Node.js version 18 ou supérieure
- pnpm comme gestionnaire de paquets (recommandé)
Vous pouvez vérifier vos versions avec les commandes suivantes :
node --versionpnpm --versionCréer un nouveau projet
Section titled “Créer un nouveau projet”Lumen fournit un assistant de création qui configure tout automatiquement. Lancez la commande suivante dans votre terminal :
pnpm create astro@latest mon-docs -- --template starlightL’assistant vous posera quelques questions :
- Nom du projet — Choisissez un nom descriptif pour votre documentation.
- TypeScript — Nous recommandons d’activer TypeScript pour une meilleure expérience de développement.
- Git — Initialisez un dépôt Git pour suivre l’historique de vos modifications.
Structure du projet
Section titled “Structure du projet”Une fois le projet créé, vous obtenez l’arborescence suivante :
mon-docs/├── astro.config.mjs # Configuration du site├── src/│ ├── assets/ # Images et fichiers statiques│ ├── content/ # Pages de documentation│ │ └── docs/│ │ ├── index.mdx│ │ ├── guides/│ │ └── reference/│ └── styles/ # Styles CSS personnalisés├── public/ # Fichiers publics (favicon, etc.)└── package.jsonLancer le serveur de développement
Section titled “Lancer le serveur de développement”Démarrez le serveur local pour prévisualiser votre documentation :
pnpm devOuvrez http://localhost:4321 dans votre navigateur. Chaque modification d’un fichier source recharge automatiquement la page.
Prochaines étapes
Section titled “Prochaines étapes”Vous avez maintenant un site de documentation opérationnel. Consultez le guide d’installation pour connecter Lumen à votre projet existant, ou le guide de configuration pour personnaliser l’apparence et le comportement de votre site.
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.