Hoja de trucos de Github Markdown
El descenso estándar
Markdown es un estándar desarrollado por John Gruber. El objetivo principal con Markdown es hacer posible el archivo para leer incluso en texto puro. Si desea buscar en un editor de solo texto, debe tener un momento fácil leerlo. Esto es muy útil para los usuarios de VIM y similares. Nota, y recuerde que este es un estándar para cambiar los archivos de texto. No está reemplazando html. En su lugar, lo usa para crear HTML donde es útil. En el caso de GitHub, formatearán el archivo ReadMe en el sitio. Mientras sigas el estándar, puedes sentir seguro que se verá bien.
Dado que Github ha agregado solo unas pocas extensiones, debe comenzar usando una hoja de trucos de Markdown e ir desde allí. Aquí hay una lista de los más comunes.
| Reducción | Extensiones | Resultado |
| # (1 por nivel) | Encabezados | |
| * | Cursiva | |
| ** | Atrevido | |
| > | Bloqueo | |
| 1. (etc.) | Lista ordenada | |
| - | Lista desordenada | |
| 'código' | Tu codigo | |
| "' | MD-EXT | Iniciar y finalizar un bloque de código |
| - | Regla horizontal | |
| [Descripción] (https: // www.ejemplo.com) | Un nombre en cuadrado y URL en corchetes regulares | |
| ![texto alt] (imagen.PNG) | Lo mismo, enlace a una imagen | |
| [1] | MD-EXT | Una nota al pie |
Las listas pueden anidarse al sangrar cualquier artículo que desee anidarse.
Otras extensiones a Markdown regular, tiene las extensiones de bloques de código anteriores. No siempre son respaldados por los servicios.
| Reducción | Extensiones | Resultado |
| ### encabezado #custom-id | MD-EXT | Un título que puede abordar por su identificación |
| Término: definición | MD-EXT | Una lista de términos con definiciones |
| ~ Texto equivocado ~ | MD-EXT | Texto de Strikethrough |
| - [x] tarea de hacer | MD-EXT | Una lista de tareas que puede marcar |
La mesa es muy simple, pero necesita varias filas para mostrarla: Tabla:
| Nombre | Valor || ----------- | ---------- |
| Esteras | 100 |
Extensiones de Github.
Github ha agregado algunas extensiones para que sea más simple manejar los enlaces a otras personas y proyectos. Algunas de esas son las tablas mencionadas anteriormente. El que más te ayudará es la extensión de enlace automático. Crea un enlace por sí solo cuando lo usas en Github.
Otros son tablas y elementos de la lista de tareas. Estos son convenientes para realizar un seguimiento de sus tareas en proyectos. El último que menciona es la extensión HTML sin problemas. Con la ayuda de esta extensión, algunas etiquetas se filtran al renderizar para HTML. Estas etiquetas pueden causar efectos extraños al renderizar a Github.
Formas de explorar Github Markdown
Si lo encuentra confuso, también puede ir a la página Github y usar el editor incorporado. Cuando lo use, se completará automáticamente algunas funciones. Esto solo funciona para problemas, pero puede usarlo para descubrir algunas cosas, los emojis salen como una lista cuando escribe un colon (:).
También puede encontrar un proyecto en GitHub que tenga un archivo Readme de excelente aspecto y clonarlo en su unidad local. A partir de ahí, puede explorar el archivo con cualquier editor que desee. Para los grandes editores, emacs y vim, hay soporte para Markdown a través de extensiones.
Si está utilizando VIM, puede colocar una extensión de resaltado de sintaxis desde GitHub, Vim-Markdown. Esta extensión le muestra que ha realizado el código correctamente. Para ayudarlo a ver cómo se ve cuando se hace, también puede obtener la extensión de la marca en vivo. Con esto, puede tener un servidor web en ejecución, mostrando el resultado en vivo mientras escribe.
Con emacs, tienes modelo impaciente, modelo en vivo y real. Todos muestran su página resultante en un navegador mientras escribe. El primero requiere menos bibliotecas que las últimas, pero necesita un código de código adicional para ejecutar.
Conclusión
Aunque Markdown es una especificación pequeña y deliberadamente simple, puede ser un poco confuso comenzar con. La mejor manera de aprender es usar una hoja de trucos y escribir su documento de Markdown. Puedes actualizar tu lectura.MD en GitHub, y puede obtener mucho soporte de las funciones integradas de sus editores. Como nota al margen, GitHub también admite emojis que puede agregar a su documento. Puedes usar la hoja de trucos para encontrar cuáles son.
Descargar Markdown-CheatSheethere