Markdown es una sintaxis ligera y fácil de usar para diseñar todas las formas de escritura en la plataforma GitHub.
lo que aprenderás:
- Cómo el formato Markdown facilita la edición colaborativa con estilos
- Cómo Markdown difiere de los enfoques de formato tradicionales
- Cómo usar Markdown para formatear texto
- Cómo aprovechar la representación de Markdown automática de GitHub
- Cómo aplicar las extensiones de Markdown únicas de GitHub
¿qué es Markdown?
Markdown es una forma de dar estilo al texto en la web., Usted controla la visualización del documento; formatear palabras en negrita o cursiva, agregar imágenes y crear listas son solo algunas de las cosas que podemos hacer con Markdown. En su mayoría, Markdown es solo texto regular con algunos caracteres no alfabéticos, como #
o *
.,
Puede usar Markdown en la mayoría de los lugares alrededor de GitHub:
- Gists
- comentarios en problemas y solicitudes de extracción
- archivos con la extensión
.md
o.markdown
para obtener más información, consulte «escribir en GitHub» en la ayuda github.
ejemplos
- Text
- Lists
- Images
- Headers & Quotes
- Code
- Extras
Syntax guide
Aquí hay una descripción general de la sintaxis de Markdown que puede usar GitHub.com o en sus propios archivos de texto.,3>Headers
# This is an <h1> tag## This is an <h2> tag###### This is an <h6> tag
Emphasis
*This text will be italic*_This will also be italic_**This text will be bold**__This will also be bold___You **can** combine them_
Lists
Unordered
* Item 1* Item 2 * Item 2a * Item 2b
Ordered
1. Item 11. Item 21. Item 3 1. Item 3a 1. Item 3b
Images
!(/images/logo.png)Format: !(url)
Links
http://github.com - automatic!(http://github.com)
Blockquotes
As Kanye West said:> We're living the future so> the present is our past.
Inline code
I think you should use an`<addr>` element here instead.
GitHub Flavored Markdown
GitHub.,com utiliza su propia versión de la sintaxis Markdown que proporciona un conjunto adicional de características útiles, muchas de las cuales facilitan el trabajo con contenido en GitHub.com.
tenga en cuenta que algunas características de GitHub flavored Markdown solo están disponibles en las descripciones y comentarios de problemas y solicitudes de extracción. Estos incluyen @ menciones, así como referencias a hashes SHA-1, problemas y solicitudes de extracción. Las listas de tareas también están disponibles en los comentarios Gist y en los archivos Gist Markdown.,
resaltado de Sintaxis
he Aquí un ejemplo de cómo se puede utilizar el resaltado de sintaxis con GitHub con Sabor a Markdown:
```javascriptfunction fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) }}```
también puede simplemente aplicar sangría al código de cuatro espacios:
function fancyAlert(arg) { if(arg) { $.facebox({div:'#foo'}) } }
he Aquí un ejemplo de código en Python sin resaltado de sintaxis:
def foo(): if not bar: return True
Listas de Tareas
Si usted incluye una lista de tareas en el primer comentario de un Problema, usted recibirá un práctico indicador de progreso en su lista de emisión. También funciona en Pull requests!,parating cada columna con un tubo de |
:
Sería:
Encabezado de Primero | Segundo Encabezado |
---|---|
Contenido de la celda 1 | Contenido de la celda 2 |
Contenido de la primera columna | Contenido de la segunda columna |
SHA referencias
Cualquier referencia a una confirmación del hash SHA-1 se convierte automáticamente en un enlace para que se comprometan en GitHub.,
16c999e8c71134401a78d4d46435517b2271d6acmojombo@16c999e8c71134401a78d4d46435517b2271d6acmojombo/github-flavored-markdown@16c999e8c71134401a78d4d46435517b2271d6ac
referencias de problemas dentro de un repositorio
cualquier número que haga referencia a un problema o solicitud de extracción se convertirá automáticamente en un enlace.
#1mojombo#1mojombo/github-flavored-markdown#1
Username @mentions
al escribir un símbolo@
, seguido de un nombre de usuario, notificará a esa persona que venga y vea el comentario. Esto se llama «@mención», porque estás mencionando al individuo. También puedes @mencionar equipos dentro de una organización.,
enlace automático para Url
cualquier URL (como ) se convertirá automáticamente en un enlace en el que se puede hacer clic.
Tachado
Cualquier palabra envuelta con dos tildes (como ~~this~~
) aparecerá tachado.
Emoji
GitHub soporta emoji!
para ver una lista de todas las imágenes que apoyamos, echa un vistazo a la hoja de trucos Emoji.
Última actualización 15 de enero de 2014