Skip to content

Commit

Permalink
Quarto Website page
Browse files Browse the repository at this point in the history
  • Loading branch information
a-lambda committed Jan 6, 2024
1 parent 4ffbfa3 commit c7db160
Show file tree
Hide file tree
Showing 19 changed files with 1,405 additions and 6 deletions.
4 changes: 3 additions & 1 deletion .github/workflows/rne.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -6,4 +6,6 @@ jobs:
runs-on: ubuntu-latest
steps:
- name: Test Output
run: echo "Here is a test"
run: echo "Here is a test"
connect-remote:

2 changes: 2 additions & 0 deletions _quarto.yml
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@ website:
- href: index.qmd
text: Home
- about.qmd
- href: quarto_website.qmd
text: Quarto Website

format:
html:
Expand Down
4 changes: 4 additions & 0 deletions docs/about.html
Original file line number Diff line number Diff line change
Expand Up @@ -91,6 +91,10 @@
<a class="nav-link active" href="./about.html" rel="" target="" aria-current="page">
<span class="menu-text">About</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./quarto_website.html" rel="" target="">
<span class="menu-text">Quarto Website</span></a>
</li>
</ul>
<div class="quarto-navbar-tools ms-auto">
<a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
Expand Down
598 changes: 598 additions & 0 deletions docs/howto.html

Large diffs are not rendered by default.

Binary file added docs/images/0_create-quarto-website.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/1_create-personal-website.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/2_create-project-site.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added docs/images/3_repository-settings-pages.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
8 changes: 6 additions & 2 deletions docs/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -113,6 +113,10 @@
<a class="nav-link" href="./about.html" rel="" target="">
<span class="menu-text">About</span></a>
</li>
<li class="nav-item">
<a class="nav-link" href="./quarto_website.html" rel="" target="">
<span class="menu-text">Quarto Website</span></a>
</li>
</ul>
<div class="quarto-navbar-tools ms-auto">
<a href="" class="quarto-color-scheme-toggle quarto-navigation-tool px-1" onclick="window.quartoToggleColorScheme(); return false;" title="Toggle dark mode"><i class="bi"></i></a>
Expand Down Expand Up @@ -154,8 +158,8 @@ <h1 class="title">The chance</h1>
<span><span class="fu"><a href="https://rdrr.io/r/base/table.html">table</a></span><span class="op">(</span><span class="va">roll</span><span class="op">)</span></span></code><button title="Copy to Clipboard" class="code-copy-button"><i class="bi"></i></button></pre></div>
</details><div class="cell-output cell-output-stdout">
<pre><code>roll
1 2 3 4 5 6
8 6 4 7 8 9 </code></pre>
1 2 3 4 5 6
6 9 7 10 3 7 </code></pre>
</div>
</div>
<p>How many trials before getting an identical world ?</p>
Expand Down
601 changes: 601 additions & 0 deletions docs/quarto_website.html

Large diffs are not rendered by default.

