Suite à la migration de notre blog vers un jekyll hébergé chez github, je vous propose quelques explications sur le sujet. Dans cet article, nous verrons :

  1. comment utiliser Jekyll
  2. comment migrer de Wordpress vers Jekyll
  3. comment héberger son blog (ou tout site statique) chez github

On y va ?

Utilisation de Jekyll

Jekyll est un moteur de génération blog statique créé par (un ancien de chez) github. Il est écrit en ruby, donc cet article fait l’hypothèse que vous avez déjà ruby et ruby-gem d’installés sur votre poste de travail.

Pour installer jekyll, une commande gem suffit. Ainsi, pour installer jekyll et créer le blog “from scratch” :

gem install jekyll
jekyll new barreverte.github.io
cd barreverte.github.io

Ensuite, la commande jekyll serve vous lance le site en local sur le port 4000 : puis vous ouvrez le lien 0.0.0.0:4000/ pour voir votre blog en local.

L’utilisation est simple : après avoir fait le design de votre site (en éditant le fichier index.html et tout ce qui se trouve dans le dossier _layout), la création d’un fichier dans _posts publie un nouvel article.

Il vous faudra respecter plusieurs conventions :

  • le nommage : le fichier doit comporter la date de publication dans son titre, par exemple pour un article publié le 24 décembre 2003, le fichier devra se nommer 2003-12-24-mon-article.md
  • le fichier devra commencer par le front matter. Il s’agit de meta-informations décrivant l’article et doit comporter au minimun les champs layout et title. Pour un article de blog, utilisez le layout post (qui sera mis en forme selon les indications données dans le fichier _layouts/post.html) :
---
layout: post
title: Titre de votre article
--

