encabezados

para crear un encabezado, agregue uno a seis símbolos # antes del texto del encabezado. El número de # que utilice determinará el tamaño del encabezado.

# The largest heading## The second largest heading###### The smallest heading

Styling text

puede indicar énfasis con texto en negrita, cursiva o Tachado.

citar texto

puede citar texto con un >.,

In the words of Abraham Lincoln:> Pardon my French

sugerencia: al ver una conversación, puede citar automáticamente el texto en un comentario resaltando el texto y luego escribiendo r. Puede citar un comentario completo haciendo clic, luego citar respuesta. Para obtener más información sobre los métodos abreviados de teclado, consulte » Métodos abreviados de teclado.»

citar código

Puede llamar código o un comando dentro de una oración con una sola barra invertida. El texto dentro de los backsticks no será formateado.,

Use `git status` to list all new or modified files that haven't yet been committed.

para formatear el código o el texto en su propio bloque distinto, use barras de retroceso triples.

Some basic Git commands are:```git statusgit addgit commit```

Para obtener más información, consulte «Creación y destacando los bloques de código.»

enlaces

Puede crear un enlace en línea envolviendo el texto del enlace entre paréntesis , y luego envolviendo la URL entre paréntesis ( ). También puede utilizar el atajo de teclado command + k para crear un enlace.,

