Guia de sintaxi Markdown

Una xuleta clara del Markdown de cada dia. Cada bloc mostra la sintaxi i el resultat que obtens.

Què és Markdown?

Markdown és una manera lleugera d'afegir format al text pla. En lloc de botons i menús, fas servir uns quants símbols senzills, com # per a un encapçalament o * per a l'èmfasi, que continuen sent llegibles fins i tot com a text sense format.

Creat per John Gruber i Aaron Swartz el 2004, s'ha convertit en l'estàndard per a READMEs, documentació, notes i llocs com GitHub i Reddit. Com que és només text, el que escrius continua sent portàtil i llegible a qualsevol lloc.

Aquesta guia cobreix la sintaxi que faràs servir més. Obre qualsevol exemple a Markdown Peek i prem la barra espaiadora per alternar entre el codi font i el resultat renderitzat.

Encapçalaments

Comença una línia amb d'un a sis caràcters #. Com més coixinets, més petit i més profund és l'encapçalament.

Markdown

# Heading 1
## Heading 2
### Heading 3
#### Heading 4

Resultat

Heading 1

Heading 2

Heading 3

Heading 4

Negreta, cursiva i més

Envolta el text amb símbols per ressaltar-lo. Combina'ls com vulguis.

Markdown

**Bold text**
*Italic text*
***Bold and italic***
~~Strikethrough~~
`Inline code`

Resultat

Bold text

Italic text

Bold and italic

~~Strikethrough~~

Inline code

Llistes

Fes servir un guionet, un asterisc o un signe més per als pics, i números per a les llistes ordenades. Sagna per imbricar.

Markdown

- First item
- Second item
  - Nested item
- Third item

1. Step one
2. Step two

Resultat

First item
Second item
- Nested item
Third item

Step one
Step two

Enllaços

Posa el text visible entre claudàtors i l'adreça entre parèntesis. Una adreça web o de correu soltes es converteix en enllaç per si sola.

Markdown

[Markdown Peek](https://markdownpeek.com)
https://markdownpeek.com

Resultat

Markdown Peek

https://markdownpeek.com

Imatges

Una imatge és un enllaç amb un signe d'exclamació al davant. El text entre claudàtors és el text alternatiu.

Markdown

![A cat looking up](cat.jpg)

Resultat

Cites

Comença una línia amb > per citar-la. Afegeix-hi un altre > per imbricar una cita dins d'una altra.

Markdown

> A quote worth remembering.
>
> > And a nested one.

Resultat

A quote worth remembering.
And a nested one.

Codi

Envolta el codi en línia amb accents greus simples, i els blocs sencers amb tres accents greus. Afegeix-hi el nom d'un llenguatge i Markdown Peek acoloreix el codi, com GitHub.

Markdown

Use `backticks` for inline code.

```js
function hi() {
  console.log("Hello");
}
```

Resultat

Use backticks for inline code.

function hi() {
  console.log("Hello");
}

Taules

Separa les columnes amb barres verticals i subratlla la fila de capçalera amb guionets. Els dos punts defineixen l'alineació.

Markdown

| Feature | Supported |
|---------|:---------:|
| Tables  | Yes       |
| Code    | Yes       |

Resultat

Feature	Supported
Tables	Yes
Code	Yes

Línies horitzontals

Tres o més guionets, asteriscs o guions baixos en una línia pròpia dibuixen un separador.

Markdown

Above the line.

---

Below the line.

Resultat

Above the line.

Below the line.

Llistes de tasques

Un element de llista amb [ ] és una tasca pendent, i [x] és una de feta.

Markdown

- [x] Read the guide
- [ ] Set as default app

Resultat

Read the guide
Set as default app

Avisos

Comença una cita amb [!NOTE], [!TIP], [!IMPORTANT], [!WARNING] o [!CAUTION] per convertir-la en un avís de color, com a GitHub.

Markdown

> [!NOTE]
> Useful to know, even when skimming.

> [!WARNING]
> Needs attention right away.

Resultat

Note

Useful to know, even when skimming.

Warning

Needs attention right away.

Notes a peu de pàgina

Afegeix [^1] allà on va una nota i escriu la nota en qualsevol lloc més avall. Markdown Peek numera les notes, les llista al final i t'hi enllaça per tornar on eres.

Markdown

Markdown was created in 2004.[^1]

[^1]: By John Gruber and Aaron Swartz.

Resultat

Markdown was created in 2004.¹

By John Gruber and Aaron Swartz. ↩︎

Front matter

Els parells de clau i valor entre dues línies --- a dalt de tot d'un fitxer, com a les entrades de blog i les habilitats d'agent, es mostren com una taula clara.

Markdown

---
title: Lofoten
author: Sam
tags: travel
---

# Five nights in March

Resultat

title	author	tags
Lofoten	Sam	travel

Five nights in March

Escapar caràcters

Posa una barra inversa abans d'un símbol per mostrar-lo tal qual en lloc d'aplicar-hi format.

Markdown

\*Not italic\*
\# Not a heading

Resultat

*Not italic*

# Not a heading

Fórmules amb LaTeX

Envolta el LaTeX amb un sol signe de dòlar per a una fórmula dins d'una frase, o amb dos per a una fórmula en una línia pròpia. Markdown Peek mostra totes dues, sense connexió.

Markdown

Inline math like $E = mc^2$ works in a sentence.

$$
a^2 + b^2 = c^2
$$

Resultat

Inline math like E = mc² works in a sentence.

a 2 + b 2 = c 2

Diagrames amb Mermaid

Obre un bloc de codi delimitat amb mermaid i descriu un diagrama de flux o de seqüència en text pla. Markdown Peek te'l dibuixa, en mode clar o fosc.

Markdown

```mermaid
flowchart LR
  A[Write] --> B[Preview]
  B --> C[Share]
```

Resultat

Llegeix Markdown amb tota la seva bellesa al Mac

Markdown Peek mostra qualsevol fitxer .md amb un estil net a l'estil de GitHub, amb codi en color, vista ràpida al Finder i desa com a PDF. Gratuït a la Mac App Store.