30 changes: 29 additions & 1 deletion docs/search.json
Original file line number Diff line number Diff line change
Expand Up @@ -4,13 +4,41 @@
"href": "index.html",
"title": "The chance",
"section": "",
"text": "Email\n \n \n \n Github\n \n\n \n \nIs your world choosing the same numbers as mine ?\n\nCoderoll &lt;- \n sample.int(n = 6, size = 42, replace = TRUE)\n\ntable(roll)\n\nroll\n1 2 3 4 5 6 \n8 6 4 7 8 9 \n\n\nHow many trials before getting an identical world ?\nAnd which are we consider as the reference ?"
"text": "Email\n \n \n \n Github\n \n\n \n \nIs your world choosing the same numbers as mine ?\n\nCoderoll &lt;- \n sample.int(n = 6, size = 42, replace = TRUE)\n\ntable(roll)\n\nroll\n 1 2 3 4 5 6 \n 6 9 7 10 3 7 \n\n\nHow many trials before getting an identical world ?\nAnd which are we consider as the reference ?"
},
{
"objectID": "about.html",
"href": "about.html",
"title": "About",
"section": "",
"text": "I’m interested in spatial statistics\n\nr-spatial-website\nsf package\n\nand in ggplot2 extensions\n\n\n\n\n\n\nNote\n\n\n\n\n\nHey that’s was just a note joke :)"
},
{
"objectID": "howto.html",
"href": "howto.html",
"title": "How-To Github",
"section": "",
"text": "Ce document est basée sur cette vidéo Youtube en anglais\nLes 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.\nL’hébergement s’effectue dans votre dépôt (ou repository), ce qui vous permet de :\n\nconserver un dépôt git pour votre site Web\npousser (push) des changements dans votre site Web vers Github\nvisualiser presque instantanément les changements de votre site dans Github\n\nSi 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/.\nSi vous créer un site Web personnel, il est préférable de l’héberger à l’adresse https://username.github.io.\n\n\n\n\n\nDans R Studio,\n\n\nDepuis le menu File, click -&gt; New Project\nSélectionner New Directory -&gt; Quarto website\nChoisir un nom de répertoire\n\n\ns’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\ns’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/.\n\nUn exemple est donné ici Figure 1\n\n\n\nFigure 1: Configuration du projet de site Web Quarto\n\n\n\n\n\n\n\n\nNote\n\n\n\nNe 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\n\n\n\n\n\n\nse loguer dans Github\nDepuis la page principale, créer un dépôt Github.\n\nPour 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)\nPour 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).\n\n\n\n\n\n\n\n\nFigure 2: Configuration pour site web personnel\n\n\n\n\n\n\n\nFigure 3: Configuration pour un site projet\n\n\n\n\n\n\n\n\n\nsélectionner l’onglet settings relatif au projet et cliquer sur Pages\nDans 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)\n\n\n\n\nFigure 4: Configuration de déploiement du site\n\n\nLa 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."
},
{
"objectID": "howto.html#publication-dun-document-quarto-sur-github",
"href": "howto.html#publication-dun-document-quarto-sur-github",
"title": "How-To Github",
"section": "",
"text": "Ce document est basée sur cette vidéo Youtube en anglais\nLes 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.\nL’hébergement s’effectue dans votre dépôt (ou repository), ce qui vous permet de :\n\nconserver un dépôt git pour votre site Web\npousser (push) des changements dans votre site Web vers Github\nvisualiser presque instantanément les changements de votre site dans Github\n\nSi 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/.\nSi vous créer un site Web personnel, il est préférable de l’héberger à l’adresse https://username.github.io.\n\n\n\n\n\nDans R Studio,\n\n\nDepuis le menu File, click -&gt; New Project\nSélectionner New Directory -&gt; Quarto website\nChoisir un nom de répertoire\n\n\ns’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\ns’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/.\n\nUn exemple est donné ici Figure 1\n\n\n\nFigure 1: Configuration du projet de site Web Quarto\n\n\n\n\n\n\n\n\nNote\n\n\n\nNe 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\n\n\n\n\n\n\nse loguer dans Github\nDepuis la page principale, créer un dépôt Github.\n\nPour 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)\nPour 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).\n\n\n\n\n\n\n\n\nFigure 2: Configuration pour site web personnel\n\n\n\n\n\n\n\nFigure 3: Configuration pour un site projet\n\n\n\n\n\n\n\n\n\nsélectionner l’onglet settings relatif au projet et cliquer sur Pages\nDans 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)\n\n\n\n\nFigure 4: Configuration de déploiement du site\n\n\nLa 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."
},
{
"objectID": "quarto_website.html",
"href": "quarto_website.html",
"title": "Création d’un site Web Quarto sur Github",
"section": "",
"text": "Introduction\nCe document est basée sur cette série de vidéos Youtube en anglais produite par Joshua French\nLes 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.\nL’hébergement s’effectue dans votre dépôt (ou repository), ce qui vous permet de :\n\nconserver un dépôt git pour votre site Web\npousser (push) des changements dans votre site Web vers Github\nvisualiser presque instantanément les changements de votre site dans Github\n\nSi 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/.\nSi vous créer un site Web personnel, il est préférable de l’héberger à l’adresse https://username.github.io.\n\n\n\nCréation d’un site Web Quarto\n\nDans R Studio,\n\n\nDepuis le menu File, click -&gt; New Project\nSélectionner New Directory -&gt; Quarto website\nChoisir un nom de répertoire\n\n\ns’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\ns’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/.\n\nUn exemple est donné ici Figure 1\n\n\n\nFigure 1: Configuration du projet de site Web Quarto\n\n\n\n\n\n\n\n\nNote\n\n\n\nNe 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\n\n\n6 fichiers vont être automatiquement créés :\n\n_quarto.yaml, qui permet le paramétrage global du site Web\n.gitignore identifie les fichiers et répertoire à ignorer par git\nindex.qmd est le fichier associé à la page défaut du site Web\nabout.qmd est une page démo associée à la page principale\n&lt;nom du projet&gt;.Rproj est le fichier projet R associé au site Web\nstyles.css est le nom de la feuille de styles par défaut\n\n\n\nCréation du dépôt Github\n\nse loguer dans Github\nDepuis la page principale, créer un dépôt Github.\n\nPour 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)\nPour 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).\n\n\n\n\n\n\n\n\nFigure 2: Configuration pour site web personnel\n\n\n\n\n\n\n\nFigure 3: Configuration pour un site projet\n\n\n\n\n\n\n\nDéploiement du site web sur Github\n\nsélectionner l’onglet settings relatif au projet et cliquer sur Pages\nDans 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)\n\n\n\n\nFigure 4: Configuration de déploiement du site\n\n\nLa 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."
},
{
"objectID": "quarto_website.html#publication-dun-document-quarto-sur-github",
"href": "quarto_website.html#publication-dun-document-quarto-sur-github",
"title": "Quarto Website",
"section": "",
"text": "Ce document est basée sur cette vidéo Youtube en anglais\nLes 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.\nL’hébergement s’effectue dans votre dépôt (ou repository), ce qui vous permet de :\n\nconserver un dépôt git pour votre site Web\npousser (push) des changements dans votre site Web vers Github\nvisualiser presque instantanément les changements de votre site dans Github\n\nSi 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/.\nSi vous créer un site Web personnel, il est préférable de l’héberger à l’adresse https://username.github.io.\n\n\n\n\n\nDans R Studio,\n\n\nDepuis le menu File, click -&gt; New Project\nSélectionner New Directory -&gt; Quarto website\nChoisir un nom de répertoire\n\n\ns’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\ns’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/.\n\nUn exemple est donné ici Figure 1\n\n\n\nFigure 1: Configuration du projet de site Web Quarto\n\n\n\n\n\n\n\n\nNote\n\n\n\nNe 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\n\n\n\n\n\n\nse loguer dans Github\nDepuis la page principale, créer un dépôt Github.\n\nPour 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)\nPour 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).\n\n\n\n\n\n\n\n\nFigure 2: Configuration pour site web personnel\n\n\n\n\n\n\n\nFigure 3: Configuration pour un site projet\n\n\n\n\n\n\n\n\n\nsélectionner l’onglet settings relatif au projet et cliquer sur Pages\nDans 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)\n\n\n\n\nFigure 4: Configuration de déploiement du site\n\n\nLa 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."
}
]
2 changes: 1 addition & 1 deletion docs/site_libs/bootstrap/bootstrap-dark.min.css

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion docs/site_libs/bootstrap/bootstrap.min.css

Large diffs are not rendered by default.

76 changes: 76 additions & 0 deletions howto.qmd
Original file line number Diff line number Diff line change
@@ -0,0 +1,76 @@
---
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.

Binary file added images/0_create-quarto-website.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/1_create-personal-website.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/2_create-project-site.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/3_repository-settings-pages.PNG
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit c7db160

Please sign in to comment.