Contribuer
Toute aide est la bienvenue, qu’il s’agisse de remontées, d’ajout de connaissances, corrections ou traductions.
Participer
En cas de problème, vérifier qu’il n’ai pas déjà été remonté. Dans le cas contraire, n’hésitez pas à en ouvrir une nouvelle en utilisant le formulaire dédié.
Pour toute contribution, ce guide détaille la marche à suivre générale pour GitHub.
Les outils
Ce site statique est généré à l’aide de Starlight, un thème construit autour du framework Astro.
N’hésitez pas à vous appuyer sur leurs documentations respectives.
Structure du projet
L’arborescence type d’un projet Astro + Starlight, vous y trouverez les dossiers et fichiers suivants :
Répertoirepublic/
- …
Répertoiresrc/
Répertoireassets/
- …
Répertoirecontent/
Répertoiredocs/
- …
- config.ts
- env.d.ts
- astro.config.mjs
- package.json
- tsconfig.json
Starlight utilise les fichiers .md ou .mdx dans le dossier src/content/docs. Les noms de ces derniers sont utilisés pour le routage.
Les images se trouvent dans src/assets/ afin d’être utilisées dans le Markdown via des liens relatifs.
Les ressources statiques, comme les favicons, sont placées dans le dossier public/.
Commandes
Bun est recommandé et utilisé pour le déploiement, vous pouvez utiliser votre runtime JS préféré mais seul le lockfile de Bun doit être présent dans le projet.
A utiliser à la racine du projet, depuis votre terminal :
| Commande | Action |
|---|---|
bun install | Installation des dépendances |
bun run dev | Le serveur de développement local à localhost:4321 |
bun run build | Génére la version de production dans ./dist/ |
bun run preview | Prévisulisation locale, avant déploiement |
bun run astro ... | Accès aux commandes telles que astro add, astro check |
bun run astro -- --help | L’aide d’Astro |