Quel fichier utilise l'extension .md et comment dois-je les modifier?

879

Sur GitHub, plusieurs projets ont des README.mdfichiers. Cela ressemble à un simple fichier de format pour exprimer du texte et des images.

Je suppose qu'il y a un éditeur ou une explication de la syntaxe quelque part.

Où puis-je trouver une introduction aux .mdfichiers?

markdown  file-extension 
— Lai Yu-Hsuan
source
38
Je suppose que c'est une preuve en faveur de l'utilisation de l' .markdownextension à la place, bien qu'elle soit terriblement longue ...
— endolith
7
Voici un lien qui peut vous aider -> Extension de fichier .MD
— Vipin Kr. Singh
1
MarkPad est une belle application pour l'édition MarkDown dans Windows. Il vous présente l'aperçu des modifications.
— skjoshi
1
L'utilisateur peut essayer MarkView , une extension Chrome pour modifier et afficher le fichier de démarque dans le navigateur.
— swcool
1
Guide complet pour vous aider à commencer markdown: blog.wax-o.com/2014/04/… . Vous devriez essayer d'écrire des démarques avec un moyen de visualiser en direct le résultat (avec une application comme mouapp.com ). Saviez-vous que la syntaxe de publication et de commentaire stackoverflow est basée sur le démarque? :) stackoverflow.com/editing-help
— fabien

Réponses:

733

Markdown est un format de fichier en texte brut. Les extensions .mdet ne .markdownsont que des fichiers texte écrits en syntaxe Markdown . Si vous en avez un Readme.mddans votre dépôt, GitHub affichera le contenu sur la page d'accueil de votre dépôt. Lisez la documentation:

Vous pouvez modifier le Readme.mdfichier dans GitHub lui-même. Cliquez sur Readme.md, vous trouverez un bouton d'édition. Vous pouvez prévisualiser vos modifications et même les valider à partir de là.

Puisqu'il s'agit d'un fichier texte, le Bloc-notes ou Notepad ++ (Windows), TextEdit (Mac) ou tout autre éditeur de texte peuvent être utilisés pour le modifier et le modifier. Il existe des éditeurs spécialisés qui analysent automatiquement le démarque au fur et à mesure que vous le tapez et génèrent un aperçu, tandis que d'autres appliquent diverses couleurs de syntaxe et décorations au texte affiché. Dans les deux cas cependant, le fichier enregistré est toujours un fichier texte lisible.

Si vous voulez créer un mdfichier avec aperçu et si vous préférez ne pas installer des éditeurs spéciaux, vous pouvez utiliser des éditeurs en ligne comme dillinger.io et stackedit.io . Ils fournissent un aperçu en direct. Vous pouvez également exporter vos fichiers vers Google Drive ou Dropbox .

— Dikei
source
27
J'ai trouvé l' explication de base de Github très utile aussi comme introduction rapide.
— Voo
2
Sous Windows, vous souhaiterez peut-être utiliser WordPad pour utiliser la mise en forme pour une lecture plus facile.
— G O'Rilla
4
@ GO'Rilla, à mon humble avis, évitez WordPad comme la peste à moins de vous écrire de petites notes que vous ne partagerez jamais avec personne. Ce qu'il ajoute au fichier .txt peut faire des ravages sur d'autres éditeurs (vim, Notepad ++, etc.). Il est préférable de travailler en texte brut lors de l'utilisation de .txt et d'utiliser un traitement de texte ou Acrobat pour les fichiers textuels non .txt comme .doc et .pdf.
— labyrinthe
1
pouvons-nous ajouter des images ou via un lien dans un fichier .md ... est-ce possible?
— Raphael
1
@ user1645290 Oui, c'est possible. voir
— B-GangsteR
87

Si vous cherchez un éditeur, je vous suggère d'utiliser http://dillinger.io/ . Il s'agit d'un simple éditeur de texte basé sur un navigateur qui peut rendre Markdown à la volée.

Cependant, si vous préférez une application et que vous utilisez OS X, vous pouvez essayer Mou . C'est assez bon et plein d'exemples.

— sirLisko
source
2
Il semble être revenu à la vie?
— GuiSim
5
J'aimerais suggérer http://dillinger.io/ , un autre éditeur de texte basé sur un navigateur vraiment cool. Il vous permet également de lier Dropbox, Github et Google Drive.
— sirLisko
Le lien Bloc-notes dans cette réponse déclenche un téléchargement de fichier RAR. Pourquoi n'y a-t-il pas de page Web, n'avez-vous pas dit qu'il s'agissait d'un éditeur basé sur un navigateur?
— evanrmurphy
ce lien n'est plus valide
— Carlos Pliego
Je souligne simplement que ce n'est pas une réponse complète à la question. Vous n'expliquez pas ce qu'est .md, seulement comment il peut être édité
— Zoe
33

L' éditeur de texte Visual Studio Code de Microsoft a intégré la prise en charge des fichiers .md écrits dans la syntaxe de démarque.

