¿Creas documentos de Markdown pero tienes muchas dudas respecto a todo el partido que se le puede sacar? En este post, os vamos a explicar qué son los ficheros o documentos de Markdown, dónde se utilizan y cómo crearlos (con trucos y recomendaciones para hacerlos más vistosos) 😉
Lo primero de todo: ¿qué es markdown?
Markdown es un fichero de lenguaje de marcado. Se identifican con a extensión md y son ficheros de texto plano.
¿Y qué significa esto de lenguaje de marcado? Pues que se utilizan marcas (o tags) para agregar formatos como encabezados, tipos de letras, citas, listas… etc a un texto sin formato. En principio se creó como una alternativa más sencilla al HTML, y al disponer de una sintaxis más sencilla, resulta más fácil de aprender y utilizar.
¿Dónde podemos usar markdown?
Pues básicamente es un estándar a la hora de crear documentación en el mundo del desarrollo. Y como ya os avanzamos hace algunas semanas en este artículo de Git, se utiliza para documentar nuestros desarrollos y subirlo a los repositorios.
Por lo cual dicho esto, comencemos y veamos cómo funciona y como se utiliza 😉
Empecemos: cómo crear documentos de MarkDown
Lo primero de todo es utilizar un editor que nos pueda mostrar una previsualización. Por ejemplo, en este caso utilizaremos VSCode, que lo puedes descargar desde aquí. Así que si ya lo tenemos todo listo, podemos crear nuestro fichero md. Y si es un fichero de texto plano, ¿cómo se pueden crear tags para editarlo? Pues ahora os lo cuento…
Para crear los diferentes estilos, deberemos utilizar la siguiente sintaxis de tal forma que se puede interpretar:
- Tendremos que insertar un carácter ‘#’ al comienzo de la línea para aplicar un estilo de tipo ‘título’, pudiendo utilizar los títulos de tipo 1, 1.1, 1.1.1 …etc
Y para los diferentes tipos de letra, podremos insertar:
- Un asterisco sencillo (al principio y al final) para estilo itálica
- Doble Asterisco (al principio y al final) para usar negrita
- Doble ~~ (al principio y al final) para efecto
tachado - Un ` (al principio y al final) para resaltar algunas palabras
- Si queremos crear listas, podemos utilizar – o *:
- Si queremos insertar una cita utilizaremos “>” para cada párrafo o linea:
- Si lo que buscas es crear una tabla, deberemos utilizar: |—|—| y escribir el contenido de las celdas entre ‘|’. Además, podemos utilizar “:” para indicar si deseamos alinear a la izquierda, a la derecha o centrado. Por defecto la alineación es a la izquierda.
- Y si queremos crear una lista dentro de una celda? Podemos utilizar <li> y <br> para los saltos de linea:
- Si insertamos un fragmento de código utilizaríamos tres «` al comienzo y al final:
- Para insertar enlaces tendremos que utilizar corchetes (para el nombre del enlace) y paréntesis (para el enlace):
También podemos poner enlaces a otros ficheros propios del repositorio 😉
- Y para las imágenes, una exclamación, corchetes y paréntesis:
- Y si quisiéramos añadir algunos Emojis, ¿como por ejemplo el icono de warning?
Aquí os pongo algunos ejemplos que pueden ser los más utilizados. La única es tener en cuenta que quizás dependiendo de la versión del editor y de las extensiones, quizás la previsualización no funcione bien hasta que lo subáis a GitHub.
Markdown es muy sencillo de utilizar y bastante útil. Nos permite documentar nuestros desarrollos de manera rápida y sencilla adaptándonos a las buenas prácticas. Espero que estos consejos os hayan resultado útiles y que os ayuden a hacer una documentación más vistosa.
Santander Global T&O es una compañía del Grupo Santander con más de 3.000 empleados y basada en Madrid, trabajamos para convertir al Santander en una plataforma abierta de servicios financieros.
Mira las posiciones que tenemos abiertas aquí para unirte a este equipazo y Be Tech! with Santander
Síguenos en LinkedIn y en Instagram.
Javier Gómez
Santander Global T&O
Ingeniero de sistemas con más de 20 años de experiencia en diferentes roles como arquitecto de sistemas, gestionando soluciones de virtualización de Apps & VDIs y proporcionando soluciones end-to-end, así como administrando sistemas y automatizando tareas mediante PowerShell.
Me considero una persona inquieta y un infatigable explorador del universo IT, que ha sabido hacer de su trabajo su pasión.
