Hey dev! 💪 quizá ya hayas escuchado de markdown, y si no, aquí obtendrás casi todo lo que como developer debes saber y comenzar a utilizarlo desde ya mismo.
Markdown es un lenguaje de marcado con la extensión .md creado por John Gruber y Aaron Swartz en el 2004 el cual permite añadir formato a un texto mediante caracteres que serán interpretados, por ejemplo un texto encerrado mediante 2 asteriscos lo pondrá en negrita, veamos las posiblidades de formateo que tenemos con markdown.
Principales formatos
Cómo aplicarlo... | Propósito |
---|---|
**este texto estará en negrita** | Negrita |
# encabezado | H1 |
## sub encabezado | H2 |
*este texto estará en cursiva* | Cursiva |
~~este texto estará tachado~~ | Tachado |
`git init` es un comando | Formatear código o comandos en una línea |
- esto es una viñeta | Lista de viñetas |
[ ] esto es un checkbox | Lista de checkboxes |
[BraveDeveloper](https://bravedeveloper.com) | Links |
1. Primera fila 2. Segunda fila | Numeraciones |
``` cspublic class Student { public int id; public string name; } ``` | Formatear código en varias líneas. Se puede indicar el lenguaje mediante su extensión. En este caso cs representa C#. |
No olvides el espacio que debe existir después de ciertos caracteres como el numeral #, el guión -, el número y punto para las numeraciones (1. Abc 2. Xyz etc.) y los corchetes [ ]. En el caso de los corchetes, éstos deben tener un espacio entre la apertura y cierre de corchete. Si no respetas esto no formateará bien.
Puedes utilizar esta tabla como un cheat-sheet ya que contiene lo más utilizado en markdown, por supuesto hay más formatos que se pueden aplicar, sin embargo aplicando a mi amigo Pareto, el 80% de las veces utilizarás este 20% de formatos.
Símbolos
Como habrás notado se usan algunos símbolos para dar formato, algunos son sencillos de tipear como el numeral, sin embargo algunos son más complicados de hallar en el teclado, por eso aquí en esta tablita te pongo los más difíciles para que puedas hacerlo como un pro.
Nombre | Como luce | Cómo escribirlo en teclado en Español (Windows) |
---|---|---|
Virguilla | ~ | ALT + 126 |
Comilla invertida | ` | ALT + 96 |
Aplícalo
A continuación te muestro como se mostrarían en un markdown real los formatos aquí explicados:
Como puedes notar puedes combinar los formatos aplicados, por ejemplo si quieres negrita y cursiva entonces encierras el texto en ***
Editores online
Existen editores de markdown online, te recomiendo https://dillinger.io/ 😉
Copia y pega este texto y mira por ti mismo cómo se formatea, además de echar un vistazo a un par más de formatos disponibles.
# Aprendiendo markdown
## Como un pro
Lo viste en [Bravedeveloper](https://bravedeveloper.com)
Ya sabes **markdown** es un lenguaje de *marcado* muy ***genial*** y ~~sólo para cracks~~.
- Usado en documentación de repositorios, etc
- Es fácil de aprender
[ ] No hay que instalar nada
[ ] Iniciar!
Sigue los pasos:
1. Paso inicial
2. Seguimos
## Veamos código
Para iniciar un repo aplicamos `git init`. Veamos algo de C#:
```cs
public class Student
{
public int id;
public string name;
}
```
Crack! ahora que ya sabes cómo aplicar markdown, úsalo en tus readme de ese repositorio tuyo alojado en Github o Gitlab!
Y no olvides que si esta entrada te ha encantado, compártela 😉🚀