3.9 KiB
Le document 2.0
Accueil
Bienvenue !!!
Objectifs de cet atelier:
- Partager ma méthode de travail pour créer des documents
- Présenter une méthodologie de travail axée sur le minimalisme
- Présenter les avantages de travailler avec des formats ouverts et des outils libres
Ordre du jour
- La syntaxe Markdown
- Les thèmes Bootstrap
- L'outil de conversion de documents Pandoc
Markdown
- Markdown est une syntaxe simple pour écrire des textes et de la documentation.
- C'est un langage de balisage léger, beaucoup plus simple que le HTML et le LaTeX.
- Cette syntaxe permet la création de documents source lisibles par l'humain.
- Elle est inspirée de plusieurs notations utilisées dans les courriels avant l'utilisation massive du HTML.
- La documentation complète de Markdown tient dans une seule page: cheat sheet
Conversion du Markdown
Markdown est concu pour être converti en d'autres formats facilement:
- HTML: Site web prêt à mettre en ligne)
- PDF: Documents imprimables et diapositives.
- LaTeX: Documents scientifiques et publications professionnelles
- ODT: Format ouvert de document pour le traitement de texte utilisé par LibreOffice, OpenOffice, Google Docs. Assure la pérennité de l'information
- Office Open XML (fichiers .docx): Format commun de bureautique (très mauvaise compatibilité)
- MediaWiki: Syntaxe de documentation collaborative, utilisée par Wikipédia et autres
Les saveurs de Markdown
Attention: Il n'existe pas de standard de Markdown
- Il y a par contre peu de différences entre celles-ci, ce sont surtout des ajouts pour des besoins précis
Quelques saveurs:
- GitHub: Utilisée sur ce réseau social pour développeurs
- R Markdown: Utilisé pour créer des rapports statistiques très élégants (C'est ce qu'on utilise dans mon équipe)
- Pandoc Markdown: Utile pour créer des documents riches dans plusieurs formats de façon automatisée.
La syntaxe
La documentation de la syntaxe Markdown peut facilement être trouvée en ligne. Une version française se trouve ici:
Quel éditeur utiliser?
- Pour les minimalistes, le bloc-notes de Windows peut amplement suffire.
- Plusieurs éditeurs de code permettent d'utiliser Markdown plus aisément:
- Atom
- Visual Studio Code
- Remarkable
- RStudio
Atom
Atom: Éditeur de texte pour le 21e siècle!
Visual Studio
Visual Studio Code est un éditeur libre, moderne et tres performant développé par la communauté et Microsoft.
Je recommande Visual Studio Code. Il est disponible sur tous les environnements de bureau et existe aussi en version portable afin de contourner les restrictions d'entreprise.
Remarkable
Remarkable est un éditeur simple et convivial pour la syntaxe Markdown
RStudio
RStudio est d'abord un environnement de développement intégré (IDE) pour le langage statistique R, mais il est aussi un excellent éditeur markdown. Il supporte aussi sa propre syntaxe RMarkdown pour la production de rapports statistiques et de documents interactifs.
