¿Qué archivo utiliza la extensión .md y cómo debo editarlos?

879

En GitHub, varios proyectos tienen README.mdarchivos. Parece un archivo de formato simple para expresar texto e imágenes.

Supongo que hay un editor o una explicación de sintaxis en alguna parte.

¿Dónde puedo encontrar una introducción a los .mdarchivos?

Lai Yu-Hsuan
fuente
38
Creo que esto es una evidencia a favor de usar la .markdownextensión en su lugar, a pesar de que es tan terriblemente largo ...
endolito
77
Aquí hay un enlace que puede ayudarlo -> .MD File Extension
Vipin Kr. Singh
1
MarkPad es una buena aplicación para editar MarkDown en Windows. Le presenta la vista previa de las ediciones.
skjoshi
1
El usuario puede probar MarkView , una extensión de Chrome para editar y ver archivos de descuento dentro del navegador.
swcool
1
Guía completa para ayudarlo a comenzar con markdown: blog.wax-o.com/2014/04/… . Debería intentar escribir un descuento con una forma de vivir visualizando el resultado (con una aplicación como mouapp.com ). ¿Sabía que la sintaxis de publicación y comentario de stackoverflow se basa en el descuento? :) stackoverflow.com/editing-help
fabien

Respuestas:

733

Markdown es un formato de archivo de texto plano. Las extensiones .mdy .markdownson solo archivos de texto escritos en sintaxis Markdown . Si tiene un Readme.mden su repositorio, GitHub mostrará el contenido en la página de inicio de su repositorio. Lee la documentación:

Puede editar el Readme.mdarchivo en GitHub. Haga clic en Readme.md, encontrará un botón de edición. Puede previsualizar sus cambios e incluso confirmarlos desde allí.

Como se trata de un archivo de texto, se puede usar Notepad o Notepad ++ (Windows), TextEdit (Mac) o cualquier otro editor de texto para editarlo y modificarlo. Existen editores especializados que analizan automáticamente la reducción a medida que la escribe y generan una vista previa, mientras que otros aplican varios colores y decoraciones de sintaxis al texto que se muestra. Sin embargo, en ambos casos, el archivo guardado sigue siendo un archivo de texto legible.

Si desea crear un mdarchivo con vista previa y si prefiere no instalar editores especiales, puede usar editores en línea como dillinger.io y stackedit.io . Proporcionan vista previa en vivo. También puede exportar sus archivos a Google Drive o Dropbox .

Dikei
fuente
27
La explicación básica de Github también me pareció muy útil como introducción rápida.
Voo
2
En Windows, es posible que desee utilizar WordPad para utilizar el formato para una lectura más fácil.
G O'Rilla
44
@ GO'Rilla, en mi humilde opinión, evita WordPad como la peste a menos que te escribas pequeñas notas que nunca compartirás con nadie. Lo que agrega al archivo .txt puede causar estragos en otros editores (vim, Notepad ++, etc.). Es mucho mejor trabajar en texto plano cuando se trata de .txt y usar un procesador de textos o Acrobat para archivos de texto que no sean .txt como .doc y .pdf.
laberinto
1
¿podemos agregar imágenes o mediante un enlace en un archivo .md ... es posible?
Raphael
1
@ user1645290 Sí, es posible. ver
B-GangsteR
87

Si está buscando un editor, le sugiero que use http://dillinger.io/ . Es un editor de texto simple basado en navegador que puede generar Markdown sobre la marcha.

Sin embargo, si prefiere una aplicación y está utilizando OS X, puede probar Mou . Es bastante bueno y está lleno de ejemplos.

señor Lisko
fuente
2
Parece volver a la vida?
GuiSim
55
Me gustaría sugerir http://dillinger.io/ , otro editor de texto basado en navegador realmente genial. También le permite vincular Dropbox, Github y Google Drive.
sirLisko
El enlace del Bloc de notas en esta respuesta desencadena una descarga de archivo RAR. ¿Por qué no hay una página web? ¿No dijiste que era un editor basado en navegador?
evanrmurphy
ese enlace ya no es válido
Carlos Pliego
Simplemente señalando que esta no es una respuesta completa a la pregunta. No explicas qué es .md, solo cómo se puede editar
Zoe
44

El editor de texto Atom de Github tiene un modo de vista previa en vivo para archivos de rebajas.

El atajo de teclado es CTRL+SHIFT+M.

Se puede activar desde el editor utilizando la CTRL+SHIFT+Mclave de unión y actualmente está habilitado .markdown, .md, .mkd, .mkdown, y .ronarchivos.

ingrese la descripción de la imagen aquí

Feckmore
fuente
33