La syntaxe est automatiquement codée par couleur à l'intérieur du fichier .md et une fenêtre d'aperçu de la démarque rendue peut être affichée en appuyant sur Shift+Ctrl+V(Windows) ou Shift+Cmd+V(Mac).

Pour les voir côte à côte, faites glisser l'onglet d'aperçu vers le côté droit de l'éditeur, ou utilisez Ctrl+K V(Windows) ou Cmd+K V(Mac) à la place.

entrez la description de l'image ici

VS Code utilise la bibliothèque marquée pour l'analyse et la prise en charge de Github Flavored Markdown est activée par défaut, mais il n'affichera pas l'Emoji Github en ligne comme l' éditeur de texte Atom de Github .

En outre, VS Code prend en charge plusieurs plugins de démarque disponibles pour des fonctionnalités étendues.

— Feckmore
source
Si vous utilisez Visual Studio 2015 à la place, consultez ma réponse ci-dessous.
— bytedev
1
Remarque - vous pouvez cliquer avec le bouton droit sur le fichier Lisez-moi> ouvrir l'aperçu
— Chris Halcrow
15

L'extension ' .md ' fait référence aux fichiers Markdown .

Si vous ne souhaitez pas installer une application pour les lire dans ce format, vous pouvez simplement utiliser TextEdit ou Xcode lui-même pour l'ouvrir sur Mac.

Sur tout autre système d'exploitation, vous devriez pouvoir l'ouvrir à l'aide de n'importe quel éditeur de texte , mais comme prévu, vous ne le verrez pas au format Markdown .

— brûlure de code
source
4
En fait, vous le verrez au format Markdown. Cependant, vous ne le verrez pas en gras, en italique, en retrait et en blocs de code.
— Courses de légèreté en orbite
14

Oui, juste Markdown aromatisé GitHub . L'inclusion d'un fichier README dans votre référentiel aidera les autres à déterminer rapidement de quoi il s'agit et comment l'installer. Très utile à inclure dans vos dépôts.

— esilvas
source
5
Voté. Par «un» dans «dont un dans votre référentiel», vous devez signifier «un fichier README dans n'importe quel format», pas seulement «un fichier README.md». Mais la question porte sur les fichiers «.md» en général, et non sur les fichiers README en général. Donc, cette réponse est sans rapport avec la question. De plus, l'ambiguïté avec «un» pourrait faire penser au lecteur que les README Markdown sont nécessairement meilleurs que les autres README, ce qui est faux.
— Rory O'Kane
1
J'ai apporté le changement spécifié dans le commentaire précédent, car il est logique et je pense que cela pourrait aider à éviter toute confusion. Je ne pense pas que ce soit une très bonne réponse, car elle n'ajoute rien de nouveau qui soit pertinent. Cette question ne concerne pas les fichiers README, elle concerne l'extension .md. Il n'y a aucune raison d'ajouter cette réponse six semaines après que la réponse acceptée a fourni les mêmes informations.
— Erick Robertson
5

Stack Edit est un éditeur de démarque en ligne avec la possibilité d'enregistrer sur Google Drive et DropBox.

— Philippe
source
5

Markdown est juste un fichier texte qui a éventuellement .md, ou des .markdownextensions. Il peut être converti en HTML. Pour connaître la syntaxe de Markdown, consultez

Markdown aromatisé GitHub .

Vous pouvez utiliser n'importe quel éditeur de texte pour le démarque. Si vous êtes sublime textutilisateur, vous pouvez vérifier le Markdown Previewplugin qui affichera le contenu de démarque rendu dans le navigateur et les mises à jour chaque fois que vous modifiez le fichier de démarque.

Une partie de l'éditeur de démarque en ligne

— Fizer Khan
source
3

Je suggère StackEdit . Il s'agit d'un simple éditeur WISIWIG. Vous pouvez utiliser à la fois l'éditeur et la syntaxe de démarque. Il y a une syntaxe rapide d'aide au démarquage. Annuler / refaire, commentaires, GoogleDrive, interconnexion Dropbox.

— Romeno
source
2

Si vous créez des fichiers .md pour vos solutions .NET, je recommande l' Éditeur Markdown de l' extension Visual Studio 2015 car il possède un panneau d'aperçu afin que vous puissiez voir vos modifications en temps réel.

EDIT : Cela devrait également fonctionner avec Visual Studio 2017.

— bytedev
source
0

La chose la plus simple à faire, si vous n'avez pas de lecteur, est d'ouvrir le fichier MD avec un éditeur de texte, puis d'écrire le fichier MD en tant que fichier HTML, puis de double-cliquer pour l'afficher avec le navigateur.

— richardwendrock
source
Cela ne fonctionnera que si vous avez un plugin qui lit les fichiers .md.
— Brad Bruce
0

Le .md signifie Markdown Text. Fondamentalement, c'est juste un autre type de fichier texte, comme .txt

J'utilise Notepad ++ pour lire et éditer ces

— NocFenix
source
En utilisant notre site, vous reconnaissez avoir lu et compris notre politique liée aux cookies et notre politique de confidentialité.
Licensed under cc by-sa 3.0 with attribution required.