This site was built using (https://pages.github.com/).

Sugerencia: GitHub crea automáticamente enlaces válidos cuando las Url escritas en un comentario. Para obtener más información, consulte » autolinked references and URLS.»

enlaces de sección

Puede enlazar directamente a una sección en un archivo renderizado al pasar el cursor sobre el encabezado de la sección para exponer el enlace:

enlaces relativos

puede definir enlaces relativos y rutas de imagen en sus archivos renderizados para ayudar a los lectores a navegar a otros archivos en su repositorio.,

un enlace relativo es un enlace relativo al archivo actual. Por ejemplo, si tiene un archivo README en la raíz de su repositorio y tiene otro archivo en docs / CONTRIBUTING. md, el enlace relativo a CONTRIBUTING.md en su README podría verse así:

(docs/CONTRIBUTING.md)

GitHub transformará automáticamente su enlace relativo o ruta de la imagen en función de cualquier rama en la que se encuentre actualmente, de modo que el enlace o ruta siempre funcione. Puede usar todos los operandos de enlace relativos, como ./y ../.,

los enlaces relativos son más fáciles para los usuarios que clonan su repositorio. Los enlaces absolutos pueden no funcionar en clones de su repositorio-recomendamos usar enlaces relativos para referirse a otros archivos dentro de su repositorio.

listas

puede crear una lista desordenada precediendo una o más líneas de texto con-o*.

- George Washington- John Adams- Thomas Jefferson

para ordenar su lista, preceda cada línea con un número.,

1. James Madison2. James Monroe3. John Quincy Adams

listas anidadas

puede crear una lista anidada sangrando uno o más elementos de la lista debajo de otro elemento.

para crear una lista anidada usando el editor web en GitHub o un editor de texto que use una fuente monoespaciada, como Atom, puede alinear su lista visualmente. Escriba caracteres de espacio delante de su elemento de Lista anidado, hasta que el carácter del marcador de Lista (- o *) se encuentre directamente debajo del primer carácter del texto en el elemento superior.,

1. First list item - First nested list item - Second nested list item

para crear una lista anidada en el editor de comentarios en GitHub, que no usa una fuente monoespaciada, puede mirar 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 la lista anidada.,

en este ejemplo, puede agregar un elemento de Lista anidado bajo el elemento de Lista 100. First list item sangrando el elemento de Lista anidado un mínimo de cinco espacios, ya que hay cinco caracteres () antes de First list item.

100. First list item - First nested list item

Usted puede crear múltiples niveles de listas anidadas utilizando el mismo método., Por ejemplo, debido a que el primer elemento de la lista anidada tiene siete espacios (␣␣␣␣␣-␣) antes del contenido de la lista anidada First nested list item, deberá sangrar el segundo elemento de la lista anidada con siete espacios.

100. First list item - First nested list item - Second nested list item

para obtener más ejemplos, consulte la especificación de Markdown con sabor a GitHub.

listas de tareas

para crear una lista de tareas, haga un prefacio de los elementos de la lista con un carácter de espacio regular seguido de. Para marcar una tarea como completa, use .,

- Finish my changes- Push my commits to GitHub- Open a pull request

si la descripción de un elemento de la lista de tareas comienza con un paréntesis, deberá escapar con \:

- \(Optional) Open a followup issue

para obtener más información, consulte «Acerca de las listas de tareas.»

mencionar personas y equipos

puedes mencionar a una persona o equipo en GitHub escribiendo @ además de su nombre de usuario o nombre de equipo. Esto activará una notificación y llamará su atención a la conversación., Las personas también recibirán una notificación si editas un comentario para mencionar su nombre de usuario o nombre de equipo. Para obtener más información sobre las notificaciones, consulte » Acerca de las notificaciones.»

@github/support What do you think about these updates?

Cuando mencionas un equipo padre, los miembros de sus equipos hijos también reciben notificaciones, lo que simplifica la comunicación con varios grupos de personas. Para obtener más información, consulte » Acerca de los equipos.»

escribir un símbolo@ mostrará una lista de personas o equipos en un proyecto., La lista se filtra a medida que escribe, por lo que una vez que encuentre el nombre de la persona o equipo que está buscando, puede usar las teclas de flecha para seleccionarlo y presionar tab o enter para completar el nombre. En el caso de los equipos, introduce el nombre @Organización/equipo y todos los miembros de ese equipo se suscribirán a la conversación.

los resultados de autocompletar están restringidos a los colaboradores del repositorio y a cualquier otro participante en el hilo.

hacer referencia a problemas y solicitudes de extracción

puede abrir una lista de problemas y solicitudes de extracción sugeridos dentro del repositorio escribiendo #., Escriba el número o el título de la solicitud de edición o extracción para filtrar la lista y, a continuación, presione tab o Intro para completar el resultado resaltado.

para obtener más información, consulte » autolinked references and URLs.»

referencia a recursos externos

si las referencias de autolink personalizadas están configuradas para un repositorio, las referencias a recursos externos, como un problema de JIRA o un ticket de Zendesk, se convierten en enlaces acortados. Para saber qué autolinks están disponibles en tu repositorio, ponte en contacto con alguien con permisos de administrador del repositorio., Para obtener más información, consulte » Configuración de autolinks para hacer referencia a recursos externos.»

archivos adjuntos de contenido

algunas aplicaciones de GitHub proporcionan información en GitHub para URL que enlazan a sus dominios registrados. GitHub renderiza la información proporcionada por la aplicación bajo la URL en el cuerpo o comentario de un problema o solicitud de extracción.

para ver los archivos adjuntos de contenido, debe tener una aplicación GitHub que use la API de archivos adjuntos de contenido instalada en el repositorio., Para obtener más información, consulte «Instalación de una aplicación en su cuenta personal» e «instalación de una aplicación en su organización.»

los archivos adjuntos de contenido no se mostrarán para las URL que forman parte de un enlace de markdown.

para obtener más información sobre cómo crear una aplicación de GitHub que use archivos adjuntos de contenido, consulte » Uso de archivos adjuntos de contenido.»

usando emoji

Puede agregar emoji a su escritura escribiendo :EMOJICODE:.

@octocat :+1: This PR looks great - it's ready to merge! :shipit:

Escribir : se mostrará una lista de sugerencias de emoji., La lista se filtrará a medida que escriba, por lo que una vez que encuentre el emoji que está buscando, presione Tab o Enter para completar el resultado resaltado.

para obtener una lista completa de emoji y códigos disponibles, consulta la hoja de trucos de Emoji.

párrafos

Puede crear un nuevo párrafo dejando una línea en blanco entre las líneas de texto.

ignorar el formato Markdown

puedes decirle a GitHub que ignore (o escape) el formato Markdown usando \ antes del carácter Markdown.,

Let's rename \*our-new-project\* to \*our-old-project\*.

Para obtener más información, consulte Daring Fireball «de la Sintaxis de Markdown.»

lectura adicional

  • especificaciones de Markdown con sabor a GitHub
  • «sobre cómo escribir y formatear en GitHub»
  • «Trabajar con formato avanzado»
  • «dominar Markdown»