Création d’un site GitHub Pages avec Jekyll

Prérequis

Avant de pouvoir utiliser Jekyll pour créer un site GitHub Pages, vous devez installer Jekyll et Git. Pour plus d’informations, consultez Installation dans la documentation de Jekyll et « Configurer Git ».

Nous vous recommandons d’utiliser Bundler pour installer et exécuter Jekyll. Bundler gère les dépendances de gemme Ruby, réduit les erreurs de build Jekyll et empêche les bogues liés à l’environnement. Pour installer Bundler :

Installer Ruby Pour plus d’informations, consultez « Installation de Ruby » dans la documentation de Ruby.
Installez Bundler. Pour plus d’informations, consultez « Bundler ».

Conseil : Si vous voyez une erreur Ruby lorsque vous essayez d’installer Jekyll à l’aide de Bundler, vous devrez peut-être utiliser un gestionnaire de package, tel que RVM ou Homebrew, pour gérer votre installation Ruby. Pour plus d’informations, consultez « Résolution des problèmes » dans la documentation de Jekyll.

Création d’un dépôt pour votre site

Vous pouvez créer un dépôt ou choisir un dépôt existant pour votre site.

Si vous souhaitez créer un site GitHub Pages pour un dépôt où les fichiers du dépôt ne sont tous pas liés au site, vous pouvez configurer une source de publication pour votre site. Par exemple, vous pouvez avoir une branche et un dossier dédiés pour conserver les fichiers sources de votre site.

Si vous souhaitez créer un site dans un dépôt existant, passez à la section « Création de votre site ».

En haut à droite d’une page, utilisez le menu déroulant et sélectionnez Nouveau dépôt.

1. Utilisez le menu déroulant Propriétaire pour sélectionner le compte auquel vous voulez donner la propriété du dépôt. 1. Tapez un nom pour votre référentiel et une description facultative. Si vous créez un utilisateur ou un site d’organisation, votre référentiel doit être nommé <user>.github.io ou <organization>.github.io. Si votre nom d’utilisateur ou d’organisation contient des lettres majuscules, vous devez mettre les lettres en minuscules. Pour plus d’informations, consultez « À propos de GitHub Pages ». 1. Choisissez une visibilité de dépôt. Pour plus d’informations, consultez « À propos des dépôts ».

Création de votre site

Pour pouvoir créer votre site, vous devez avoir un dépôt pour votre site sur GitHub AE. Si vous ne créez pas votre site dans un dépôt existant, consultez « Création d’un dépôt pour votre site ».

Avertissement : les sites GitHub Pages sont visibles par tous les membres de l’entreprise, même si le dépôt du site est privé. Si vous avez des données sensibles dans le dépôt de votre site, vous pouvez les supprimer avant publication. Pour plus d’informations, consultez « À propos des dépôts ».

Ouvrez TerminalTerminalGit Bash.
Si vous n’avez pas encore de copie locale de votre dépôt, accédez à l’emplacement où vous souhaitez stocker les fichiers sources de votre site, en remplaçant PARENT-FOLDER par le dossier qui contiendra le dossier pour votre dépôt.
```
$ cd PARENT-FOLDER
```

Si vous ne l’avez pas déjà fait, initialisez un dépôt Git local, en remplaçant REPOSITORY-NAME par le nom de votre dépôt.

$ git init REPOSITORY-NAME
> Initialized empty Git repository in /Users/octocat/my-site/.git/
# Creates a new folder on your computer, initialized as a Git repository

Changez de répertoire dans le dépôt.

$ cd REPOSITORY-NAME
# Changes the working directory

Déterminez la source de publication que vous souhaitez utiliser. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ». 1. Accédez à la source de publication pour votre site. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ». Par exemple, si vous avez choisi de publier votre site à partir du dossier docs de la branche par défaut, créez et changez de répertoire dans le dossier docs.
```
$ mkdir docs
# Creates a new folder called docs
$ cd docs
```
Si vous avez choisi de publier votre site à partir de la branche gh-pages, créez et extrayez la branche gh-pages.
```
$ git checkout --orphan gh-pages
# Creates a new branch, with no history or contents, called gh-pages, and switches to the gh-pages branch
$ git rm -rf .
# Removes the contents from your default branch from the working directory
```

