Configuration

Le fichier config.yml doit être édité afin d’y référencer les différentes parties du document, saisir son titre, votre année, nom et diplôme.

Le thème

Les logiques d’affichage screen et print sont dépendantes du thème sélectionné dans le fichier config.yml:

theme: esadpyrenees

Le contenu

Le contenu du document est organisé sous la forme d’une série de documents au format markdown, correspondant à chacune des sections du document. Ces différentes sections sont déclarées dans le fichier config.yml :

parts:

  - title: Introduction
    # ↑ le titre de la section, tel qu’il apparaitra dans le sommaire
    file: content/text/1.intro.md
    # ↑ le fichier markdown du contenu (texte de la section)
    template: default   
    # ↑ le gabarit de mise en page à utiliser 

  - title: Titre 2
    file: content/text/2.deuxieme-partie.md
    template: default

  …

Le title sert à déterminer l’id de la section et à générer le sommaire.

Les fichiers markdown (à l’extension .md) peuvent être numérotés pour une meilleure organisation ; ils sont placés par convention dans le dossier “content/text” mais peuvent être stockés ailleurs.

À chaque partie peut être affecté un gabarit (template), qui permet de définir sa mise en forme (à la fois écran et print).