El editor de texto Visual Studio Code de Microsoft ha incorporado soporte para archivos .md escritos en sintaxis de reducción.

La sintaxis se codifica automáticamente por colores dentro del archivo .md, y se puede ver una ventana de vista previa de la reducción representada presionando Shift+Ctrl+V(Windows) o Shift+Cmd+V(Mac).

Para verlos uno al lado del otro, arrastre la pestaña de vista previa al lado derecho del editor, o use Ctrl+K V(Windows) o Cmd+K V(Mac) en su lugar.

ingrese la descripción de la imagen aquí

VS Code utiliza la biblioteca marcada para el análisis y tiene habilitada la compatibilidad con Github Flavored Markdown por defecto, pero no mostrará el Github Emoji en línea como lo hace el editor de texto Atom de Github .

Además, VS Code soporta varios complementos de rebaja disponibles para una funcionalidad extendida.

Feckmore
fuente
Si está utilizando Visual Studio 2015, consulte mi respuesta a continuación.
bytedev
1
Nota: puede hacer clic con el botón derecho en el archivo Léame> abrir vista previa
Chris Halcrow
15

La extensión ' .md ' se refiere a los archivos Markdown .

Si no desea instalar una aplicación para leerlos en ese formato, simplemente puede usar TextEdit o Xcode para abrirlo en Mac.

En cualquier otro sistema operativo, debe poder abrirlo con cualquier editor de texto , aunque, como se esperaba, no lo verá en formato Markdown .

codeburn
fuente
44
En realidad, se va a ver en formato de rebajas. Sin embargo, no lo verá como negrita, cursiva, sangría y bloques de código.
Carreras de ligereza en órbita el
14

Sí, solo GitHub con sabor a Markdown . Incluir un archivo README en su repositorio ayudará a otros a determinar rápidamente de qué se trata y cómo instalarlo. Muy útil para incluir en tus repositorios.

esilvas
fuente
55
Voto negativo Por "uno" en "incluido uno en su repositorio" debe significar "un archivo README en cualquier formato", no solo "un archivo README.md". Pero la pregunta es acerca de los archivos ".md" en general, no sobre los README en general. Entonces esta respuesta es irrelevante para la pregunta. Además, la ambigüedad con “uno” podría hacer que un lector piense que los README de Markdown son necesariamente mejores que otros README, lo cual está mal.
Rory O'Kane
1
Hice el cambio especificado en el comentario anterior, porque tiene sentido y creo que podría ayudar a evitar confusiones. Sin embargo, no creo que esta sea una muy buena respuesta, ya que no agrega nada nuevo que sea relevante. Esta pregunta no se trata de README, se trata de la extensión .md. No hay razón para agregar esta respuesta seis semanas después de que la respuesta aceptada proporcionó la misma información.
Erick Robertson
5

Stack Edit es un editor de rebajas en línea con la capacidad de guardar en Google Drive y DropBox.

Philip
fuente
5

Markdown es solo un archivo de texto que opcionalmente tiene .md, o .markdownextensiones. Se puede convertir a HTML. Para conocer la sintaxis de Markdown, consulte

Markit con sabor a GitHub .

Puede usar cualquier editor de texto para rebajas. Si es sublime textusuario, puede consultar el Markdown Previewcomplemento que mostrará el contenido de rebajas procesado en el navegador y las actualizaciones cada vez que cambie el archivo de rebajas.

Algunos de los editores de rebajas en línea

Fizer Khan
fuente
3

Sugiero StackEdit . Es simple editor WISIWIG. Puede usar la sintaxis de editor y markdown. Hay una sintaxis de ayuda de reducción rápida allí. Deshacer / rehacer, comentarios, GoogleDrive, interconexión de Dropbox.

Romeno
fuente
2

markable.in es una herramienta en línea muy agradable para editar la sintaxis de Markdown

usuario1337432
fuente
2

Si está creando archivos .md para sus soluciones .NET, le recomiendo la extensión Visual Studio 2015 Markdown Editor, ya que tiene un panel de vista previa para que pueda ver sus cambios en tiempo real.

EDITAR : Esto también debería funcionar ahora con Visual Studio 2017.

bytedev
fuente
0

Lo más fácil de hacer, si no tiene un lector, es abrir el archivo MD con un editor de texto y luego escribir el archivo MD como un archivo HTML y luego hacer doble clic para verlo con el navegador.

richardwendrock
fuente
Esto solo funcionará si tiene un complemento que lee archivos .md.
Brad Bruce el
0

El .md significa Markdown Text. Básicamente, es solo otro tipo de archivo de texto, como .txt

Yo uso Notepad ++ para leer y editar estos

NocFenix
fuente