How-To Github

Publication d’un document Quarto sur Github

Introduction

Ce document est basée sur cette vidéo Youtube en anglais

Les pages Github (https://pages.github.com/) sont une fonctionnalité offerte par Github qui permet d’héberger votre site Web personnel ainsi que vos projets.

L’hébergement s’effectue dans votre dépôt (ou repository), ce qui vous permet de :

  • conserver un dépôt git pour votre site Web
  • pousser (push) des changements dans votre site Web vers Github
  • visualiser presque instantanément les changements de votre site dans Github

Si votre nom d’utilisateur Github est username et que votre site Web est contenu dans le dépôt demositealors le rendu de votre site Web sera disponible à l’adresse https://username.github.io/demosite/.

Si vous créer un site Web personnel, il est préférable de l’héberger à l’adresse https://username.github.io.

Création d’un site Web Quarto

  • Dans R Studio,

  1. Depuis le menu File, click -> New Project

  2. Sélectionner New Directory -> Quarto website

  3. Choisir un nom de répertoire

  • s’il s’agit du site web personnel hébergé sur Github il faudra choisir comme nom de répertoire username.github.io, username représentant votre nom d’utilisateur Github. Le résultat sera visible à l’adresse https://username.github.io

  • s’il s’agit d’un site relatif à un projet hébergé sur Github, il faudra choisir comme nom de répertoire name qui représentera le nom de votre projet. Le résultat sera visible à l’adresse https://username.github.io/name/.

Un exemple est donné ici Figure 1

Figure 1: Configuration du projet de site Web Quarto
Note

Ne pas oublier de cocher l’option Create a git repository pour la gestion des versions de votre site. Git aura été préalablement installé depuis https://git-scm.com/downloads

Création du dépôt Github

  • se loguer dans Github
  • Depuis la page principale, créer un dépôt Github.

    • Pour votre site web personnel, le dépôt devra s’appeler username.github.io. Il faudra bien sûr remplacer usernamepar votre nom d’utilisateur Github et sélectionner l’option Public pour que le site soit visible par tous (cf. Figure 2)

      Pour héberger un projet, le dépôt, si vous décider de l’appeler projet, apparaîtra à l’adresse https://username.github.io/projet (cf. Figure 3).

Figure 2: Configuration pour site web personnel
Figure 3: Configuration pour un site projet

Déploiement du site web sur Github

  • sélectionner l’onglet settings relatif au projet et cliquer sur Pages

  • Dans la section Build and deployment sélectionner la branche main et le répertoire /docs dans lequel figurent l’ensemble des fichiers constituant le site web (cf Figure 4)

Figure 4: Configuration de déploiement du site

La ligne “Your site live at https://a-lambda.github.io” permet de vérifier que le rendu du site s’est correctement effectué. Un clic sur le bouton Visit site permet d’apprécier le résultat.