Markdown és un llenguatge de marcat lleuger per donar format simple a textos.
- Estàndard (més o menys)
- Simple
- Lleuger
- Interoperable
S'ha tornat molt popular, sobretot a la indústria tecnològica, per escriure manuals i documentació, però també per gran varietat de textos, ja que permet centrar-se més en el contingut que en el format.
Markdown s'escriu com a text pla amb qualsevol editor de text (inclòs Notepad). El fitxer es guarda amb extensió .md.
Es necessita un renderer per visualitzar el document formatat. A macOS es pot instal·lar un plugin per a QuickLook. A Windows es pot instal·lar l'aplicació QuickLook que simula la funcionalitat de macOS.
Molts editors permeten visualitzar el text formatat en temps real de manera nativa o amb algun plugin.
Alguns serveis online i aplicacions utilitzen markdown per defecte i es visualitza directament.
La sintaxi de markdown és extremadament senzilla i bastant poc intrusiva
Aquest document està escrit en markdown, es pot inspeccionar-ne el codi font per veure l'aplicació de la sintaxi
Afegir un (o varis) hashtag # al començament de la línia per a encapçalaments de diferents nivells. Hi ha fins a 6 nivells de capçaleres, però rarament es passa del 3r.
# Capçalera de nivell 1
## Capçalera de nivell 2
### Capçalera de nivell 3Afegir un, dos o tres asteriscs * sense espais per cursiva, negreta o negreta i cursiva
Afegir números per crear llistes numerades, que poden estar anidades.
- Capítol 1
- Capítol 2
- Capítol 2.1
- Capítol 2.2
- Capítol 3
Utilitzar guions - per llistes no numerades, que també poden estar anidades. També es poden utilitzar asteriscs * o suma +, però per llegibilitat es recomana guions.
- Element 1
- Element 2
- Element 3
- Element 4
- Element 5
Utilitzar una combinació de guions i claudàtors per generar llistes de tasques. Marcar amb una x les tasques completades
- Preparar
.mdpel seminari - Convèncer a tothom que markdown és ❤️
- Aconseguir que s'utilitzi més markdown i menys Word 💩
Utilitzar la combinació de claudàtors i parèntesis per crear un enllaç clicable o directament l'enllaç entre claus angulars https://www.google.com.
De manera menys estàndard, es pot delegar la creació del link per tenir un text amb menys interferències
In a hole in the ground there lived a hobbit. Not a nasty, dirty, wet hole, filled with the ends of worms and an oozy smell, nor yet a dry, bare, sandy hole with nothing in it to sit down on or to eat: it was a hobbit-hole, and that means comfort.
Similar als enllaços, utilitzar la combinació d'exclamació, claudàtors i parèntesis per a afegir imatges.
Utilitzar 3 guions seguits --- per crear un separador horitzontal.
Utilitzar barres per separar columnes i crear així taules. Cada nova línia és una nova fila. És necessari crear una capçalera i separar-la amb el mateix nombre de columnes que contenen guions.
| Columna 1 | Columna 2 | Columna 3 |
|---|---|---|
| Cel·la 1.1 | Cel·la 1.2 | Cel·la 1.3 |
| Cel·la 2.1 | Cel·la 2.2 | Cel·la 2.3 |
| Cel·la 3.1 | Cel·la 3.2 | Cel·la 3.3 |
Per crear petits segments de codi en línia const DELTA = 0.4; s'utilitza un backtick.
Per crear blocs de codi es poden indentar línies de codi, però és preferible utilitzar 3 backticks, ja que a més permet destacar la sintaxi del llenguatge amb el qual s'escriu el codi.
// This is javascript
const today = new Date();
console.log(today.toISOString());## This is python
from datetime import datetime
my_date = datetime.now()
print(my_date.isoformat())Una clau angular > per a crear paràgrafs amb una cita
Ask not what your country can do for you, ask what you can do for your country
Tots els renderers que utilitzin l'estil de Github poden incloure qualsevol emoji d'aquesta llista 🎉