Resumen de la sintaxis de Markdown en GitHub
Exploramos qué es Markdown y resumimos la sintaxis principal de Markdown según GitHub Flavored Markdown para el alojamiento de blogs en GitHub Pages.
Para utilizar GitHub Pages, es necesario conocer la sintaxis de Markdown. Este artículo se basa en los documentos oficiales de GitHub Mastering Markdown y Basic writing and formatting syntax.
1. ¿Qué es Markdown?
Markdown es un lenguaje de marcado ligero basado en texto plano. Se utiliza para escribir documentos con formato utilizando texto plano y se caracteriza por tener una sintaxis más fácil y simple que los lenguajes de marcado comunes. Se usa ampliamente en archivos README distribuidos con software y en publicaciones en línea porque se puede convertir fácilmente a documentos con formato como HTML y texto enriquecido (RTF).
John Gruber creó el lenguaje Markdown en el año 12004 del calendario holoceno en colaboración significativa con Aaron Swartz en términos de sintaxis, con el objetivo de permitir que las personas puedan escribir usando un formato de texto plano fácil de leer y escribir, y opcionalmente convertirlo en XHTML (o HTML) estructuralmente válido.
2. Sintaxis de Markdown
Como no hay un estándar establecido para Markdown, la sintaxis detallada puede variar ligeramente según dónde se use. La sintaxis de Markdown resumida aquí se basa en GitHub Flavored Markdown.
2.1. Saltos de línea y separación de párrafos
En Markdown, presionar la tecla Enter una vez no se reconoce como un salto de línea.
1
2
3
Primera oración.
Segunda oración.
Tercera oración.
Primera oración. Segunda oración. Tercera oración.
Los saltos de línea se aplican ingresando dos o más espacios consecutivos.
1
2
3
Primera oración.
Segunda oración.
Tercera oración.
Primera oración.
Segunda oración.
Tercera oración.
Los párrafos se separan con una línea en blanco (presionando Enter dos veces).
1
2
3
Un párrafo.
Otro párrafo.
Un párrafo.
Otro párrafo.
2.2. Encabezados
Hay un total de 6 niveles.
1
2
3
4
5
6
# This is an H1
## This is an H2
### This is an H3
#### This is an H4
##### This is an H5
###### This is an H6
En principio, la etiqueta H1 debe aparecer solo una vez por página, por lo que normalmente no se usa directamente al escribir publicaciones o documentos.
2.3. Énfasis
1
2
3
4
5
6
7
8
9
10
11
*This text is italicized*
_This is italicized too_
**This is bold text**
__This is bold text too__
~~This was mistaken text~~
_You **can** combine them_
***All this text is important***
This text is italicized
This is italicized too
This is bold text
This is bold text too
This was mistaken text
You can combine them
All this text is important
2.4. Citas de texto
Se utiliza >.
1
2
3
> This is a first blockquote.
>> This is a second blockquote.
>>> This is a third blockquote.
This is a first blockquote.
This is a second blockquote.
This is a third blockquote.
2.5. Citas de código
Se utiliza ``` o ~~~.
1
2
3
4
5
```
git status
git add
git commit
```
1
2
3
git status
git add
git commit
También se puede activar el resaltado de sintaxis especificando el lenguaje de programación.
1
2
3
4
5
```ruby
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
```
1
2
3
require 'redcarpet'
markdown = Redcarpet.new("Hello World!")
puts markdown.to_html
2.6. Enlaces
1
2
[GitHub Pages](https://pages.github.com/)
<https://pages.github.com/>
GitHub Pages
https://pages.github.com/
También se pueden usar enlaces de ruta relativa que apunten a otros archivos dentro del repositorio. El uso es el mismo que en la terminal.
1
[README](../README.md)
2.7. Listas no ordenadas
Se utiliza - o *.
1
2
3
- George Washington
- John Adams
- Thomas Jefferson
- George Washington
- John Adams
- Thomas Jefferson
2.8. Listas ordenadas
Se utilizan números.
1
2
3
1. James Madison
2. James Monroe
3. John Quincy Adams
- James Madison
- James Monroe
- John Quincy Adams
2.9. Listas anidadas
1
2
3
1. First list item
- First nested list item
- Second nested list item
- First list item
- First nested list item
- Second nested list item
- First nested list item
2.10. Listas de tareas
Para crear una lista de tareas, se agrega [ ] antes de cada elemento. Para marcar una tarea como completada, se usa [x].
1
2
3
- [x] Finish my changes
- [ ] Push my commits to GitHub
- [ ] Open a pull request
- Finish my changes
- Push my commits to GitHub
- Open a pull request
2.11. Inserción de imágenes
1
2
3
4
Método: {(opcional)opciones adicionales}
{: .align-center}
{: width="50%" height="50%"}
2.12. Creación de tablas
Se pueden crear tablas usando | y -. Debe dejarse una línea en blanco antes de la tabla para que se muestre correctamente. Se deben usar al menos tres - para que se reconozca correctamente.
1
2
3
4
5
| Left-aligned | Center-aligned | Right-aligned |
| :--- | :---: | ---: |
| git status | git status | git status |
| git diff | git diff | git diff |
| Left-aligned | Center-aligned | Right-aligned |
|---|---|---|
| git status | git status | git status |
| git diff | git diff | git diff |