-
Notifications
You must be signed in to change notification settings - Fork 0
/
howto.qmd
76 lines (42 loc) · 3.42 KB
/
howto.qmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
---
title: "How-To Github"
---
## Publication d'un document Quarto sur Github
### Introduction
Ce document est basée sur [cette vidéo Youtube en anglais](https://youtu.be/uimdXPZc40I)
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 `demosite`alors 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 @fig-config_projet_quarto
![Configuration du projet de site Web Quarto](images/0_create-quarto-website.PNG){#fig-config_projet_quarto}
::: {.callout-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](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 `username`par votre nom d'utilisateur Github et sélectionner l'option **Public** pour que le site soit visible par tous (cf. @fig-website)
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. @fig-site_projet).
::: {layout-ncol=2}
![Configuration pour site web personnel](images/1_create-personal-website.PNG){#fig-website}
![Configuration pour un site projet](images/2_create-project-site.PNG){#fig-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 @fig-configuration_pages)
![Configuration de déploiement du site](images/3_repository-settings-pages.PNG){#fig-configuration_pages}
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.