Al mismo tiempo, Markdown es muy liviano y flexible también. El caso de uso más popular para Markdown es para archivos de licencia y lectura en un repositorio de GitHub, pero también se está integrando con más y más CMS para administrar publicaciones de blog e incluso escribir trabajos de investigación. Puede representar ecuaciones matemáticas con complementos para látex.
Sin embargo, es utilizado principalmente por los desarrolladores. Es realmente útil para hacer tutoriales y documentación gracias al resaltado de sintaxis para múltiples idiomas y soporte para imágenes e incluso gifs.
Comencemos con una configuración que nos permite obtener una vista previa del documento renderizado junto con un archivo de texto de Markdown Raw.
Atom Text Editor y Markdown Preview
Puede descargar e instalar Atom Text Editor o Visual Studio Code para seguir. Atom y VS Code tienen complementos preinstalados para la vista previa de Markdown. Aquí se usará Atom, pero la sintaxis seguirá siendo aproximadamente igual sin importar qué editor de texto use.
En Atom, asegúrese de que el paquete de vista previa de Markdown esté habilitado (de hecho, está habilitado de forma predeterminada). Cree una carpeta para este tutorial de Markdown y, allí, abra un nuevo archivo (Ctrl + N) e ingrese el siguiente texto allí.
# Este es un encabezadoGuarde el archivo (CRTL + S) con un .extensión de MD. Por ejemplo, puede nombrar su archivo como prueba.MD y el .MD Part le dirá a Atom que este es un archivo de Markdown y que la extensión funcionaría con él según lo previsto. Puede generar una vista previa utilizando el siguiente KeyBinding (Ctrl+Shift+M) que se muestra en un nuevo panel al lado del archivo de texto sin procesar.
Puede cerrar el panel de vista previa utilizando la misma clave de clave o utilizando la GUI misma.
Con todo configurado, podemos echar un vistazo más de cerca a la sintaxis y comenzar a crear documentos increíbles sobre la marcha.
Sintaxis de markdown
Como se mencionó anteriormente, la principal motivación detrás de Markdown es la legibilidad. Esto significa que no hay etiquetas obscuras o etiquetas anidadas o cualquier otra confusión inductora de cuerdas. En su lugar, podemos comenzar con el símbolo '#' para indicar que esa línea en particular es un encabezado.
# Es un encabezado.Markdown continúa agrupando todo el texto en un párrafo gigante incluso cuando el texto crudo se divide en varias líneas diferentes. Para mitigar esto, puede usar dos espacios al final de una línea y luego poner un personaje de Newline (es decir, HIT ) o simplemente use dos caracteres newline para un efecto ligeramente diferente como se muestra a continuación.
La oración "Por eso ..." comenzó en una nueva línea, pero no está espaciada aparte de la línea anterior, mientras que el uso de dos nuevas líneas creó una separación más amplia.
La regla horizontal, como su nombre indica, crea una línea horizontal que le permite estructurar su documento y hacer separaciones lógicas en él. Hay dos métodos para crear una regla horizontal. Primero es usar tres o más subrayadores para crear una regla horizontal.
#Ceente 1Otra opción (que no recomendaré) es usar tres o más guiones ", pero también se usan para indicar que la oración inmediatamente por encima de ellos es un encabezado. Entonces, si no tiene una nueva línea entre una oración y la regla horizontal debajo de ella, esa oración tomará la forma de un encabezado.
La sintaxis para los tres es bastante simple y habla por sí misma.
** Esto está en negrita **Ahora, uno podría preguntar, ¿cómo escribiría literalmente ** algún texto ** en el archivo de Markdown final si solo cambia eso a Bold cada vez. Esto es algo con lo que la mayoría de los lenguajes de programación también tratan y la solución es similar a la que usa un personaje de barra de bar. Esto también funciona para otros elementos de sintaxis, y no es específicamente para un estilo en negrita.
\ ** Esto ya no es audaz \ **Los bloques y los bloques de código son mucho más fáciles. Se puede usar un bloqueo de bloques para resaltar un punto importante hacia el cual desea llamar la atención de los lectores. Esto se puede lograr utilizando el soporte angular derecho al comienzo como se muestra.
# Encabezado 1Así es como se ve cuando se renderiza.
Para bloques de código, simplemente envíe las líneas las líneas por 4 espacios o más. Esto es realmente
Handy para desarrolladores y operadores que desean documentar su trabajo. Más tarde veríamos cómo hacer esto aún mejor.
Para los hipervínculos, la sintaxis es bastante simple. El texto visible está escrito en soportes cuadrados y la URL a la que señala se escribe en soportes redondos justo al lado.
Para las imágenes, la sintaxis es similar, excepto que comienza con un signo de exclamación. Usted es libre de usar una ruta relativa en la carpeta de su proyecto que apunta a la imagen o puede tener una URL pública.
## Ilustración de la sintaxis del hipervínculo y la imagenLa creación de tablas en Markdown incluye literalmente dibujar un retrato ASCII (unicode para ser preciso) de una mesa.
## MesasLa sintaxis no necesita estar exactamente alineada de una fila a otra, pero el carácter de la tubería se usa para cambiar a la siguiente columna y la siguiente línea indica que la siguiente fila ha comenzado, generalmente.
Marca extendida
Para aquellos de ustedes que han llegado tan lejos, aquí está el verdadero regalo. Si está utilizando Atom, puede reemplazar el complemento de vista previa de Markdown para Markdown Preview Plus. Que ofrece las siguientes funcionalidades.
En realidad, puede insertar scripts de látex entre signos de dólar y se representará como script de látex y se mostrará en la vista previa con Ctrl+Shitft+x Keybinding. Ni siquiera tienes que saber todo el látex, solo unos pocos fragmentos son suficientes.
## ilustrando látexEn lugar de usar la sangría para indicar bloques de código, puede usar backticks seguido de nombre de los idiomas en los que su script está supuestamente escrito. Los idiomas cuyas sintaxis son compatibles son demasiado numerosos para enumerar aquí, pero aquí hay un ejemplo en Python.
## Ilustración de resaltado de sintaxisHay muchos sabores o markdown. Github tiene su propia cerveza especial y la sintaxis es muy flexible. Se supone que esto no debe intimidar a los usuarios, sino que atiende una variedad más amplia de ellos. Es uno de esos idiomas que uno solo comprende un subconjunto que uno lo necesita y lo usa, en lugar de molestarte por los tecnicismos (a menos que estés interesado en sus tecnicismos!)