Documentation Markdown Complète

Du débutant à l'expert - Maîtrisez Markdown avec MarkOwl

19 Chapitres
100+ Exemples
∞ Possibilités

🧪 Tester Markdown en Direct

Écrivez du Markdown et voyez le résultat en temps réel

Markdown
Aperçu

Chapitre 1

Introduction à Markdown

🤔 Qu'est-ce que Markdown ?

Markdown est un langage de balisage léger créé par John Gruber en 2004. Il permet de formater du texte en utilisant une syntaxe simple et lisible.

Exemple Markdown
# Titre
**Texte en gras**
*Texte en italique*

🎯 Pourquoi utiliser Markdown ?

  • Simple et intuitif
  • Lisible même sans formatage
  • Compatible avec de nombreux outils
  • Idéal pour la documentation

📚 Histoire de Markdown

Créé en 2004 par John Gruber et Aaron Swartz, Markdown est devenu un standard pour l'écriture web.

Chapitre 2

Installation et Outils

💻

VS Code

Extension Markdown Preview

1. Installer VS Code

2. Installer l'extension Markdown Preview

3. Utiliser Ctrl+Shift+V pour prévisualiser

📝

Typora

Éditeur Markdown WYSIWYG

1. Télécharger Typora

2. Installer l'application

3. Commencer à écrire

🔗

GitHub

Markdown intégré nativement

1. Créer un repository

2. Créer un fichier .md

3. GitHub prévisualise automatiquement

Chapitre 3

Syntaxe de Base Markdown

Titres

# Titre H1
## Titre H2
### Titre H3

Titre H1

Titre H2

Titre H3

Mise en forme

**Gras**
*Italique*
~~Barré~~
Gras
Italique
Barré

Citations

> Citation simple
>> Citation imbriquée
Citation simple
Citation imbriquée

Code

`Code inline`

```javascript
// Bloc de code
console.log('Hello');
```
Code inline
// Bloc de code
console.log('Hello');

Chapitre 4

Listes Markdown

Listes à puces

- Élément 1
- Élément 2
  - Sous-élément
  • Élément 1
  • Élément 2
    • Sous-élément

Listes numérotées

1. Premier élément
2. Deuxième élément
   1. Sous-élément
  1. Premier élément
  2. Deuxième élément
    1. Sous-élément

Checklists

- [x] Tâche terminée
- [ ] Tâche à faire
  • Tâche terminée
  • Tâche à faire

Chapitre 5

Liens et Navigation

Liens externes

[Texte du lien](https://example.com)
[Titre avec attribut](https://example.com "Titre")

Texte du lien

Titre avec attribut

Liens relatifs

[Page suivante](page-suivante.md)
[Image](./images/photo.jpg)

Page suivante

Image

Liens email

[Envoyer un email](mailto:contact@example.com)

Envoyer un email

Chapitre 6

Images et Médias

Images de base

![Texte alternatif](image.jpg)
![Avec titre](image.jpg "Titre de l'image")

Texte alternatif

Images avec lien

[![Image cliquable](image.jpg)](https://example.com)

Image cliquable

Chapitre 7

Code et Blocs de Code

Code inline

Utilisez la fonction `console.log()` pour afficher des messages.

Utilisez la fonction console.log() pour afficher des messages.

Blocs de code

```javascript
function hello(name) {
    console.log(`Hello ${name}!`);
}
```
function hello(name) {
    console.log(`Hello ${name}!`);
}

Chapitre 8

Tableaux Markdown

Tableau simple

| Nom | Âge | Ville |
|-----|-----|------|
| Alice | 25 | Paris |
| Bob | 30 | Lyon |
NomÂgeVille
Alice25Paris
Bob30Lyon

Alignement

| Gauche | Centre | Droite |
|:-------|:------:|-------:|
| Texte  | Texte  | Texte  |
GaucheCentreDroite
TexteTexteTexte

Chapitre 9

Markdown Avancé

HTML dans Markdown

Vous pouvez insérer du HTML directement dans Markdown pour plus de contrôle.

<div style="color: red;">
Texte rouge personnalisé
</div>

Notes de bas de page

Texte avec une note de bas de page[^1].

[^1]: Voici la note de bas de page.

Émojis

:smile: :heart: :rocket:

Chapitre 10

Markdown pour GitHub

📝 README.md

Le fichier README.md est la carte de visite de votre projet.

🏷️ Badges GitHub

![Build Status](https://img.shields.io/badge/build-passing-brightgreen)

✅ Checklists GitHub

- [x] Feature implemented
- [ ] Tests written
- [ ] Documentation updated

Chapitre 11

Markdown pour la Documentation

📋 Structure de documentation

  • Introduction
  • Installation
  • Guide de démarrage
  • API Reference
  • Exemples
  • FAQ

🧭 Navigation

Créez une table des matières pour naviguer facilement.

## Table des matières
- [Installation](#installation)
- [Utilisation](#utilisation)

Chapitre 12

Markdown pour les Développeurs

📚 Documentation API

Utilisez Markdown pour documenter vos APIs.

🗂️ Documentation de projet

Structurez vos fichiers README pour les projets.

🔧 Markdown et DevOps

Intégrez Markdown dans vos pipelines CI/CD.

Chapitre 13

Markdown et Sites Web

📖 MkDocs

Générateur de documentation statique.

📚 Docusaurus

Plateforme de documentation par Facebook.

⚡ Hugo

Générateur de site statique rapide.

🌟 Jekyll

Générateur utilisé par GitHub Pages.

Chapitre 14

Projets Pratiques

📋 Documentation de projet

Créez une documentation complète pour un projet open source.

📖 README professionnel

Rédigez un README qui attire les contributeurs.

🧠 Base de connaissances

Organisez vos notes et connaissances personnelles.

📝 Wiki personnel

Créez votre wiki avec Obsidian ou Notion.

Chapitre 15

Erreurs Courantes

❌ Mauvais alignement

Les tableaux nécessitent un alignement correct des tirets.

⚠️ Erreurs de syntaxe

Vérifiez toujours vos parenthèses et crochets.

🔗 Liens cassés

Testez toujours vos liens avant publication.

🖼️ Images non affichées

Vérifiez les chemins des images.

Chapitre 16

Cheatsheet Markdown

Titres

# H1
## H2
### H3

Formatage

**gras**
*italique*
~~barré~~

Listes

- Item 1
- Item 2

Liens

[texte](url)

Images

![alt](url)

Code

`code`
```code```

Chapitre 17

FAQ Markdown

❓ Qu'est-ce que Markdown ?

Markdown est un langage de balisage léger pour formater du texte.

❓ Markdown fonctionne où ?

Partout : GitHub, VS Code, Notion, Obsidian, etc.

❓ Pourquoi utiliser Markdown ?

C'est simple, lisible et compatible avec de nombreux outils.

Chapitre 18

Ressources et Références

📚 Documentation officielle

🛠️ Outils

🔧 Extensions VS Code

Chapitre 19

Markdown Expert

🏗️ Architecture de documentation

Structurez des documentations complexes avec plusieurs niveaux.

⚡ Workflow documentation

Automatisez la génération de documentation.

🔀 Markdown + Git

Versionnez votre documentation avec Git.

🚀 Publication automatique

Déployez automatiquement vos docs avec GitHub Actions.