Date Catégorie posts Étiquettes www / dev

Qu'est ce que markdown?

Markdown est probablement le format de texte enrichi le plus efficient pour structurer simplement des documents en texte brut. Il est pensé comme un standard ultra simplifié permettant de multiple conversions. Avec un document au format Markdown, vous pourrez générer simplement un document word, un fichier PDF, une page web ou encore un diaporama ...

Pour la petite histoire ce langage est créé par John Gruber en 2004 avec l'aide notamment d'Aaron Swartz

le point noir c'est ...

les tableaux! A l'évidence, pour des tableaux avec un contenu un peu conséquent, ou un minimum structuré, markdown atteint ses limites. Si vous gérez des tableaux complexes, il sera probablement plus productif de repasser en html. Vous pouvez avoir recours à un éditeur WISYWYG : nvu est un bon candidat

n'oubliez pas les entités html

L'utilisation unitaire des symbols * ou _ peut casser la coloration syntaxique de votre éditeur ...

Pas de panique les entités html vous rendront service

  • * = *
  • _ = _

Quelques outils

  • GitLab (comme GitHub) autorise le Markdown à peu près partout où il est possible de saisir du texte (commits, commentaires, issues, snipets)
  • atom est un éditeur de texte léger qui offre une prévisualisation dur endu d'un fichier markdown (ctrl+maj+m)
    • le plugin atom markdown-mindmap permet notamment de dessiner une carte mentale à partir des titres d'un document
  • reveal.js permet de faire des slides show visionnables dans un navigateur en markdown
  • pandoc est un convertisseur universel de document. Grâce à lui vous pourrez transformer un fichier Mardown en html, doc, pdf, epub, ...
  • mkdocs est un outil permettant d'écrire de la documentation au format markdown et de générer un site en html statique
  • pelican est un outil permettant d'écrire des posts de blog au format markdown et de générer un site en html statique
    • le CRI ISIMA/LIMOS l'utilise pour ce blog et le proposera d'ici peu pour vos pages persos