Horizon Du Web Actualité & horizon du web et de l'IT à perte de vue !
Related Articles
Vous en avez assez d’écrire vos commentaires en HTML ? Vous souhaitez utiliser un langage commun sur le web ? Ecrire une documentation rapidement ? Publier des guides sur GitHub ? Préparer des tutoriels avec facilité ? J’ai pour vous La solution !
Markdown est fait pour vous. En effet, cette syntaxe se veut être facile à écrire, à lire et donc à comprendre. Markdown va vous permettre de formater des documents, de rédiger des textes avec un système de balisage léger. Le but principal est d’avoir une syntaxe simple à prendre en main, commune et efficace !
Pourquoi Markdown ?
L’idée est venue aux créateurs parce qu’ils se sont aperçus qu’il n’était pas vraiment pratique de devoir utiliser la syntaxe HTML pour l’écriture de texte. En effet, bien que les balises HTML soient simples, l’écriture de documents dans ce langage est parfois une tâche laborieuse. C’est pourquoi, une syntaxe a été inventée pour mettre en forme ses documents, elle devait être simple, rapide à prendre en main et ne nécessitant pas l’utilisation de la souris, tout peut se faire au clavier avec Markdown !
Elle peut être utilisée dans de nombreux cas, comme par exemple :
- La rédaction de commentaires sur des Forums et divers sites (Stack Overflow, Le site du zéro, etc.)
- La prise de notes
- La rédaction de tutoriels
- La préparation de cours (supports et travaux pratiques)
- Et bien sûr, les documentations et guides, présents par exemple sur GitHub (exemple : README.md)
L’un des ses premiers avantages, outre le fait que la syntaxe soit très simple et conviviale, réside en sa notoriété. En effet, Markdown est connue de nombreux outils et services et de ce fait, est reconnue et prise en charge directement dans les éditeurs de textes. Ainsi, vous pouvez prendre l’habitude de rédiger vos écrits à l’aide de cette syntaxe et une fois validé et publié, le texte sera automatiquement converti dans le format adapté et lisible.
Afin de partir sur de bonnes bases, il est possible d’utiliser des outils permettant d’écrire et de formater les textes à l’aide de Markdown, l’avantage est que l’on voit en temps réel le résultat. C’est le cas par exemple pour MarkdownPad qui est utilisable sous Windows et existe dans une version gratuite (version payante à 15$). Pour les utilisateurs Mac, il existe l’outil Mou.
MarkdownPad en quelques mots est un éditeur de texte simple et ergonomique permettant de faire du Text-to-Html. En quelques lignes, peu d’efforts et seulement à l’aide du clavier, on obtient de l’HTML. MardownPad se présente de la manière suivante :
C’est un outil qui s’installe facilement et qui fonctionne très bien, il aide fortement dans la rédaction de documents. Je m’en sert à titre personnel pour l’écriture de supports de cours, utiles lors de mes interventions.
Quelques fonctionnalités clés de MarkdownPad :
- On écrit, on voit, en temps réel
- Défilement automatique du texte, la prévisualisation se déplace automatiquement au même niveau que notre rédaction
- Il existe une barre d’outils avec les fonctionnalités d’édition de texte (gras, titre, italique, etc.)
- Il est possible de personnaliser l’environnement de MardownPad (couleurs, etc.)
- On peut ajouter une feuille de style pour personnaliser le rendu final du document
- On peut convertir le texte Markdown en HTML
- D’autres fonctionnalités que vous pourrez découvrir par vous même
Quelques commandes basiques :
A première vue, les inconvénients de Markdown sont principalement l’apprentissage de la syntaxe, qui reste cependant très rapide à comprendre et à prendre en main, mais aussi une communautés qui est dans 95% des cas anglaise. En d’autres termes, il n’y a pas vraiment de raisons de s’opposer à cette syntaxe qui se veut simple, ergonomique (la souris n’étant pas nécessaire), connue et reconnue (compatible avec la majorité des éditeurs de texte).
C’est terminé pour cette brève présentation de Markdown et ses outils, un tutoriel sera bientôt rédigé afin de vous montrer les différentes commandes de la syntaxe Markdown.
Alors, c’est à vous de jouer ! Essayez, pratiquez et n’hésitez pas à nous faire vos retours ici.
Quelques liens utiles :
- Site officiel : http://daringfireball.net/projects/markdown/
- Documentation officielle : http://daringfireball.net/projects/markdown/syntax
- MarkdownPad (Windows) : http://markdownpad.com/
- Mou (Mac) : http://mouapp.com/
- Editeur en ligne : http://joncom.be/experiments/markdown-editor/edit/
- Markdown guide : https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet
- Markdown Cheat Sheet : https://raw.github.com/ahrencode/Miscellaneous/master/markdown-cheatsheet.png
C’est vrai que Markdown semble intéressant et devient une convention notament grâce à Github.
Savez-vous s’il existe des Wiki ou des plugins WordPress compatible ?