Utiliser
le Markdown
pour tout faire

Cédric Eyssette (2022-2023)
https://eyssette.github.io/

I -
Pourquoi ?

Première partie

A. Objectif principal

→ Travailler seulement avec des fichiers textes

1/ Un format léger

  • Édition plus rapide
    • Pas besoin d'un logiciel lourd
    • Pas besoin d'un ordinateur hyper-performant
    • Logiciels plus adaptés pour l'édition de textes
    • Focalisation sur le fond et pas sur la forme
  • Sauvegarde plus économe et plus rapide
    • synchronisation facilitée
    • versionnage facilité
  • Recherche plus rapide dans ses fichiers

2/ Un format ouvert

  • On peut utiliser n'importe quelle machine et n'importe quel logiciel d'édition de texte
  • On peut collaborer facilement sur un même fichier
  • La pérennité du fichier est assurée

B. Le Markdown : un bon compromis

→ Une syntaxe qui reste simple
→ Mais qui permet de créer
des documents complexes

1/ Une syntaxe simple

  • Titres : # Titre 1 / ## Titre 2
  • Gras / italiques : **gras** / _italiques_
  • Citations, code : > citation / `code`
  • Listes : - texte / 1. texte
  • Liens : [texte](URL)
  • Images : ![description](URL)

Deux avantages

  1. Un balisage léger : compréhensible par un être humain et facile à apprendre.
  2. Un document structuré : facile à exploiter par un programme informatique.

2/ Une syntaxe qui permet de
créer des documents complexes

  • Possibilité d'intégrer du HTML, du
  • Des extensions possibles du Markdown
  • Possibilité d'avoir un en-tête en YAML
  • Des outils pour transformer le markdown en un autre format : un pdf, un diaporama, un site web, une carte mentale, …
  • Export HTML : intégration possible de styles CSS

II -
Comment ?

Deuxième partie

A. Pour éditer
son texte

  1. Une solution en ligne dans Apps Edu : CodiMD
  2. Un logiciel dédié à l'édition en Markdown
  3. Un éditeur de texte brut avec des plugins pour le markdown

Logiciel proposé : VS Codium

  1. Une interface générale et un système de plugins très pratiques
  2. Des raccourcis claviers très efficaces
  3. Des snippets configurables

B. Pour sauvegarder et gérer l'historique

→ utiliser git et une forge
→ utiliser diff

C. Pour transformer son fichier dans
un autre format

1) Document texte au format académique (thèse, article, poster …)

2) Diaporama

3) Sites webs

  • Plusieurs générateurs de sites statiques : jekyll, mkdocs, mdbook, Hugo …
  • Un même principe : des fichiers en markdown, des propriétés YAML exploitées par le thème, une syntaxe pour créer des modèles de page

4) Cartes mentales

5) Des modèles spécifiques

  • Idée : créer des modèles dédiés à un usage pédagogique précis
  • Des modèles utilisables soit par les collègues soit par les élèves dans le cadre d'une activité qu'on leur fait faire
  • Des modèles utilisables sur CodiMD et sur la forge

Exemples

VSCodium : évoquer (en parler plus tard) git, forge pour synchronisation et versionnage évoquer système de nommage des fichiers

Pas prisonnier d'un logiciel qui doit être installé, on peut travailler de partout même avec un éditeur en ligne (VS Code : édition en ligne possible)

Extensions du markdown : notes de bas de page tableaux texte souligné / surligné / supprimé / exposant / indices https://github.com/CriticMarkup/CriticMarkup-toolkit Ajouter ? Des outils pour intégrer dans du markdown d'autres fichiers ? fichier bibtex pour les

Faire démonstration : correction de copies / création d'un diaporama

https://ineed.coffee/post/how-to-write-an-acm-styled-conference-paper-using-markdownpandoc http://programminghistorian.org/en/lessons/sustainable-authorship-in-plain-text-using-pandoc-and-markdown

Montrer comment Marp fonctionne

Montrer comment myMarkmap fonctionne