GitScrum
Probar gratis

Guía de Markdown

GitScrum Studio soporta formato Markdown en descripciones de tareas, comentarios, páginas wiki y documentación. Esta guía cubre toda la sintaxis soportada con ejemplos.

Por Qué Markdown

Markdown te permite escribir contenido formateado sin dejar tu teclado. Sin botones que hacer clic, sin menús que navegar. Solo escribe la sintaxis y ve el resultado.

Los desarrolladores ya usan Markdown en READMEs, documentación y rastreadores de issues. GitScrum usa la misma sintaxis que conoces de GitHub.

Formato Básico

Encabezados

Crea encabezados con símbolos #:

# Encabezado 1
## Encabezado 2
### Encabezado 3
#### Encabezado 4

Énfasis

*cursiva* o _cursiva_
**negrita** o __negrita__
***negrita cursiva*** o ___negrita cursiva___
~~tachado~~

Saltos de Línea

Termina una línea con dos espacios para un salto suave. O usa una línea vacía para un salto de párrafo.

Listas

Listas Desordenadas

- Elemento uno
- Elemento dos
  - Elemento anidado
  - Otro anidado
- Elemento tres

Listas Ordenadas

1. Primer elemento
2. Segundo elemento
   1. Numerado anidado
   2. Otro anidado
3. Tercer elemento

Listas de Tareas

- [ ] Tarea sin completar
- [x] Tarea completada
- [ ] Otra tarea pendiente

Enlaces e Imágenes

Enlaces

[Texto del enlace](https://ejemplo.com)
[Enlace con título](https://ejemplo.com "Título al pasar")

Imágenes

![Texto alternativo](url-imagen.png)
![Texto alternativo](url-imagen.png "Título de imagen")

Enlaces de Referencia

[Texto del enlace][referencia]

[referencia]: https://ejemplo.com

Código

Código en Línea

Usa acentos graves para código en línea: const x = 42;

Bloques de Código

Usa triple acento grave con lenguaje opcional:

function hola(nombre) {
  return `¡Hola, ${nombre}!`;
}

Lenguajes soportados para resaltado de sintaxis:

  • javascript, typescript, jsx, tsx
  • python, ruby, php
  • html, css, scss
  • json, yaml, markdown
  • bash, shell
  • sql
  • go, rust, java, c, cpp

Citas

> Esta es una cita
> que abarca múltiples líneas

> Citas anidadas
>> Segundo nivel
>>> Tercer nivel

Tablas

| Encabezado 1 | Encabezado 2 | Encabezado 3 |
|--------------|--------------|--------------|
| Celda 1      | Celda 2      | Celda 3      |
| Celda 4      | Celda 5      | Celda 6      |

Alineación:

| Izquierda | Centro | Derecha |
|:----------|:------:|--------:|
| I         |   C    |       D |

Líneas Horizontales

Usa tres o más guiones, asteriscos o guiones bajos:

---
***
___

Funcionalidades Especiales

Menciones

Menciona miembros del equipo con @:

@juanperez por favor revisa esto

Referencias de Tareas

Enlaza a tareas con #:

Relacionado con #123
Bloquea #456

Etiquetas

Referencia etiquetas con ~:

Añadir etiqueta ~bug
Etiquetado como ~prioridad:alta

Escapar Caracteres

Usa barra invertida para mostrar caracteres literales:

\*no cursiva\*
\# no es un encabezado
\[no es un enlace\]

Teclas de Teclado

Mostrar atajos de teclado:

Presiona <kbd>Cmd</kbd> + <kbd>K</kbd> para buscar

Mejores Prácticas

Descripciones de Tareas

  • Comienza con una oración de resumen clara
  • Usa encabezados para organizar secciones
  • Incluye bloques de código para detalles técnicos
  • Añade listas de tareas para criterios de aceptación

Páginas Wiki

  • Usa encabezados descriptivos para navegación
  • Incluye tabla de contenidos para páginas largas
  • Enlaza a páginas relacionadas
  • Actualiza la fecha de modificación

Comentarios

  • Mantenlo conciso
  • Cita contexto relevante
  • Usa bloques de código para logs/errores
  • Menciona personas que necesitan verlo

Errores Comunes

Sin espacio después de #

❌ #Encabezado
✅ # Encabezado

Listas anidadas rotas

❌ 
- Elemento
 - Anidado (solo 1 espacio)

✅ 
- Elemento
  - Anidado (2 espacios)

Bloques de código sin cerrar Siempre usa triple acento grave coincidente.

Modo Vista Previa

La mayoría de campos de texto en GitScrum muestran una vista previa mientras escribes. Alterna entre modos de edición y vista previa para ver el resultado final antes de guardar.

Cómo Reportar un Problema o Solicitar una Funcionalidad

Si el markdown no se renderiza correctamente o necesitas soporte de sintaxis adicional, envía comentarios a través de GitScrum Studio. En la Barra Lateral, haz clic en Tickets de Soporte y abre un ticket.

← Previous Next →