From 3587cb3ea1f9c0a3ed40b1cb6a04f58b7208437f Mon Sep 17 00:00:00 2001 From: Arnaud Legrand Date: Mon, 24 Sep 2018 21:58:50 +0200 Subject: [PATCH] Regenerate HTML. Propagate to FUN. --- .../ressources/introduction_to_markdown.html | 177 +++++++++++------- 1 file changed, 109 insertions(+), 68 deletions(-) diff --git a/module1/ressources/introduction_to_markdown.html b/module1/ressources/introduction_to_markdown.html index 7223903..c878a66 100644 --- a/module1/ressources/introduction_to_markdown.html +++ b/module1/ressources/introduction_to_markdown.html @@ -4,32 +4,33 @@

Table of Contents

@@ -37,13 +38,13 @@ Voici un aperçu rapide de la syntaxe Markdown repris d'une présentation de Github ainsi que de celles d'Archer Reilly.

-
-

Syntaxe

-
+
+

Syntaxe

+
-
-

Headers

-
+
+

Headers

+
 # This is an <h1> tag
 ## This is an <h2> tag
@@ -52,9 +53,9 @@ Voici un aperçu rapide de la syntaxe Markdown repris d'une
-
-

Emphasis

-
+
+

Emphasis

+
 *This text will be italic*
 _This will also be italic_
@@ -67,13 +68,13 @@ _You **can** combine them_
-
-

Lists

-
+
+

Lists

+
-
-

Unordered

-
+
+

Unordered

+
 - Item 1
 - Item 2
@@ -82,9 +83,9 @@ _You **can** combine them_
-
-

Ordered

-
+
+

Ordered

+
 1. Item 1
 2. Item 2
@@ -95,27 +96,27 @@ _You **can** combine them_
-
-

Images

-
+
+

Images

+
 ![GitHub Logo](/images/logo.png)
 Format: ![Alt Text](url)
-
-

Links

-
+
+

Links

+
 http://github.com - automatic!
 [GitHub](http://github.com)
-
-

Blockquotes

-
+
+

Blockquotes

+
 As Kanye West said:
 
@@ -124,9 +125,9 @@ As Kanye West said:
-
-

Inline code

-
+
+

Inline code

+
 To print some text with python, you should use the `print()` function.
 ```
@@ -136,9 +137,9 @@ print("Hello world!")
-
-

Écrire des Maths

-
+
+

Écrire des Maths

+

Il est possible d'écrire des formules en Markdown, soit en mode inline soit en mode displayed formulas. Dans le premier cas, les formules @@ -189,9 +190,9 @@ bien avec un $. Pour d'autres exemples plus complets jetez un coup d'œil à ces exemples de James H. Steiger.

-
-

Lettres grecques

-
+
+

Lettres grecques

+
@@ -235,9 +236,9 @@ d'œil à ces -

Fonctions et opérateurs

-
+
+

Fonctions et opérateurs

+
@@ -326,9 +327,9 @@ d'œil à ces -

Exposants et indices

-
+
+

Exposants et indices

+
@@ -362,9 +363,9 @@ d'œil à ces -

Fractions, coefficients binomiaux, racines, …

-
+
+

Fractions, coefficients binomiaux, racines, …

+
@@ -418,9 +419,9 @@ d'œil à ces -

Sommes et intégrales

-
+
+

Sommes et intégrales

+
@@ -449,9 +450,9 @@ d'œil à ces -

Déguisements

-
+
+

Déguisements

+
@@ -496,4 +497,44 @@ d'œil à ces +

Autour de markdown

+
+

+Tout d'abord, pour aller plus loin avec markdown et ses extensions / ramifications : +

+ + +

+Comme nous l'illustrons dans la « film d'écran » (screencast), l'éditeur de texte des dépôts github et gitlab permet d'interpréter / transformer à la demande un fichier mardown en un fichier html. C'est à la fois agréable et pratique, mais ce n'est pas une solution pour une utilisation quotidienne de markdown, pour cela, il est plus efficace d'éditer son texte, avec un éditeur de texte, sur son ordinateur, avant de « l'exporter » dans un format comme html, pdf, docx, epub, etc. Il existe des éditeurs plus ou moins spécialisés pour markdown, certains sont indiqués sur la page Editors du site de pandoc, mais nous préconisons clairement l'emploi d'un éditeur de texte « généraliste » capable de reconnaître la syntaxe markdown. Nous en avons indiqué en début de séquence et on pourra trouver des informations complémentaires dans la section Quelques éditeurs adaptés à l'édition Markdown du didacticiel de Jean-Daniel Bonjour. +

+ +

+Pour convertir un fichier markdown en un format « arbitraire », la solution à ce jour la plus complète est Pandoc, logiciel développé par John MacFarlane, un philosophe de Berkeley (le site github). En plus du site de Pandoc, le didacticiel de J.-D. Bonjour donne de nombreuses explications sur comment installer et utiliser pandoc dans la section Utilisation du convertisseur Pandoc. Comme pandoc – écrit en Haskell – peut être parfois un peu difficile à installer, nous indiquons maintenant quelques solutions alternatives : +

+
    +
  • Des sites comme http://www.markdowntopdf.com/ et http://markdown2pdf.com/ permettent de convertir en ligne un fichier markdown en un fichier pdf.
    • +
  • Le projet CommonMark propose, en plus d'une spécifications plus rigoureuse de la syntaxe markdown, des convertisseurs markdown → html / LaTeX (et plus) écris en C et en JavaScript (https://github.com/CommonMark/CommonMark).
    • +
  • Le site de John Gruber, le créateur de markdown, fournit un convertisseur markdown → html écrit en perl.
    • +
  • MultiMarkdown est une autre extension de markdown qui vient avec son convertisseur markdown → html écrit en C.
    • +
  • grip est un serveur écrit en python qui permet de convertir et visualiser à la volée des fichiers markdown avec son navigateur (très utile pour éviter d'avoir à faire des « commits » en grande quantité lorsqu'on écrit de tels fichiers pour un dépôt github ou gitlab).
    • +
+

+La conversion en pdf passe toujours par LaTeX ce qui nécessite d'avoir une version complète et à jour de ce logiciel sur sa machine. +

+ +

+Dans la petite démonstration, nous montrons comment générer un fichier docx à partir d'un fichier md avec Pandoc et nous soulignons qu'il est alors possible d'utiliser un traitement de texte comme LibreOffice pour modifier le fichier obtenu. Il est clair que si des modifications sont apportées au docx elle en seront pas (automatiquement) propagées au md. Il faudra utiliser Pandoc pour cela et effectuer une conversion de docx vers md (et seules les éléments du format docx qui existent en md seront conservés). +

+ +

+Une stratégie qui est souvent employée et qui fonctionne bien en pratique consiste à faire le gros du travail de rédaction d'un article ou d'un mémoire en Markdown. La rédaction terminée, le fichier est exporté au format docx (ou LaTeX) et des ajustements de mise en page sont alors effectués avec un logiciel de traitement de texte (ou un éditeur LaTeX). +

+
+ -- 2.18.1