Gollum Comme Wiki Personnel

Sun, 12 Dec, 2012 (500 Words)

Il y a environ 4 mois j’ai eu un accident de vélo ; un traumatisme crânien, des brulures sur la face, quelques points de sutures, un doigt cassé et une hernie discale m’ont cloué (et me clou encore) plus que d’habitude sur ma chaise de bureau. Le bon côté des choses, c’est que cela m’a permit de me poser et de réfléchir une bonne façon d’être efficace et organiser, au travail et à la maison :-).

Une des principales action que j’ai pris est d’utiliser un wiki local et synchronisé sur tout mes PCs. Le format wiki est assez adapté à une prise de note et à la création de contenu plus complet (comme des articles ou de la documentation pour des projets en cours). Les conditions étaient les suivantes :

  • Facilité de mise en place.
  • Pas de base de données.
  • Merging facile (git rules my world).
  • Markdown comme syntaxe, car utilisé à peu près partout (blogs, articles, READMEs, documentations).
  • Éditable à partir d’une interface web ou de mon éditeur favoris.

L’outil qui remplit presque toutes ces conditions s’appelle gollum. C’est un moteur wiki, écris en ruby, qui se base sur un repository git. Il est développer par l’équipe de Github et c’est celui qui est utilisé par les pages wiki là-bas. Il permet d’utiliser à peu près n’importe quel syntaxe (dont github-markdown qui est assez proche de celle de pandoc). Par ailleurs, comme il se base sur git, les points “pas de base de données”, “merging facile” et “éditable également à partir de mon éditeur favoris” sont toutes remplies.

Avec Gollum vous avez un wiki markdown décentralisé, éditable via une interface web ou via votre éditeur favoris.

Mise en place

La mise en place est relativement simple ; après tout dépend du besoin que vous avez. L’installation se fait par RubyGem ou en clonant le repository.

# Installation de gollum et du format markdown de github $ gem install gollum gitub-markdown

Si vous n’utilisez pas rbenv ou rvm il est probable qu’il faille lancer la commande en root ou utiliser sudo.

Ensuite, il suffit de lancer Gollum dans un dossier qui est un repository git ; le tour est joué

# J'ulitise ~/desktop/wiki pour mon wiki $ cd ~/desktop/wiki && gollum

L’idée finale est d’automatiser deux choses :

  1. Le démarrage de gollum
  2. La synchronisation du repository avec les différents autres remotes

Suivant le système d’exploitation et/ou la distribution utilisées, il y a énormément de possibilité d’effectuer cette automatisation. Dans mon cas, j’ai une Debian assez light, avec surtout plein de scripts. Je démarre donc Gollum au démarrage de ma session grâce à une script qui est lancé dans la foulée du gestionnaire de fenêtre. La synchronisation se fait grâce à une tâche planifiée cron qui est “distribué” sur chacune de mes machines.

C’est tout pour le moment ;-).