Encabezados
Para crear un encabezado, agrega uno a seis símbolos # antes del encabezado del texto. La cantidad de # que utilices determinará el tamaño del encabezado.
# El encabezado más largo
## El segundo encabezado más largo
###### El encabezado más pequeño
Cuando usas dos o más encabezados, GitHub generará una tabla de contenido automáticamente, a la cual podrás acceder si haces clic en dentro del encabezado del archivo. Cada título de encabezado se lista en la tabla de contenido y puedes hacer clic en un título para navegar a la sección seleccionada.
Estilo de texto
Puedes indicar un énfasis con texto en negritas, itálicas, tachado, subíndice o superíndice en los campos de comentario y archivos .md.
| Estilo | Sintaxis | Atajo del teclado | Ejemplo | Resultado |
|---|---|---|---|---|
| Negrita | ** ** o __ __ | Command+B (Mac) o Ctrl+B (Windows/Linux) | **Este texto está en negrita** | Este texto está en negrita |
| Cursiva | * * o _ _ | Command+I (Mac) o Ctrl+I (Windows/Linux) | *Este texto está en cursiva* | Este texto está en cursiva |
| Tachado | ~~ ~~ | ~~Este texto está equivocado~~ | ||
| Cursiva en negrita y anidada | ** ** y _ _ | **Este texto es _extremadamente_ importante** | Este texto es extremadamente importante | |
| Todo en negrita y cursiva | *** *** | ***Todo este texto es importante*** | Todo este texto es importante | |
| Subíndice | <sub> </sub> | <sub>Este es un texto en subíndice</sub> | Este es un texto en subíndice | |
| Superíndice | <sup> </sup> | <sup>Este es un texto en superíndice</sup> | Este es un texto en superíndice |
Cita de texto
Puedes citar texto con un >.
Texto que no es una cita
> Texto que es una cita
Tip: Cuando ves una conversación, puedes citar texto automáticamente en un comentario si lo resaltas y luego tecleas R. Puedes citar un comentario completo al hacer clic en , y luego en Quote reply (Citar respuesta). Para obtener más información sobre atajo del teclado, consulta "Atajos del teclado".
Código de cita
Puedes indicar un código o un comando dentro de un enunciado con comillas simples. El texto dentro de las comillas simples no se formateará.
Usa `git status` para enumerar todos los archivos nuevos o modificados que aún no han sido confirmados.
Para formatear código o texto en su propio bloque distintivo, usa comillas triples.
Algunos de los comandos de Git básicos son: ``` git status git add git commit ```
Para obtener más información, consulta "Crear y resaltar bloques de código".
Enlaces
Puedes crear un enlace en línea al encerrar el texto del enlace entre corchetes [ ], y luego encerrar la URL entre paréntesis ( ).
Este sitio se construyó usando [GitHub Pages](https://pages.github.com/).
Sugerencias: GitHub Enterprise Server automáticamente crea enlaces cuando las direcciones URL válidas están escritas en un comentario. Para obtener más información, consulta "Referencias y direcciones URL autovinculadas".
Enlaces de sección
Puedes vincular directamente a una sección en un archivo expedido si deslizas el puntero sobre el encabezado de la sección para exponer el enlace:
Enlaces relativos
Puedes definir enlaces relativos y rutas de imagen en los archivos representados para ayudar a que los lectores naveguen hasta otros archivos de tu repositorio.
Un enlace relativo es un enlace que es relativo al archivo actual. Por ejemplo, si tienes un archivo README en la raíz de tu repositorio y tienes otro archivo en docs/CONTRIBUTING.md, el enlace relativo a CONTRIBUTING.md en tu archivo README podría verse así:
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub Enterprise Server transformará de manera automática el enlace relativo o la ruta de imagen en cualquier rama en la que te encuentres actualmente, de modo que el enlace o ruta siempre funcione. La ruta del enlace será relativa al archivo actual. Los enlaces que comienzan con / serán relativos a la raíz del repositorio. Puedes usar todos los operandos del enlace relativo, como ./ y ../.
Los enlaces relativos son más sencillos para los usuarios que clonan tu repositorio. Puede que los enlaces absolutos no funcionen en los clones de tu repositorio. Recomendamos usar enlaces relativos para consultar los archivos dentro de tu repositorio.
Imágenes
Puedes mostrar una imagen si agregas ! y pones el texto alternativo entre [ ]. Entonces encierra el enlace de la imagen entre paréntesis ().
GitHub Enterprise Server es compatible con incrustar imágenes en tus propuestas, solicitudes de cambio, comentarios y archivos .md. Puedes mostrar una imagen desde tu repositorio, agregar un enlace a una imagen en línea o cargar una imagen. Para obtener más información, consulta la sección "Cargar activos".
Tip: Cuando quieras mostrar una imagen que esté en tu repositorio, deberías utilizar enlaces relativos en vez de absolutos.
Aquí tienes algunos ejemplos para utilizar enlaces relativos para mostrar una imagen.
| Contexto | Enlace Relativo |
|---|---|
En un archivo .md en la misma rama | /assets/images/electrocat.png |
En un archivo .md en otra rama | /../main/assets/images/electrocat.png |
| En propuestas, solicitudes de cambio y comentarios del repositorio | ../blob/main/assets/images/electrocat.png?raw=true |
En un archivo .md en otro repositorio | /../../../../github/docs/blob/main/assets/images/electrocat.png |
| En propuestas, solicitudes de cambios y comentarios de otro repositorio | ../../../github/docs/blob/main/assets/images/electrocat.png?raw=true |
Nota: Los últimos dos enlaces relativos en la tabla anterior funcionarán únicamente para las imágenes en repositorios privados solo si el lector tiene por lo menos acceso de lectura a este.
Para obtener más información, consulta la sección "Enlaces relativos".
Listas
Puedes realizar una lista desordenada al anteceder una o más líneas de texto con - o *.
- George Washington
- John Adams
- Thomas Jefferson
Para ordenar tu lista, antecede cada línea con un número.
1. James Madison
2. James Monroe
3. John Quincy Adams
Listas anidadas
Puedes crear una lista anidada al dejar sangría en uno o más elementos de la lista debajo de otro elemento.
Para crear una lista anidada mediante el editor web en GitHub Enterprise Server o un editor de texto que usa una fuente monoespaciada, como Atom, puedes alinear tu lista visualmente. Escribe los caracteres con espacio frente a tu elemento de la lista anidada hasta que el carácter del marcador de lista (- or *) se encuentre directamente debajo del primer carácter del texto en el elemento que se encuentra por debajo.
1. Primer elemento de la lista
- Primer elemento de la lista anidado
- Segundo elemento de la lista anidado
Nota: En el editor basado en web, puedes poner o quitar la sangría de una o más líneas de texto si primero las resaltas y luego presionas Tab o Shift+Tab según corresponda.
Para crear una lista anidada en el editor de comentarios en GitHub Enterprise Server, que no usa una fuente monoespaciada, puedes observar el elemento de la lista inmediatamente anterior a la lista anidada y contar el número de caracteres que aparecen antes del contenido del elemento. Luego escribe ese número de caracteres de espacio frente al elemento de la lista anidada.
En este ejemplo, puedes agregar un elemento de la lista anidada debajo del elemento de la lista 100. Primer elemento de la lista con una sangría mínima de cinco espacios para el elemento de la lista anidada, dado que hay cinco caracteres (100.) antes del Primer elemento de la lista.
100. Primer elemento de la lista
- Primer elemento de la lista anidada
Puedes crear múltiples niveles de listas anidadas mediante el mismo método. Por ejemplo, ya que el primer elemento de la lista anidada tiene siete caracteres (␣␣␣␣␣-␣) antes del contenido First nested list item de la misma, necesitarás colocar sangría de siete espacios en el segundo elemento de esta.
100. Primer elemento de la lista
- Primer elemento de la lista anidada
- Segundo elemento de la lista anidada
Para conocer más ejemplos, consulta las Especificaciones de formato Markdown de GitHub.
Listas de tareas
Para crear una lista de tareas, lista los elementos por prefacio con un guion y espacio, seguido de [ ]. Para marcar una tarea como completada, utiliza [x].
- [x] #739
- [ ] https://github.com/octo-org/octo-repo/issues/740
- [ ] Add delight to the experience when all tasks are complete :tada:
Si una descripción de elementos de lista comienza con un paréntesis, necesitarás escaparla con \:
- [ ] \(Optional) Abre una propuesta de seguimiento
Para obtener más información, consulta "Acerca de las listas de tareas".
Mencionar personas y equipos
Puedes mencionar a una persona o equipo en GitHub Enterprise Server al escribir @ más el nombre de usuario o el nombre del equipo. Esto activará una notificación y llamará su atención hacia la conversación. Las personas también recibirán una notificación si editas un comentario para mencionar su nombre de usuario o el nombre del equipo. Para obtener más información sobre las notificaciones, consulta la sección "Acerca de las notificaciones".
Nota: Solo se le puede notificar a una persona sobre una mención si esta tiene acceso de lectura en el repositorio y si dicho repositorio le pertenece a una organización de la cuál esta persona sea miembro.
@github/support ¿Qué piensas sobre estas actualizaciones?
Cuando mencionas a un equipo padre, los miembros de los equipos hijo también reciben notificaciones, simplificando la comunicación con múltiples grupos de personas. Para obtener más información, consulta "Acerca de los equipos".
Si escribes un símbolo @ aparecerá una lista de personas o equipos en el proyecto. La lista filtra a medida que escribes, por lo que una vez que escribes el nombre de la persona o del equipo que estás buscando, puedes usar las teclas de flecha para seleccionarlos y presionar cada pestaña para ingresar para completar el nombre. En el caso de los equipos, escribe el nombre de la @organización/equipo y todos los miembros del equipo que se suscribirán a la conversación.
Los resultados autocompletados se restringen a los colaboradores del repositorio y a otros participantes en el hilo.
Hacer referencia a propuestas y solicitudes de extracción
Puedes mencionar una lista de las propuestas y las solicitudes de extracción sugeridas dentro del repositorio al escribir #. Escribe el número o el título de la propuesta o la solicitud de extracción para filtrar la lista, y luego presiona cada pestaña o ingresa para completar el resultado resaltado.
Para obtener más información, consulta "Referencias y direcciones URL autovinculadas".
Hacer referencia a recursos externos
Si se configuran las referencias autovinculadas personalizadas para un repositorio, entonces las referencias a recursos externos, como un informe de problemas de JIRA o un ticket de Zendesk, se convertirán en vínculos acortados. Para saber qué autovínculos se encuentran disponibles en tu repositorio, contacta a alguien con permisos administrativos sobre el mismo. Para obtener más información, consulta la sección "Configurar autovínculos para referenciar recursos externos".
Adjuntos de contenido
Algunas GitHub Apps proporcionan información en GitHub Enterprise Server para las URL que enlazan a sus dominios registrados. GitHub Enterprise Server presenta la información suministrada por la app debajo de la URL en el cuerpo o comentario de una propuesta o solicitud de extracción.
Para ver los adjuntos de contenido, debes tener una GitHub App que use la API de los adjuntos de contenido instalada en el repositorio.
Los adjuntos de contenido no se mostrarán para las URL que son parte de un enlace de Markdown.
Para obtener más información sobre el desarrollo de una GitHub App que usa adjuntos de contenido, consulta la sección "Usar adjuntos de contenido".
Cargar activos
Puedes cargar activos como imágenes si las arrastras y sueltas, las seleccionas de un buscador de archivos o si las pegas. Puedes cargar activos a las propuestas, solicitudes de cambios, comentarios y archivos .md en tu repositorio.
Usar emojis
Puedes agregar emojis a tu escritura al escribir :EMOJICODE:.
@octocat :+1: This PR looks great - it's ready to merge! :shipit:
Si escribes : aparecerá una lista con los emojis sugeridos. La lista filtrará a medida que escribes; por lo tanto, una vez que encuentres el emoji que estás buscando, presiona Tab (Tabulador) o Enter (Intro) para completar el resultado resaltado.
Para encontrar una lista completa de emojis y códigos disponibles, consulta el listado de emojis.
Párrafos
Puedes crear un nuevo párrafo al dejar una línea en blanco entre las líneas de texto.
Ocultar el contenido con comentarios
Puedes decirle a GitHub Enterprise Server que oculte el contenido del lenguaje de marcado interpretado colocando el contenido en un comentario de HTML.
<!-- This content will not appear in the rendered Markdown -->
Importar formato de Markdown
Puedes pedirle a GitHub Enterprise Server que ignore (o escape) el formato de lenguaje de marcado si utilizas \ antes del carácter de lenguaje de marcado.
Cambiemos el nombre de \*our-new-project\* a \*our-old-project\*.
Para obtener más información, consulta "Sintaxis de Markdown" de Daring Fireball,