Saltar al contenido principal

Clase 00 — Introducción a Markdown

¿Qué es Markdown?

Markdown es un lenguaje de marcado ligero creado por John Gruber en 2004. Permite escribir texto con formato usando una sintaxis simple que se convierte a HTML.

¿Por qué Markdown en DevOps?

  • Es el estándar en GitHub, GitLab, Bitbucket
  • Se usa en README, wikis, PRs, issues
  • Documentación de proyectos y APIs
  • Sitios estáticos (Docusaurus, MkDocs, Hugo)
  • Notas técnicas y runbooks

Encabezados

# Encabezado 1 (h1) — solo uno por documento
## Encabezado 2 (h2)
### Encabezado 3 (h3)
#### Encabezado 4 (h4)
##### Encabezado 5 (h5)
###### Encabezado 6 (h6)
Buena práctica

Usá solo un # h1 por documento (el título principal). Organizá el contenido con ## y ###.

Párrafos y saltos de línea

Este es un párrafo. Para crear otro párrafo,
dejá una línea en blanco entre ellos.

Este es otro párrafo.

Para un salto de línea dentro del mismo párrafo,
agregá dos espacios al final de la línea.

Líneas horizontales

---

***

___

Las tres opciones generan una línea horizontal. La más común es ---.

Texto preformateado

Para mostrar texto exactamente como lo escribís, usá comillas invertidas:

  • Inline: `texto`
  • Bloque: triple comilla invertida (```)
Ejecutá `docker ps` para ver los contenedores.

Resultado: Ejecutá docker ps para ver los contenedores.

Escapar caracteres

Si necesitás mostrar un carácter especial de Markdown literalmente, usá \:

\# Esto no es un encabezado
\*Esto no es cursiva\*
\- Esto no es una lista

Comentarios en Markdown

<!-- Esto es un comentario y no se renderiza -->

[//]: # (Esto también es un comentario)

Dónde se usa Markdown

PlataformaArchivos
GitHub/GitLabREADME.md, PRs, issues, wikis
Docker HubDescripción de imágenes
MkDocs/DocusaurusSitios de documentación
VS CodePreview con Cmd+Shift+V
Notion/ObsidianNotas y documentación
ConfluencePáginas (con extensiones)

Ejercicios

  1. Creá un archivo prueba.md con un título, 3 encabezados de nivel 2, y un párrafo en cada sección
  2. Abrí el preview en VS Code con Cmd+Shift+V (macOS) o Ctrl+Shift+V (Linux)
  3. Probá escapar caracteres especiales: #, *, -