Publié le

Guide Markdown

Auteurs

Introduction

L'analyse Markdown et Mdx est prise en charge via « unifié » et d'autres packages de remarques et de rehype. next-mdx-remote nous permet d'analyser les fichiers .mdx et .md de manière plus flexible sans toucher au webpack.

Une démarque aromatisée à GitHub est utilisée. mdx-prism fournit des capacités de coloration syntaxique pour les blocs de code. Voici une démo de à quoi tout ressemble.

L'aide-mémoire de démarque suivant est adapté de: https://guides.github.com/features/mastering-markdown/

Qu'est-ce que le Markdown ?

Markdown est un moyen de styliser le texte sur le Web. Vous contrôlez l'affichage du document ; formater les mots en gras ou en italique, ajouter des images et créer des listes ne sont que quelques-unes des choses que nous pouvons faire avec Markdown. La plupart du temps, Markdown n'est qu'un texte normal avec quelques caractères non alphabétiques, comme # ou *.

Guide de syntaxe

Voici un aperçu de la syntaxe Markdown que vous pouvez utiliser n'importe où sur GitHub.com ou dans vos propres fichiers texte.

Headers

# Ceci est une balise h1

## Ceci est une balise h2

#### Ceci est une balise h4

Ceci est une balise h1

Ceci est une balise h2

Ceci est une balise h4

Emphasis

_Ce texte sera en italique_

**Ce texte sera en gras**

_Vous **pouvez** les combiner_

Ce texte sera en italique

Ce texte sera en gras

Vous pouvez les combiner

Listes

Non ordonné

- Article 1
- Article 2
   - Article 2a
   - Article 2b
  • Article 1
  • Article 2
    • Article 2a
    • Article 2b

Ordonné

1. Point 1
1. Point 2
1. Point 3
    1. Point 3a
    1. Point 3b
  1. Point 1
  2. Point 2
  3. Point 3
    1. Point 3a
    2. Point 3b

Images

![GitHub Logo](https://github.githubassets.com/images/modules/logos_page/GitHub-Mark.png)
Format: ![Alt Text](url)

GitHub Logo

http://github.com - automatique!
[GitHub](http://github.com)

http://github.com - automatic! GitHub

Citations

Comme l'a dit Kanye West :

> Nous vivons l'avenir alors
> le présent est notre passé.

Comme l'a dit Kanye West :

Nous vivons l'avenir alors le présent est notre passé.

Code en ligne

Je pense que tu devrais utiliser un
`<addr>` ici à la place.

Je pense que tu devrais utiliser un <addr> ici à la place.

Mise en évidence de la syntaxe

Voici un exemple de la manière dont vous pouvez utiliser la coloration syntaxique avec GitHub Flavored Markdown:

```js:fancyAlert.js
fonction fantaisieAlert(arg) {
   si (argument) {
     $.facebox({div: '#foo' })
   }
}
```

Et voici à quoi cela ressemble: joliment coloré avec des titres de code stylisés!

fancyAlert.js
fonction fantaisieAlert(arg) {
   si (argument) {
     $.facebox({div: '#foo' })
   }
}

Notes de bas de page

Voici une simple note de bas de page[^1]. Avec un peu de texte supplémentaire après.

[^1]: Ma référence.

Voici une simple note de bas de page1. Avec un peu de texte supplémentaire après.

Listes de tâches

- Syntaxe de liste [x] requise (toute liste non ordonnée ou ordonnée prise en charge)
- [x] ceci est un article complet
- [ ] ceci est un élément incomplet
  • Syntaxe de liste [x] requise (toute liste non ordonnée ou ordonnée prise en charge)
  • ceci est un article complet
  • ceci est un élément incomplet

Les tables

Vous pouvez créer des tableaux en assemblant une liste de mots et en les divisant avec des traits d'union - (pour la première ligne), puis en séparant chaque colonne par une barre verticale |:

| Premier en-tête | Deuxième en-tête |
| -------------------------------- | ---------------------------- |
| Contenu de la cellule 1 | Contenu de la cellule 2 |
| Contenu dans la première colonne | Contenu dans la deuxième colonne |
Premier en-têteDeuxième en-tête
Contenu de la cellule 1Contenu de la cellule 2
Contenu dans la première colonneContenu dans la deuxième colonne

Barré

Tout mot entouré de deux tildes (comme ~~this~~) apparaîtra barré.

Footnotes

  1. Ma référence.