Affichage des articles dont le libellé est Markdown. Afficher tous les articles
Affichage des articles dont le libellé est Markdown. Afficher tous les articles

mercredi 22 juin 2022

Quel est le meilleur outil pour faire du Mark Down

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 :

Markdown Guide - Basic Syntax

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!

lundi 15 octobre 2018

GitHub - C'est quoi les fichiers .md (point md) ? Markdown ?

Je cherche à maîtriser une fois pour toute l'édition sous GitHub et GitLab. Faisons un tour complet sur les fameux fichiers ".md" que l'on trouve pour créer la documentation sous GitHub. A l'heure où je vous écris, je vous l'avoue, je ne sais pas encore ce qu'est réellement un fichier .md.


Je l'ai découvert par la force en utilisant GitHub. J'ai trouvé comment jongler avec, un tout petit peu dans GitLab dans l'article suivant Comment exporter votre Wiki. Mais je ne sais toujours pas ce que signifie réellement l'extension de fichiers ".md".

Je cherche et je me retrouve sur des sites qui ne me donnent pas la solution, un tas de sites se sont organisés pour que vous les visitiez mais ne vous donne pas la solution ! C'est quoi cette extension de fichier ".md" ... bref c'est Wikipédia qui gagne encore une fois la batille de la culture geek :

Un fichier ".md" est un fichier Markdown, Markdown est un langage de balisage léger créer en 2004 par John Gruber et Aaron Swartz.

https://donate.wikimedia.org/

Ah, j'étais bien ennuyé avec cette histoire de fichier ".md" car ils sont la clef de la documentation sous GitHub.

Aide et syntaxe

Le pire avec cette histoire c'est que GitHub se mords la queue, pour trouver de l'aide sur les fichiers d'aide (de documentation) c'est dans github dans un fichier .md :

https://github.com/luongvo209/Markdown-Tutorial/blob/master/README_fr.md

Là on est bien, c'est en français, il y a toutes les explications sur les fichiers Markdown merci à Luong Vo pour son travail de documentation, d'autres sujets chez lui son également très intéressants.

Outils

Originel en ligne par les créateurs du concept voici : dingus
il converti votre markdown en HTML

L'outil très puissant en ligne : Stack Edit

Encore un peu de doc : Comment bien commencer avec Markdown


Amusons nous avec les fichiers Markdown !