Markdown

Démarrez avec Markdown pour la documentation

TL;DR

Quoi : Langage de balisage léger pour créer du texte formaté.

Pourquoi : Écrire des docs, READMEs, notes avec une syntaxe simple qui se convertit en HTML.

Quick Start

En-têtes :

# H1 Header
## H2 Header
### H3 Header

Formatage du texte :

**bold text**
*italic text*
~~strikethrough~~
`inline code`

Listes :

- Unordered item
- Another item
  - Nested item

1. Ordered item
2. Another item

Liens et images :

[Link text](https://example.com)
![Alt text](image.png)

Blocs de code :

```javascript
const greeting = "Hello, World!";
console.log(greeting);
```

Cheatsheet

SyntaxeRésultat
**bold**bold
*italic*italic
~~strike~~strike
`code`code
[text](url)lien
![alt](img)image
> quotecitation
---ligne horizontale

Tableaux :

| Header 1 | Header 2 |
|----------|----------|
| Cell 1   | Cell 2   |
| Cell 3   | Cell 4   |

Listes de tâches (GitHub Flavored) :

- [x] Completed task
- [ ] Pending task

Gotchas

Line breaks not working

<!-- Add two spaces at end of line  -->
Line one
Line two

<!-- Or use blank line for paragraph -->
Paragraph one

Paragraph two

Images not showing

<!-- Use relative path -->
![Screenshot](./images/screenshot.png)

<!-- Or absolute URL -->
![Logo](https://example.com/logo.png)

Code block language highlighting

<!-- Specify language after backticks -->
```python
print("Hello")
```

```bash
echo "Hello"
```

Escaping special characters

\* Not italic \*
\# Not a header
\[Not a link\]

Next Steps