Mode d’emploi 📖

Cette page explique comment créer et publier un site multipages avec ce modèle.

1. Créer votre projet

Depuis la page du modèle sur la Forge, cliquez sur Créer une bifurcation pour dupliquer le dépôt dans votre espace personnel ou dans un groupe.

Ouvrir le dépôt du modèle

Vous pouvez choisir librement le chemin du projet. Le site publié fonctionne dans les deux cas :

• à la racine : https://nom_du_site.forge.apps.education.fr/ ;
• dans un groupe : https://nom_du_groupe.forge.apps.education.fr/nom_du_projet/.

GitLab fournit automatiquement cette adresse lors de la publication : aucune URL n’est à saisir.

Un tutoriel de la Forge détaille la création du projet et le choix de son adresse : Obtenir un chemin d’accès personnalisé.

Licence et README

Associez une licence libre à votre dépôt et adaptez README.md pour décrire votre propre ressource, son public et sa licence.

• Choisir une licence
• Bien démarrer sur la Forge

2. Modifier la navigation

Le menu commun à toutes les pages est défini dans nav.txt, à la racine du dépôt. Chaque ligne est un lien Markdown :

[Accueil](/)
[Mode d'emploi](/mode_emploi/)
[Crédits](/credits/)

Pour une page placée dans ressources/index.md, ajoutez :

[Ressources](/ressources/)

Les liens internes doivent commencer par /. Lors de la publication, ils sont automatiquement préfixés avec l’adresse exacte du site, sous-chemin du projet compris.

3. Ajouter une page

La méthode recommandée tient en trois étapes :

1. Créez un dossier à la racine, par exemple ressources/.
2. Ajoutez le fichier ressources/index.md.
3. Ajoutez son lien dans nav.txt.

Vous pouvez aussi créer un fichier Markdown simple, comme contact.md ; il sera converti en contact.html.

4. Écrire en Markdown

Rédigez vos contenus dans les fichiers .md avec la syntaxe Markdown habituelle : titres, paragraphes, listes, liens, images et blocs de code.

Tutoriel pour apprendre rapidement Markdown

Image avec une légende

Une image Markdown avec un texte alternatif non vide est transformée par Pandoc en figure :

![Logo du modèle](/img/logo.svg)

Le chemin sera lui aussi adapté automatiquement à l’adresse de publication.

Équations mathématiques

Vous pouvez écrire une formule LaTeX en ligne avec $E=mc^2$, ce qui donne \(E=mc^2\).

Pour une équation centrée, utilisez deux signes $ :

$$
E=mc^2
$$

5. Publication automatique

À chaque envoi sur la branche par défaut, la Forge génère les pages et publie le site automatiquement. Le même fonctionnement convient à un site racine, à un projet dans un groupe et à un projet dans un sous-groupe.

La partie technique est fournie par un pipeline commun maintenu séparément. Vous n’avez rien à installer ni à configurer dans votre projet.

Dépannage rapide

• Le lien du menu ne fonctionne pas : vérifiez qu’il commence par / et qu’un dossier cible contient bien son index.md.
• La page ne s’affiche pas : vérifiez le nom et l’emplacement du fichier Markdown.
• Le style ou le logo manque : consultez l’artefact du job Pages et vérifiez que style.css, favicon.ico et img/ sont présents dans public/.
• Le menu n’apparaît pas : vérifiez que nav.txt est présent et que la CI est terminée sans erreur.