Markdown Toolbox Logo Markdown Toolbox
Hogar
Blog

Hoja de trucos - Estilo Markdown de GitHub

2023-12-12

GitHub Flavored Markdown (GFM) extiende la sintaxis estándar de Markdown para incluir características adicionales específicas de GitHub. Esta hoja de trucos cubre aspectos clave de GFM, facilitando la creación de README, problemas y otra documentación en GitHub.

Sintaxis Extendida

Listas de Tareas

  • Crea listas de tareas con - [ ] para una tarea incompleta y - [x] para una tarea completada.

    -   [x] Tarea completada
    -   [ ] Tarea incompleta
    

Tachado

  • Usa dos virgulillas ~~ para tachar texto.

    ~~Tachado~~
    

Tablas

  • Crea tablas usando guiones - y barras |.

    | Encabezado 1 | Encabezado 2 |
    | -------- | -------- |
    | Fila 1    | Datos 1   |
    | Fila 2    | Datos 2   |
    

Bloques de Código Delimitados

  • Usa tres comillas simples (```) y especifica un lenguaje para el resaltado de sintaxis.

    ```javascript console.log("¡Hola, mundo!"); ```

Mención de Usuarios y Equipos

  • Usa @nombredeusuario para mencionar a un usuario o equipo.

Referencias a Problemas y Solicitudes de Extracción

  • Referencia problemas y solicitudes de extracción usando #.

Sintaxis Estándar de Markdown

Encabezados

  • Usa # para encabezados. Más #s significan encabezados más pequeños.

Formato de Texto

  • Negrita: **negrita**
  • Itálica: *itálica*
  • Negrita e Itálica: ***negrita & itálica***

Listas

  • Lista Desordenada: Comienza con -, +, o *.
  • Lista Ordenada: Comienza con números seguidos de ..

Enlaces e Imágenes

  • Enlace: [Título](URL)
  • Imagen: ![Texto alternativo](URL)

Blockquotes

  • Usa > para citas en bloque.

El Markdown de GitHub permite una documentación más interactiva y dinámica, especialmente útil en el contexto de proyectos colaborativos.