élaboration de documents à l’aide de markdown et pandoc à partir des pages d’un wiki Github

quelques précisions sur la syntaxe markdown

Pour des explications détaillées sur markdown en français, on se référera au site suivant :

http://enacit1.epfl.ch/markdown-pandoc/

page de garde

Le caractère pour-cent % sert à formatter la page de garde

On peut utiliser jusqu’à 3 lignes commencant par des caractères %, par exemple pour indiquer le titre du document, le nom du(des) auteur(s) ou la date de révision du document

Si l’une ou l’autre de ces informations doit être omise, laissez le caractère % suivi d’une ligne vide. Si le titre ou la définition des auteurs nécessitent plusieurs lignes de texte, on peut faire usage de lignes supplémentaires pour autant qu’elles débutent par un espace.

niveaux de titres

On peut utiliser plusieurs niveaux de titre en utilisant les caractères # (Titre de niveau 1), ## (Titre de niveau 2), etc, etc

clonage avec le logiciel github desktop

Ce logiciel permet de cloner l’intégralité du projet dans un répertoire de son ordinateur

Sous windows 10, ce répertoire est généralement C:\Users\nom_user\Documents\GitHub\smartgrid.wiki

On organise ensuite ce dossier comme on veut et on utilise github desktop pour les synchronisations.

Avant de commencer à travailler sur son disque, on synchronise pour avoir la dernière version. Lorsqu’on a fini, on envoie les modifs vers le master et on synchronise

Si on est derrière un proxy, il faut le déclarer pour que github desktop puisse cloner correctement

Pour celà, on ouvre un git bash et on lance la commande suivante, en remplaçant LOGIN, PASSWORD et YOUR.PROXY.SERVER par les paramètres convenant à son réseau :

~~~~~~~ { .bash } git config –global http.proxy http://LOGIN:PASSWORD@YOUR.PROXY.SERVER:8080

Pour remettre la config par défault :

~~~~~~~ { .bash }
git config --global --unset core.gitproxy
ou 
git config --global --unset http.proxy

Pour installer git bash :

https://git-scm.com/download/win

Cette synchronisation ne sert que pour l’injection des figures (cf point suivant) et pour produire les pdf. La gestion de contenu se fait en ligne.

gestion de figures

Pour injecter des figures au sein du wiki, il est nécessaire d’installer le logiciel github desktop. On peut insérer des images depuis une URL quelconque mais l’interpréteur pandoc ne va pas réussir à les intégrer dans le pdf. Pour que l’interpréteur pandoc fonctionne correctement, les images doivent appartenir au wiki…

Markdown interprète toute ligne commencant par ! comme une figure

Pour numéroter les figures on utilise la syntaxe dérivée du LateX en fixant un label \label{nom_label} à la suite du texte descriptif de l’image en les crochets succédant au !

On réalise ensuite les références dans le corps de texte de la manière suivante (cf figure \ref{nom_label})

~~~~~~~ { .markdown } (cf figure \ref{mon_label_de_figure}) ……bla bla bla……. ~~~~~~~

gestion des pages du wiki

Chaque page du wiki doit être terminée par ***

export en pdf

On peut ensuite créer un pdf avec le logiciel pandoc. A noter qu’il faut avoir MiKTeX d’installé.

http://pandoc.org/

http://miktex.org/

Pandoc peut créer automatiquement une table des matières et tous les signets afférents avec l’option –toc

Un fichier bat situé à la racine du wiki permet de faire celà en automatique createpdf_local.bat Ce fichier s’exécute en local et produit un fichier memoire.pdf à la racine du wiki

après clonage, ce fichier est disponible en ligne :

https://github.com/alexandrecuer/smartgrid/wiki/memoire.pdf

Pour commencer à travailler :

https://github.com/alexandrecuer/smartgrid/wiki/01_objet