Un fichier Mark Down avec une extension ".md" est un fichier texte qui permet d'afficher quelque styles et quelques mise en forme de texte simple textuel. Un fichier markdown vous permet de mettre en forme du texte, sans pour autant pénaliser sa lecture par un humain.
C'est le format de documentation à la mode en ce moment, il a été mis en lumière par GitHub qui l'a adopté pour afficher la première page de documentation de votre projet.
Avoir un fichier mark down à la racine de votre repository, c'est l'assurance d'une documentation facile à lire, facile à maintenir, la syntaxe Mark Down étant simple et ne prenant que quelques caractères.
Voici un outil simple d'un côté le texte en markdown de l'autre le texte mis en forme, voici MarkdownPad :
MarkdownPad pour éditer vos fichiers MD |
Ce n'est que pour la plateforme Windows car on vous propose d'installer Microsoft .NET 4 Client Profile pour faire fonctionner cette application.
MarkdownPad - pour éditer vos fichiers Markdown |
Pour la syntaxe Markdown j'ai trouvé ce site :
Pour en découvrir un peu plus sur les fichiers mark down :
Outils de Développement Logiciel - GitHub - C'est quoi les fichiers .md (point md) ? Markdown ?
Vous connaissez d'autres outils plus agréables à utiliser, n'hésitez pas à faire votre commentaire.
Have fun!
Aucun commentaire:
Enregistrer un commentaire