Headings
Para crear un encabezado, agregue uno a seis # símbolos antes del texto del encabezado. El número de # uso determinará el nivel de jerarquía y el tamaño del tipo de letra del encabezado.
# A first-level heading
## A second-level heading
### A third-level heading
Al usar dos o más encabezados, GitHub genera automáticamente una tabla de contenido a la que puede acceder haciendo clic en el icono de menú "Esquema" dentro del encabezado de archivo. Cada título de título aparece en la tabla de contenido y puede hacer clic en un título para ir a la sección seleccionada.
Aplicar estilo al texto
Puede indicar énfasis con negrita, cursiva, tachado, subíndice o texto de superíndice en los campos y .md archivos de comentario.
| Style | Syntax | Atajo de teclado | Example | Salida |
|---|---|---|---|---|
| Bold |
`** **` o `__ __`|
<kbd>Command</kbd>+<kbd>B</kbd> (Mac) o <kbd>Ctrl</kbd>+<kbd>B</kbd> (Windows/Linux) | `**This is bold text**` |
**Este es texto en negrita** |
| Itálico |
* * o _ _ |
Command+I (Mac) o Ctrl+I (Windows/Linux) | _This text is italicized_ |
Este texto está en cursiva |
| Tachado |
~~ ~~ o ~ ~ | Ninguno | ~~This was mistaken text~~ |
Se equivocó el texto |
| Negrita y cursiva anidada |
** ** y _ _ | Ninguno | **This text is _extremely_ important** |
Este texto es extremadamente importante |
| Todo en negrita y cursiva | *** *** | Ninguno | ***All this text is important*** |
Todo este texto es importante |
| Subíndice | <sub> </sub> | Ninguno | This is a <sub>subscript</sub> text | Este es un texto de subíndice |
| Superíndice | <sup> </sup> | Ninguno | This is a <sup>superscript</sup> text | Se trata de un texto superíndice |
| Subrayado | <ins> </ins> | Ninguno | This is an <ins>underlined</ins> text | Se trata de un texto subrayado |
Texto citado
Puede entrecomillar texto con .>
Text that is not a quote
> Text that is a quote
El texto citado se indenta con una línea vertical a la izquierda y se muestra en color gris.
Nota:
Al ver una conversación, puede citar automáticamente texto en un comentario resaltando el texto y escribiendo R. Para citar un comentario completo, haga clic en y, a continuación, respuesta de comillas. Para obtener más información sobre los métodos abreviados de teclado, vea Atajos de teclado.
Citar código
Puede destacar código o comandos dentro de una oración con comillas invertidas simples. No se dará formato al texto dentro de las comillas invertidas. También puede presionar el Command+E (Mac) o Ctrl+E (Windows/Linux) para insertar los retrocesos de un bloque de código dentro de una línea de Markdown.
Use `git status` to list all new or modified files that haven't yet been committed.
Para dar formato al código o al texto en su propio bloque diferenciado, use tres comillas invertidas.
Some basic Git commands are:
```
git status
git add
git commit
```
Para más información, consulta Crear y resaltar bloques de código.
Si editas fragmentos de código y tablas con frecuencia, puedes beneficiarte de habilitar una fuente de ancho fijo en todos los campos de comentarios de GitHub. Para más información, consulta Acerca de la escritura y el formato en GitHub.
Modelos de color admitidos
En los temas, solicitudes de incorporación de cambios y discusiones, pueden destacar colores dentro de una oración utilizando comillas invertidas. Un modelo de color admitido entre comillas invertidas mostrará una visualización del color.
The background color is `#ffffff` for light mode and `#000000` for dark mode.
Estos son los modelos de color admitidos actualmente.
| Color | Syntax | Example | Salida |
|---|---|---|---|
| HEX or Hexadecimal | `#RRGGBB` | `#0969DA` |  |
| RGB | `rgb(R,G,B)` | `rgb(9, 105, 218)` |  |
| HSL | `hsl(H,S,L)` | `hsl(212, 92%, 45%)` |  |
Nota:
- Un modelo de color admitido no puede tener espacios iniciales o finales dentro de las comillas invertidas.
- La visualización del color solo se admite en incidencias, pull requests y discusiones.
Enlaces
Puede crear un vínculo insertado ajustando el texto del vínculo entre corchetes [ ]y ajustando la dirección URL entre paréntesis ( ). También puede usar el método abreviado de teclado Comando+K para crear un vínculo. Cuando haya seleccionado texto, puede pegar una dirección URL del Portapapeles para crear automáticamente un vínculo a partir de la selección.
También puede crear un hipervínculo de Markdown resaltando el texto y usando el método abreviado de teclado Command+V. Si desea reemplazar el texto por el vínculo, use el método abreviado de teclado Command+Shift+V.
This site was built using [GitHub Pages](https://pages.github.com/).
Nota:
GitHub crea automáticamente vínculos cuando las direcciones URL válidas se escriben en un comentario. Para más información, consulta Referencias y direcciones URL autovinculadas.
Vínculos de sección
Puede vincular directamente a cualquier sección que tenga un encabezado. Para ver el delimitador generado automáticamente en un archivo representado, mantenga el puntero sobre el encabezado de sección para exponer el icono de y haga clic en el icono para mostrar el delimitador en el explorador.
Si necesita determinar el delimitador de un encabezado en un archivo que está editando, puede usar las siguientes reglas básicas:
- Las letras se convierten en minúsculas.
- Los espacios se reemplazan por guiones (
-). Se quitan cualquier otro espacio en blanco o caracteres de puntuación. - Se quitan los espacios en blanco iniciales y finales.
- Se quita el formato de marcado, dejando solo el contenido (por ejemplo,
_italics_se convierte enitalics). - Si el delimitador generado automáticamente para un encabezado es idéntico a un delimitador anterior en el mismo documento, se genera un identificador único anexando un guión y un entero de incremento automático.
Para obtener información más detallada sobre los requisitos de fragmentos de URI, consulte RFC 3986: Identificador uniforme de recursos (URI): Sintaxis genérica, sección 3.5.
El bloque de código siguiente muestra las reglas básicas que se usan para generar anclajes a partir de encabezados en contenido representado.
# Example headings
## Sample Section
## This'll be a _Helpful_ Section About the Greek Letter Θ!
A heading containing characters not allowed in fragments, UTF-8 characters, two consecutive spaces between the first and second words, and formatting.
## This heading is not unique in the file
TEXT 1
## This heading is not unique in the file
TEXT 2
# Links to the example headings above
Link to the sample section: [Link Text](#sample-section).
Link to the helpful section: [Link Text](#thisll-be-a-helpful-section-about-the-greek-letter-Θ).
Link to the first non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file).
Link to the second non-unique section: [Link Text](#this-heading-is-not-unique-in-the-file-1).
Nota:
Si edita un encabezado o cambia el orden de los encabezados con anclajes "idénticos", también deberá actualizar los vínculos a esos encabezados, ya que los delimitadores cambiarán.
Vínculos 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 tiene un archivo Léame en la raíz del repositorio y tiene otro archivo en docs/CONTRIBUTING.md, el vínculo relativo a CONTRIBUTING.md en el archivo Léame podría tener este aspecto:
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub 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 de acceso del vínculo será relativa al archivo actual. Los vínculos que comienzan por / serán relativos a la raíz del repositorio. Puede usar todos los operandos de vínculo relativos, como ./ y ../.
El texto del vínculo debe estar en una sola línea. El ejemplo siguiente no funcionará.
[Contribution
guidelines for this project](docs/CONTRIBUTING.md)
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.
Anclajes personalizados
Puede usar etiquetas de anclaje HTML estándar (<a name="unique-anchor-name"></a>) para crear puntos de anclaje de navegación para cualquier ubicación del documento. Para evitar referencias ambiguas, use un esquema de nomenclatura único para etiquetas de anclaje, como agregar un prefijo al valor del name atributo.
Nota:
Los delimitadores personalizados no se incluirán en el esquema o tabla de contenido del documento.
Puede vincular a un delimitador personalizado mediante el valor del name atributo que proporcionó el delimitador. La sintaxis es exactamente la misma que cuando enlaza a un ancla que se genera automáticamente para un encabezado.
Por ejemplo:
# Section Heading
Some body text of this section.
<a name="my-custom-anchor-point"></a>
Some text I want to provide a direct link to, but which doesn't have its own heading.
(… more content…)
[A link to that custom anchor](#my-custom-anchor-point)
Sugerencia
Las anclas personalizadas no son consideradas por el comportamiento de nomenclatura y numeración automática de los vínculos de encabezado.
Saltos de línea
Si está escribiendo problemas, solicitudes de incorporación de cambios o discusiones en un repositorio, GitHub representará automáticamente un salto de línea:
This example
Will span two lines
Sin embargo, si está escribiendo en un archivo .md, el ejemplo anterior se mostraría en una única línea sin un fin de línea. Para crear un salto de línea en un archivo .md, deberá incluir uno de los siguientes elementos:
-
Incluya dos espacios al final de la primera línea.
This example Will span two lines
-
Incluya una barra diagonal inversa al final de la primera línea.
This example\ Will span two lines -
Incluya una etiqueta de salto de una sola línea HTML al final de la primera línea.
This example<br/> Will span two lines
Si deja una línea en blanco entre dos líneas, tanto en los archivos .md como en la sintaxis Markdown en incidencias, solicitudes de extracción y discusiones, las líneas se mostrarán separadas por la línea en blanco.
This example
Will have a blank line separating both lines
Imágenes
Puede mostrar una imagen agregando ! y ajuste del texto alternativo en [ ]. El texto alternativo es un texto corto equivalente a la información de la imagen. A continuación, ajuste el vínculo de la imagen entre paréntesis ().
GitHub admite la inserción de imágenes en sus problemas, solicitudes de incorporación de cambios, debates, comentarios y .md archivos. Puede mostrar una imagen desde el repositorio, agregar un vínculo a una imagen en línea o cargar una imagen. Para obtener más información, consulte Carga de recursos.
Nota:
Cuando desee mostrar una imagen que se encuentra en el repositorio, use vínculos relativos en lugar de vínculos absolutos.
Estos son algunos ejemplos para usar vínculos relativos para mostrar una imagen.
| Context | Vínculo relativo |
|---|---|
En un .md archivo de la misma rama | /assets/images/electrocat.png |
En un .md archivo de otra rama | /../main/assets/images/electrocat.png |
| En las incidencias, solicitudes de extracción y comentarios del repositorio | ../blob/main/assets/images/electrocat.png?raw=true |
En un .md archivo de otro repositorio | /../../../../github/docs/blob/main/assets/images/electrocat.png |
| En problemas, solicitudes de incorporación de cambios y comentarios de otro repositorio | ../../../github/docs/blob/main/assets/images/electrocat.png?raw=true |
Nota:
Los dos últimos vínculos relativos de la tabla anterior funcionarán para las imágenes de un repositorio privado solo si el visor tiene al menos acceso de lectura al repositorio privado que contiene estas imágenes.
Para obtener más información, vea Vínculos relativos.
Elemento Imagen
Se admite el <picture> elemento HTML.
Lists
Puede crear una lista sin ordenar si precede una o varias líneas de texto con -, *o +.
- George Washington
* John Adams
+ Thomas Jefferson
Para ordenar la lista, precede a cada línea con un número.
1. James Madison
2. James Monroe
3. John Quincy Adams
Listas anidadas
Puede crear una lista anidada al sangrar uno o varios elementos de lista para ubicarlos debajo de otro elemento.
Para crear una lista anidada mediante el editor web en GitHub o un editor de texto que use una fuente monoespacial, como Visual Studio Code, puede alinear la lista visualmente. Escriba caracteres de espacio delante del elemento de lista anidado hasta que el carácter de marcador de lista (- o *) se encuentra directamente debajo del primer carácter del texto del elemento encima de él.
1. First list item
- First nested list item
- Second nested list item
Nota:
En el editor basado en web, puede sangr o sangr una o varias líneas de texto resaltando primero las líneas deseadas y, a continuación, usando tabulación o tabulación mayús+ respectivamente.
Para crear una lista anidada en el editor de comentarios en GitHub, que no usa una fuente monoespacial, puede examinar el elemento de lista inmediatamente encima de la lista anidada y contar el número de caracteres que aparecen antes del contenido del elemento. A continuación, escriba ese número de caracteres de espacio delante del elemento de lista anidado.
En este ejemplo, podría agregar un elemento de lista anidado bajo el elemento 100. First list item de lista mediante la sangría del elemento de lista anidado como mínimo de cinco espacios, ya que hay cinco caracteres (100. ) antes First list itemde .
100. First list item
- First nested list item
Puede crear varios niveles de listas anidadas mediante el mismo método. Por ejemplo, dado que el primer elemento de lista anidado tiene siete caracteres (␣␣␣␣␣-␣) antes del contenido First nested list itemde la lista anidada, tendría que sangr el segundo elemento de lista anidado por al menos dos caracteres más (nueve espacios como mínimo).
100. First list item
- First nested list item
- Second nested list item
Para obtener más ejemplos, consulte el GitHub Especificación de Markdown con sabor.
Listas de tareas
Para crear una lista de tareas, debe añadir como prefijo un guion y espacio, seguido de [ ] a los elementos de la lista. Para marcar una tarea como completada, use [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 del elemento de lista de tareas comienza por un paréntesis, deberá escaparla con \:
- [ ] \(Optional) Open a followup issue
Para más información, consulta Acerca de las listas de tareas.
Mencionar personas y equipos
Puede mencionar a una persona o equipo en GitHub escribiendo @ más su nombre de usuario o nombre de equipo. Esto desencadenará una notificación y llamará su atención a la conversación. Las personas también recibirán una notificación si edita un comentario para mencionar su nombre de usuario o nombre de equipo. Para obtener más información sobre las notificaciones, consulta Acerca de las notificaciones.
Nota:
Una persona solo recibirá una notificación sobre una mención si la persona tiene acceso de lectura al repositorio y, si el repositorio es propiedad de una organización, la persona es miembro de la organización.
@github/support What do you think about these updates?
Cuando menciona un equipo principal, los miembros de sus equipos secundarios también reciben notificaciones, lo que simplifica la comunicación con varios grupos. Para más información, consulta Acerca de los equipos de la organización.
Al escribir un @ símbolo se mostrará una lista de personas o equipos en un proyecto. La lista se filtra a medida que escribe, de modo que, una vez que encuentre el nombre de la persona o equipo que busca, puede usar las teclas de flecha para seleccionarlo y presionar Tabulador o Enter para completar el nombre. En el caso de los equipos, escriba y @organization/team-name todos los miembros de ese equipo se suscribirán a la conversación.
Los resultados de autocompletado están restringidos a los colaboradores del repositorio y a cualquier otro participante del hilo.
Hacer referencia a problemas y solicitudes de incorporación de cambios
Puede mostrar una lista de problemas sugeridos y solicitudes de incorporación de cambios en el repositorio escribiendo #. Escriba el número o título del problema o solicitud de incorporación de cambios para filtrar la lista y, a continuación, presione la tecla de tabulación o Intro para completar el resultado seleccionado.
Para 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 más información, consulta Configurar enlaces automáticos para referenciar recursos externos.
Carga de recursos
Puede cargar recursos como imágenes arrastrando y colocando, seleccionando desde un explorador de archivos o pegando. Puede cargar recursos en problemas, solicitudes de incorporación de cambios, comentarios y .md archivos en el repositorio.
Uso de emojis
Puede agregar emoji a la escritura escribiendo :EMOJICODE:, dos puntos seguidos del nombre del emoji.
@octocat :+1: This PR looks great - it's ready to merge! :shipit:
Escritura : mostrará una lista de emojis sugeridos. La lista filtrará a medida que escriba, por lo que una vez que encuentre el emoji que busca, presione Tab o Entrar para completar el resultado resaltado.
Para obtener una lista completa de los códigos y emoji disponibles, consulta emoji-Cheat-Sheet.
Paragraphs
Puede crear un nuevo párrafo dejando una línea en blanco entre líneas de texto.
Footnotes
Puede agregar notas al pie al contenido mediante esta sintaxis de corchetes:
Here is a simple footnote[^1].
A footnote can also have multiple lines[^2].
[^1]: My reference.
[^2]: To add line breaks within a footnote, add 2 spaces to the end of a line.
This is a second line.
La nota al pie se representará de la siguiente manera:
Nota:
La posición de una nota al pie en Markdown no influye en dónde se mostrará la nota al pie. Puede escribir una nota al pie justo después de la referencia a dicha nota, y la nota al pie se seguirá mostrando en la parte inferior del documento Markdown. Las notas al pie no se admiten en wikis.
Alerts
**Las alertas**, también conocidas como **llamadas** o **admoniciones**, son una extensión de Markdown basada en la sintaxis blockquote que puede usar para resaltar la información crítica. En GitHub, se muestran con colores e iconos distintivos para indicar la importancia del contenido.
Use alertas solo cuando sean cruciales para el éxito del usuario y limite a uno o dos por artículo para evitar sobrecargar el lector. Además, debe evitar colocar alertas consecutivamente. Las alertas no se pueden anidar dentro de otros elementos.
Para agregar una alerta, use una línea blockquote especial que especifique el tipo de alerta, seguido de la información de alerta en un blockquote estándar. Hay cinco tipos de alertas disponibles:
> [!NOTE]
> Useful information that users should know, even when skimming content.
> [!TIP]
> Helpful advice for doing things better or more easily.
> [!IMPORTANT]
> Key information users need to know to achieve their goal.
> [!WARNING]
> Urgent info that needs immediate user attention to avoid problems.
> [!CAUTION]
> Advises about risks or negative outcomes of certain actions.
Estas son las alertas representadas:
Ocultar contenido con comentarios
Puede indicar a GitHub que oculten el contenido de Markdown representado colocando el contenido en un comentario HTML.
<!-- This content will not appear in the rendered Markdown -->
Omitir el formato de Markdown
Puede indicar a GitHub que omitan (o escape) formato Markdown mediante \ antes del carácter Markdown.
Let's rename \*our-new-project\* to \*our-old-project\*.
Para obtener más información sobre las barras diagonales inversas, vea Daring Fireball's Markdown Syntax( Sintaxis markdown de Daring Fireball).
Nota:
El formato Markdown no se omitirá en el título de un problema o una solicitud de incorporación de cambios.
Desactivar la renderización de Markdown
Cuando ves un archivo de lenguaje de marcado, puedes hacer clic en Código en la parte superior de este para inhabilitar la representación de lenguaje de marcado y ver en su lugar el código fuente del archivo.
El inhabilitar la interpretación de lenguaje de marcado te permite utilizar las características de vista de código fuente, tales como el enlazado de líneas, el cual no es posible cuando se está viendo un archivo interpretado en lenguaje de marcado.
Lectura adicional
-
[Especificación de GitHub Flavored Markdown](https://github.github.com/gfm/) -
[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/about-writing-and-formatting-on-github) -
[AUTOTITLE](/get-started/writing-on-github/working-with-advanced-formatting) -
[AUTOTITLE](/get-started/writing-on-github/getting-started-with-writing-and-formatting-on-github/quickstart-for-writing-on-github)