Aller au contenu

Structure du site et Organisation du menu

Attention

Dans cette rubrique nous allons voir comment utiliser un fichier .pages.

👉 Pour éviter tout problème d'échec de construction du site, il est très fortement recommandé de ne créer ces fichiers .pages qu'après avoir réalisé les commit1 correspondant aux fichiers .md ou répertoires qui y sont notés.

I. Organisation automatique du menu⚓︎

1. Présentation automatique

Le menu est présenté de façon automatique dans l'ordre alphabétique des répertoires du dépôt.

Par exemple, l'arborescence suivante :

arborescence
docs/
├── 01_chapitre_1
├── 02_chapitre_2
├── 03_chapitre_3
├── 04_chapitre_4

produira sur le site le menu suivant :

01_chapitre_1
02_chapitre_2
03_chapitre_3
04_chapitre_4

2. Cas d'un seul fichier .md dans un répertoire

Si un répertoire ne contient qu'un seul fichier en .md, le nom du répertoire sera remplacé par le title du fichier en .md.

Par exemple si 01_chapitre_1 ne contient que le fichier .md suivant:

fichier chapitre_1.md
---
author: Mon Nom
title: Mon premier chapitre
---

Suite ...
Le menu qui apparaîtra sera le suivant :

Mon premier chapitre
02_chapitre_2
03_chapitre_3
04_chapitre_4

II. Modifier l'ordre des pages⚓︎

1. Par renommage des répertoires

Une solution consiste à nommer les répertoires par ordre alphabétique du menu désiré.
Cette solution peut se révéler fastidieuse lorsque l'on doit intercaler un chapitre, ce qui peut nécessiter beaucoup de renommages.

En utilisant un fichier .pages

On peut ajouter un fichier .pages dans dans le répertoire docs

arborescence
docs/
├── 01_chapitre_1
├── 02_chapitre_2
├── 03_chapitre_3
├── 04_chapitre_4
├── .pages
Code à copier pour le fichier `.pages`
nav:
    - index.md
    - 03_chapitre_3
    - 02_chapitre_2
    - 04_chapitre_4
    - 01_chapitre_1

Accueil
03_chapitre_3
02_chapitre_2
04_chapitre_4
01_chapitre_1

III. Organiser un chapitre et renommer un chapitre⚓︎

1. Organisation du site modèle

orga modèle

Rendu :

rendu

2. Renommage d'un chapitre

chap 2

👉 Ce chapitre étant composé de plusieurs fichiers .md, nous avons choisi de remplacer le titre par défaut

  • " 02_chapitre_2 "
  • par " Chapitre 2 - Python "
Code à copier pour le fichier `.pages`
title: Chapitre 2 - Python

Les titres qui apparaîssent lorsque l'on développe " Chapitre 2 - Python " sont ceux indiqués en title des fichiers .md

rendu_chap_2.png

👉 Changer l'ordre

Nous pouvons également facilement changer l'ordre des pages de ce chapitre en complétant le fichier .pages

Code à copier pour le fichier `.pages`
title: Chapitre 2 - Python
nav:
    - 1_intro_python.md
    - 3_listes.md
    - 2_fonctions.md

IV. Cacher un répertoire⚓︎

Rendre un dossier ou un fichier invisible dans la navigation

😊 C'est très simple : il suffit de ne pas écrire le nom du dossier ou du fichier concerné dans le fichier .pages correspondant.

Rendre un dossier invisible dans la navigation : autre technique

Pour qu'un répertore n'apparaisse pas dans le menu, vous pouvez y inclure le fichier .pages suivant :

Code à copier dans le fichier `.pages`
hide: true

Cela peut être utile pour cacher un répertoire inclus dans un répertoire qui lui doît être visible dans la navigation.

V. Bilan sur les fichiers .pages⚓︎

Les fichiers .pages

Nous pouvons mettre des fichiers .pages dans docs ou dans différents répertoires.

  • Il donne le titre s'il commence par title
  • Il donne l'ordre des pages. Cela permet d'organiser des pages .md, et également des répertoires comme présenté ici :
  • Un dossier ou fichier .md qui n'est pas écrit dans ce fichier n'apparaîtra pas dans la navigation de votre site.
Code exemple à copier pour un fichier `.pages`
title: Mon titre
nav:
    - page1.md
    - page2.md
    - repertoire_1
    - page3.md
    - repertoire_2

Documentation sur les fichiers .pages

  1. Voir le tutoriel : Kit de survie GitLab ↩