Hola, ¡bienvenidos a mi tutorial de markdown!
En este tutorial aprenderás los conceptos básicos sobre Markdown.
Tabla de contenidos
De acuerdo a Wikipedia:
Markdown es un lenguaje de marcado ligero creado por John Gruber que trata de conseguir la máxima legibilidad y facilidad de publicación tanto en su forma de entrada como de salida, inspirándose en muchas convenciones existentes para marcar mensajes de correo electrónico usando texto plano. Se distribuye bajo licencia BSD y se distribuye como un componente (o al menos está disponible) en diferentes sistemas de gestión de contenidos (CMS). Markdown convierte el texto marcado en documentos XHTML utilizando html2text creado por Aaron Swartz. Markdown fue implementado originariamente en Perl por Gruber, pero desde entonces se ha traducido a multitud de lenguajes de programación, incluyendo PHP, Python, Ruby, Java y Common Lisp.
SIMPLEMENTE: ES ÚNICAMENTE OTRO TIPO DE ARCHIVO DE TEXTO, COMO .txt, .doc, ... (en realidad es .md 😆 ) Y TIENE UNA SINTAXIS ESPECIAL.
No hay un estándar bien definido de Markdown. Esto ha provocado fragmentación, ya que varios fabricantes escriben sus propias versiones del lenguaje para corregir detalles o agregar características faltantes... Una lista de algunas versiones está disponible acá.
A partir de acá, esta guía de enfocará principalmente en la versión propia de Github.
Por que es:
- Super Fácil : La sintáxis es tan fácil que puedes aprenderla en un minuto o dos, después escribir sin darte cuenta de nada raro o complejo.
- RÁPIDO : Ahorra mucho tiempo comparado con otros tipos de archivos/formatos de texto. Ayuda a maximizar la productividad y los flujos de escritura.
- LIMPIO : Ambos, la sintaxis y la salida son limpios, nada ilegibles a nuestra vista y simples de manejar.
- FLEXIBLE : Con únicamente configuraciones simples, tu texto será traducido entre las plataformas que existan, editable en cualquier software de edición de textos y convertible a una amplia gama de formatos.
Brevemente, los usuarios normales lo encontrarán útil en cualquier caso, especialmente cuando necesitas algo mejor que el texto plano pero menos funcional que MS Word.
Para desarrolladores, si tienes pereza de escribir código HTML, amarás Markdown. Más aún, Github y muchos sitios favorecen markdown para archivos README en proyectos. Eso significa que necesitarás Markdown en tu vida de una manera u otra.
Como se dijo anteriormente, cualquier editor puede ser usado para escribir Markdon. De cualquier forma, hay algunas herramientas que pueden ser útiles a la hora de editar Markdown.
- Stackedit : De acuerdo, puedes dejar de leer ahora mismo. Da click al link y empieza a tu viaje a Markdown de la manera más fácil posible. Únicamente escribe texto normal y usa tu mouse, click click, hecho. Es bueno, pero te hará dependiente y muchos desarrolladores prefieren los teclados.
- Dillinger : Herramienta online, soporta vista previa en edición(pantalla dividida) y puedes exportar a HTML. Nada especial, pero muy bien hecho y útil.
- Typora : Disponible para Mac y Windows, minimalista, libre de distracciones, vista previa sin interrupciones, cargado con muchas características como imágenes, listas, tablas, bloques de código, bloques de expresiones matemáticas, YAML, texto preliminar, tablas de contenido..., etc.
- Atom : Editor muy popular y altamente configurable (tal vez lo estés usando), ¡Sí!, es versátil. ¿Soporte para markdown?, es una pequeña parte del editor, pero ya viene incluida.
- Minimalist Markdown : App de Chrome. Funciona en todos lados si tienes Chrome instalado (es mi favorita).
- Macdown : Lo mejor para Mac.
- MarkdownPad : Lo mejor para Windows.
- Remarkable : Lo mejor para Linux.
- GITBOOK : GitBook es una moderna caja de herramientas. Hace escribir y colaborar fácil. Soporta Markdown y está relacionado con nuestro querido Github.
Toda la sintaxis se puede encontrar acá . Cuestaun poco escribir sintaxis en texto (ya que será parseada y formateada), así que por favor considera esta tabla de abajo como la sintaxis básica de Markdown.
| Formato | Syntaxis | Ejemplo |
|---|---|---|
| Itálica | *Texto* | Esto es itálica |
| Negritas | **Negritas** | Esto es negritas |
| Links inline | [Descripción del texto](url acá) | Un link |
| Imágenes |  | Una imagen  |
| Link + imágenes | [](url a una página)] | Haz |
| Pies de página | Tengo más [^1] que decir. [^1]: dilo acá. | Oye, por favor lee esta nota debajo de esta tabla. |
| Salto de línea | Doble espacio + enter | |
| Listas no ordenadas | * Item1 *Item 2 |
|
| Listas ordenadas | 1. Item a 2. Item b |
|
| Listas combinadas | 1. Item 1 * item 1a |
|
| Cita | > Texto citado | Mantente insatisfecho, mantente humilde. |
| Pre formato | Empieza cada línea con, dos espacios o más para, hacer el texto verse, e x a c t a m e e n t e, como, tú, lo escr.i.b.e.s. | |
| Código | `Inserta código` | cout<<"Hello world"; |
| Bloque de código/ Realtado de sintaxis | ```inserta código``` | Oye, por favor lee la nota debajo de esta tabla. |
| Encabezados | #, ##, ###, ####, #####, ###### (desde h1 a h6) | |
| Texto tachado | ~ |
|
| Tablas | | Las tablas | son | geniales | |----------|:-------------:|------:| | col 1 es| alineada a la izquierda | $1600 | |  |
Nota: **Nota al pie** de hecho, no se ve correctamente en una tabla (y en vista previa de Github).
Pero es parecida [a](http://i.imgur.com/pmeBr28.png)
Lo mismo va para **bloques de código/resaltado de sintaxis**.
Se ve como .
Estas características dependen de cada versión de markdown.
- Markdown permite usar diagonal invertida para generar caracteres que de otra forma serían reconocidos por la sintaxis especial. Un caracter muy usado comúnmente como escape es \
Luego, \*ESTO\* no es itálica, sin embargo está precedido literalmente por asteriscos. - Los videos de Youtube requieren un poco más de trabajo adicional.
No pueden ser agregados diretamente, sin embargo, puedes agregar una imágen con un link al video de la siguiente manera:
<a href="http://www.youtube.com/watch?feature=player_embedded&v=YOUTUBE_VIDEO_ID_HERE
" target="_blank"><img src="http://img.youtube.com/vi/YOUTUBE_VIDEO_ID_HERE/0.jpg"
alt="IMAGE ALT TEXT HERE" width="240" height="180" border="10" /></a>
- Markdown soporta Emojis 😆 😆 😘 😇 💚 ( consulta algunos emojis acá )
- Puedes usar la etiqueta <br/> para forzar un salto de línea.
- Doble espacio y enter si quieres agregar una nueva línea.
- Ver no es tan bueno como practicar. Puedes crear un archivo markdown para que practiques o hacerlo online acá.
- Notas al pie y resaltado de sintaxis no son parte de la versión original de Markdown y solo son soportadas por ciertas versiones. (Retroalimentación de Sean Brody)
- Cualquier URL (como http://www.github.com/) será convertida en un link activo.
- El soporte a las tablas de Markdon está diseñado para soportar la mayoría de tablas para la mayoría de personas; no cubre todas las tablas para todas las personas. Si necesitas tablas más complejas necesitarás herramientas específicamente diseñadas para ello o escribirlas a mano.
Me costó demasiado hacer la tabla de arriba