Pour créer un site Jekyll, utilisez la commande jekyll new :

$ jekyll new --skip-bundle .
# Creates a Jekyll site in the current directory

Ouvrez le Gemfile créé par Jekyll.
Ajoutez « # » au début de la ligne qui commence par gem "jekyll" pour commenter cette ligne.
Ajoutez la gemme github-pages en modifiant la ligne commençant par # gem "github-pages". Remplacez cette ligne par :
```
gem "github-pages", "~> GITHUB-PAGES-VERSION", group: :jekyll_plugins
```
Remplacez GITHUB-PAGES-VERSION par la dernière version prise en charge de la gemme github-pages. Vous trouverez cette version ici : « Versions de dépendances ».

La bonne version de Jekyll est installée en tant que dépendance de la gemme github-pages.
Enregistrez et fermez le Gemfile.
À partir de la ligne de commande, exécutez bundle install.

Si vous le souhaitez, apportez toutes les modifications nécessaires au fichier _config.yml. C’est nécessaire pour les chemins relatifs lorsque le dépôt est hébergé dans un sous-répertoire. Pour plus d’informations, consultez « Fractionnement d’un sous-dossier en un nouveau dépôt ».

domain: my-site.github.io       # if you want to force HTTPS, specify the domain without the http at the start, e.g. example.com
url: https://my-site.github.io  # the base hostname and protocol for your site, e.g. http://example.com
baseurl: /REPOSITORY-NAME/      # place folder name if the site is served in a subfolder

Si vous le souhaitez, testez votre site localement. Pour plus d’informations, consultez « Test de votre site GitHub Pages localement avec Jekyll ».

Ajoutez et commitez votre travail.

git add .
git commit -m 'Initial GitHub pages site with Jekyll'

Ajoutez votre référentiel dans GitHub AE en tant que référentiel distant, en remplaçant HOSTNAME par le nom d’hôte de votre entreprise, USER par le compte propriétaire du référentiel, et REPOSITORY par le nom du référentiel.
```
$ git remote add origin https://HOSTNAME/USER/REPOSITORY.git
```
Envoyez le dépôt à GitHub AE, en remplaçant BRANCH par le nom de la branche sur laquelle vous travaillez.
```
$ git push -u origin BRANCH
```
Configurez votre source de publication. Pour plus d’informations, consultez « Configuration d’une source de publication pour votre site GitHub Pages ». 1. Dans GitHub AE, accédez au dépôt de votre site. 1. Sous le nom de votre dépôt, cliquez sur Paramètres. Si vous ne voyez pas l’onglet « Paramètres », sélectionnez le menu déroulant , puis cliquez sur Paramètres.
Dans la section « Code et automatisation » de la barre latérale, cliquez sur Pages.
Pour voir votre site publié, sous « GitHub Pages », cliquez sur Visiter le site.

Remarque : La publication des changements de votre site peut prendre jusqu’à 10 minutes après les avoir poussés vers GitHub AE. Si vous ne voyez pas vos modifications du site GitHub Pages reflétées dans votre navigateur après une heure, consultez « À propos des erreurs de build Jekyll pour les sites GitHub Pages ».

Remarque : Si votre site n’a pas été publié automatiquement, assurez-vous qu’une personne avec des autorisations d’administrateur et une adresse e-mail vérifiée a effectué une poussée vers la source de publication.

Étapes suivantes

Pour ajouter une nouvelle page ou publier sur votre site, consultez « Ajout d’un thème à votre site GitHub Pages avec Jekyll ».

Vous pouvez ajouter un thème Jekyll à votre site GitHub Pages pour personnaliser son apparence. Pour plus d’informations, consultez « Ajout d’un thème à votre site GitHub Pages avec Jekyll ».