Clase 04 — GitHub Flavored Markdown (GFM)

GitHub extiende Markdown con funcionalidades extra conocidas como GitHub Flavored Markdown (GFM).

Alertas (GitHub Alerts)

> [!NOTE]
> Información útil que el usuario debería conocer.

> [!TIP]
> Consejo para hacer las cosas mejor o más fácil.

> [!IMPORTANT]
> Información clave que el usuario necesita saber.

> [!WARNING]
> Requiere atención inmediata del usuario.

> [!CAUTION]
> Riesgo potencial de pérdida de datos o problemas.

Equivalente en Docusaurus

En Docusaurus se usan admonitions:

:::note
Información útil.

tip

Un consejo.

aviso

Atención.

peligro

Peligro.

:::

## Autolinks

GitHub convierte automáticamente:

```markdown
<!-- Issues y PRs -->
#42
GH-42

<!-- Usuarios y organizaciones -->
@roxsross
@295devops

<!-- Commits -->
a1b2c3d

<!-- URLs -->
https://github.com

Emojis

<!-- Usando shortcodes -->
:rocket: :star: :fire: :tada: :bug: :wrench:
:white_check_mark: :x: :warning: :information_source:
:docker: :kubernetes:

<!-- O directamente con Unicode -->
🚀 ⭐ 🔥 🎉 🐛 🔧 ✅ ❌ ⚠️ ℹ️

Emojis comunes en commits y PRs

Emoji	Código	Uso
🚀	:rocket:	Deploy, release
🐛	:bug:	Bug fix
✨	:sparkles:	Nueva feature
🔧	:wrench:	Configuración
📝	:memo:	Documentación
♻️	:recycle:	Refactor
🔒	:lock:	Seguridad
⬆️	:arrow_up:	Upgrade dependencia
🗑️	:wastebasket:	Eliminar código
🎨	:art:	Estilo/formato

Diagramas Mermaid

GitHub renderiza diagramas Mermaid directamente:

```mermaid
graph LR
    A[Código] --> B[Build]
    B --> C[Test]
    C --> D[Deploy]
    D --> E[Producción]
```

graph LR
    A[Código] --> B[Build]
    B --> C[Test]
    C --> D[Deploy]
    D --> E[Producción]

Diagrama de secuencia

```mermaid
sequenceDiagram
    participant Dev as Developer
    participant GH as GitHub
    participant CI as CI/CD
    participant Prod as Production

    Dev->>GH: Push code
    GH->>CI: Trigger pipeline
    CI->>CI: Run tests
    CI->>CI: Build image
    CI->>Prod: Deploy
    Prod-->>Dev: Notification
```

Diagrama de flujo

```mermaid
flowchart TD
    A[Start] --> B{Tests pass?}
    B -->|Yes| C[Build Docker image]
    B -->|No| D[Fix tests]
    D --> A
    C --> E{Deploy to staging?}
    E -->|Yes| F[Deploy staging]
    F --> G{QA approved?}
    G -->|Yes| H[Deploy production]
    G -->|No| D
    E -->|No| I[End]
    H --> I
```

Menciones en PRs e Issues

## Pull Request

**Descripción:** Agrega endpoint de health check

**Tipo de cambio:**
- [x] Bug fix
- [ ] Nueva feature
- [x] Mejora de performance

**Checklist:**
- [x] Tests agregados
- [x] Documentación actualizada
- [ ] Revisado por @roxsross

**Issues relacionados:** Closes #42, Fixes #38

cc @295devops

Templates de Issues

---
name: Bug Report
about: Reportar un bug
labels: bug
---

## 🐛 Descripción del Bug

Descripción clara del problema.

## Pasos para Reproducir

1. Ir a '...'
2. Hacer clic en '...'
3. Ver el error

## Comportamiento Esperado

Qué debería pasar.

## Comportamiento Actual

Qué pasa realmente.

## Screenshots

Si aplica, agregá screenshots.

## Entorno

- OS: [ej: Ubuntu 22.04]
- Docker: [ej: 24.0.7]
- Node: [ej: 20.10.0]

Ejercicios

1. Creá un README que use al menos 3 tipos de alertas de GitHub
2. Creá un diagrama Mermaid que represente tu pipeline de CI/CD
3. Creá un template de Pull Request con checklist y menciones