Ici, le contenu de votre article, dans votre format préféré à choisir parmi Markdown ou Texile
(personnellement, j'ai choisi markdown)

Si vous voulez travailler sur un brouillon, vous créez votre fichier dans le dossiers _drafts : ces fichiers ne sont pas publiés. Vous pouvez en revanche les lire avant publication en local en lançant jekyll avec l’option drafts :

jekyll serve --drafts --watch

L’option watch ordonne à jekyll de surveiller le répertoire du site et de le regénérer à chaque changement de contenu.

Ainsi, la publication d’un article se résume à déplacer un fichier de _drafts vers _posts tout en respectant les normes de nommage.

Migrer un Wordpress vers Jekyll

Récupérer les anciens articles

Dans notre cas, nous avions déjà un blog depuis 2010. Nous voulions donc migrer tous les articles existants en conservant le maximum de contenu et sans changer les URL des articles pour des raisons évidentes de compatibilité des bookmarks ou références à nos articles.

J’avais déjà tenté une migration 1 an auparavant, mais j’étais ressorti de cette expérience avec un goût de “pas fini” dans la bouche : gros soucis d’encodage de tous les articles, imports partiels, processus très compliqué.

Mais les choses avancent ! Depuis, le processus de migration depuis un Wordpress auto-hébergé s’est grandement simplifié. Tout est documenté dans le site Jekyll Import. Des tas de types de blog sources sont possibles (Blogger, Joomla, Typo…), mais ici nous allons nous intéresser à la migration depuis un Wordpress autohébergé : http://import.jekyllrb.com/docs/wordpress/

Pour la migration depuis un Wordpress auto-hébergé, nous avons la possibilité de nous connecter au MySQL et d’en extraire tous les articles publiés. Notez-cependant que les brouillons en cours ne seront pas importés, il faudra le faire à la main (ou proposer un patch).

Comme jekyll, jekyll-migration est écrit en ruby. Il y a donc quelques gems à installer sur votre poste, en particulier la gem MySQL :

gem install jekyll-import
gem install mysql
gem install mysql2
gem install sequel
gem install unidecode

Et c’est là que les choses se compliquent ! Je ne sais pas si vous êtes tous dans mon cas, mais j’ai toujours rencontré les pires difficultés pour installer la gem mysql. Ici, il y a même la gem mysql2… En tout cas, il faut que vous ayez de quoi parler MySQL depuis votre poste. Sous Ubuntu, il faut installer le paquet libmysqlclient-dev avant d’installer la gem mysql/mysql2.

Ensuite, pensez à ouvrir le port MySQL vers votre machine. Avec iptable, cela s’écrit ainsi :

-A INPUT -p tcp -m tcp -s VOTRE_IP --dport VOTRE_PORT_MYSQL -j ACCEPT

Je vous invite à tester la connexion vers le MySQL de votre blog depuis votre machine en utilisant le client mysql en local.

Ensuite, il faut lancer une commande magique. La commande est magique, car la documentation n’est pas à jour, certaines options sont devenues obligatoires, d’autres ont carrément disparu. Je suis arrivé (de mémoire) à la commande suivante :

ruby -rubygems -e 'require "jekyll-import";
    JekyllImport::Importers::WordPress.run({
      "dbname"   => "blog",
      "user"     => "votreUser",
      "password" => "sonMotDePasseSecret",
      "host"     => "votreServeur.com",
      "table_prefix"   => "wp_",
      "clean_entities" => true,
      "comments"       => true,
      "categories"     => true,
      "tags"           => true,
      "more_excerpt"   => true
    })'

Tous vos articles sont présents ! Ils sont au format HTML ; vous attendrez d’écrire un nouvel article pour utiliser un langage de Markup plus simple, comme Markdown par exemple.

Réglages fins

Il vous reste à résoudre le problème des URL. Par défaut, jekyll met la date de l’article dans l’URL, contrairement à ce que faisait Wordpress. C’est un point qui m’angoissait particulièrement, car j’avais peur de ne pouvoir y parvenir, et des URL incompatibles avec les anciennes était synonyme de “no go” comme on dit : tous les liens pointant vers notre sites cassés, tout l(‘excellent) référencement de nos articles chez les moteurs de recherche cassé… bref ! une catastrophe.

Mais je me suis noyé dans un verre d’eau.

En fait, c’est tellement bête que j’ai failli en pleurer : à la racine du blog se trouve un fichier dont l’importance est capitale : _config.yml. C’est le fichier qui regroupe toute la configuration du blog. Il faut changer la ligne :

permalink: /:year/:month/:title/

en

permalink: /:title/

Et tout est l’avenant ! Configurer un compte Google Analytics ? La variable gaaccount est là pour ça ! Mettre en place des commentaires avec disqus ? Il y a aussi une variable pour cela (nommée… disqus).

Pour les commentaires disqus, il faut ajouter un comments: true dans le front matter.

On peut aller beaucoup plus loin, en fouillant un peu dans le code source si vous êtes développeur. À titre d’exemple, c’est assez immédiat de faire apparaître des tags et des catégories en fin d’article.

Héberger son blog chez Github

Enfin, héberger votre blog chez github est élémentaire. Par héberger, j’entends “c’est github qui sert le contenu de votre blog”.

Pour cela, vous avez 2 options :

  • utiliser une URL github, du type http://monblog.github.io
  • utiliser une URL que vous possédez, par exemple http://www.barreverte.fr (au hasard)

Voyons cela point par point :

Utiliser une URL en github.io

Il faut respecter quelques conventions et cela marche tout seul (chapeau bas aux équipes de github) :

  • votre repository doit s’appeller monuser.github.io
  • le site doit être dans la branche master
  • c’est tout !

À chaque git push sur votre branche master, github génère le site statique et le rend disponible partout.

Notez que github permet d’héberger également un site statique pour votre projet open source. Dans ce cas, le code de votre site doit se situer dans une branche nommée gh-pages. Ainsi, pour un utilisateur nommé monuser et un projet nommé monprojet, le site sera disponible à l’adresse http(s)://monuser.github.io/monprojet. Voir par exemple http://jpcaruana.github.io/presentation_buildr/.

Utiliser une URL personnelle

Pour cette option, c’est un petit peu plus compliqué, mais pas tellement :

  • toutes les règles précédement énnoncées s’appliquent :
    • votre repository doit s’appeller monuser.github.io
    • le site doit être dans la branche master
  • il faut créer à la racine de votre projet un fichier nommé CNAME qui ne contient que l’URL de votre site, sans wildcard
  • il faut ajouter dans votre DNS un enregistrement de type CNAME qui pointe vers monuser.github.io
  • attendre que le DNS se propage.

Dans notre cas, le fichier CNAME est accessible à tous pour vous en inspirer et le DNS est configuré ainsi (le point final est très important : il représente le serveur DNS racine, et cela ne fonctionnera pas sans) :

www 10800 IN CNAME barreverte.github.io.

Une fois tout ceci en place, votre site ne sera plus accessible sur l’URL monuser.github.io : par exemple, http://barreverte.github.io/ redirige vers http://www.barreverte.fr/

Conclusion

Ouf ! Nous sommes arrivés au bout !

Ce n’était finalement pas très difficile, même si j’ai trouvé la documentation souvent éparpillée et parfois imprécise ; c’est pourquoi j’ai voulu rédiger cette page pour permettre à d’autres de gagner du temps si ils désirent ouvrir un blog gratuitement. J’espère que cela pourra rendre service.

N’hésitez pas à me suggérer des corrections, améliorations, que ce soit en commentaires en fin d’article ou en proposant une pull request.

Références