exemple: améliore l'exemple
- Améliore l'exemple de syntaxe Markdown avec des retours à la ligne et une section sur les titres. - Supprime les codeblocks qui prêtent à confusion. - Ignore le rendu HTML généré par pandoc, qui est peut-être une meilleure représentation que la prévisualisation dynamique depuis neovim. Co-Authored-by: iGor milhit <igor@milhit.ch>main
parent
7ad80d9356
commit
1015d37979
|
@ -1,4 +1,5 @@
|
||||||
document.html
|
document.html
|
||||||
|
exemple.html
|
||||||
test.html
|
test.html
|
||||||
*.pdf
|
*.pdf
|
||||||
*.zip
|
*.zip
|
||||||
|
|
106
exemple.md
106
exemple.md
|
@ -1,59 +1,46 @@
|
||||||
# Exemple de note
|
# Exemple de note
|
||||||
|
|
||||||
Pour écrire un paragraphe, il faut séparer deux blocs de texte par une ligne vide. Un simple retour à la ligne
|
Pour écrire un paragraphe, il faut séparer deux blocs de texte par une ligne
|
||||||
|
vide. Un simple retour à la ligne
|
||||||
ne change rien.
|
ne change rien.
|
||||||
|
|
||||||
Ici commence le paragraphe suivant. Dans celui-ci, on peut insérer *un texte en italique*, soit en entourant la partie en *italique* par des astérisques (`*`), soit au moyen _d'underscore_ (`_`).
|
Ici commence le paragraphe suivant. Dans celui-ci, on peut insérer *un texte en
|
||||||
|
italique*, soit en entourant la partie en *italique* par des astérisques (`*`),
|
||||||
|
soit au moyen _d'underscore_ (`_`).
|
||||||
|
|
||||||
Pour le gras, **on utilise un double astérisque**, ou __un double underscore__.
|
Pour le gras, **on utilise un double astérisque**, ou __un double underscore__.
|
||||||
|
|
||||||
|
## Les titres
|
||||||
|
|
||||||
|
Comme en HTML, il y a 6 niveaux de titres disponibles. Pour indiquer qu'il
|
||||||
|
s'agit d'un titre, il faut commencer la ligne par un `#`, et on multiplie les
|
||||||
|
`#` pour indiquer les niveaux de titre de 1 (`#`) à 6 (`######`). Ce fichier
|
||||||
|
d'exemple contient un titre de niveau 1 et des titres de niveau 2 et 3.
|
||||||
|
|
||||||
## Les listes
|
## Les listes
|
||||||
|
|
||||||
Pour générer une liste, on commence chaque ligne de la liste avec un tiret :
|
Pour générer une liste, on commence chaque ligne de la liste avec un tiret :
|
||||||
|
|
||||||
```markdown
|
|
||||||
- Une liste
|
|
||||||
- Simple et
|
|
||||||
- Non ordonnée.
|
|
||||||
```
|
|
||||||
|
|
||||||
- Une liste
|
- Une liste
|
||||||
- Simple et
|
- Simple et
|
||||||
- Non ordonnée.
|
- Non ordonnée.
|
||||||
|
|
||||||
Pour une liste ordonnée, on commence chaque ligne par un chiffre suivit d'un point :
|
Pour une liste ordonnée, on commence chaque ligne par un chiffre suivit d'un
|
||||||
|
point :
|
||||||
```markdown
|
|
||||||
1. Une liste
|
|
||||||
3. Simple mais
|
|
||||||
9. Ordonnée.
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Une liste
|
1. Une liste
|
||||||
3. Simple mais
|
3. Simple mais
|
||||||
9. Ordonnée.
|
9. Ordonnée.
|
||||||
|
|
||||||
L'ordre de la numérotation n'importe pas. Pour ne pas s'ennuyer à réordonner une liste qui peut évoluer, il y a une solution simple :
|
L'ordre de la numérotation n'importe pas. Pour ne pas s'ennuyer à réordonner
|
||||||
|
une liste qui peut évoluer, il y a une solution simple :
|
||||||
```markdown
|
|
||||||
1. Pomme.
|
|
||||||
1. Poire.
|
|
||||||
1. Cerise.
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Pomme.
|
1. Pomme.
|
||||||
1. Poire.
|
1. Poire.
|
||||||
1. Cerise.
|
1. Cerise.
|
||||||
|
|
||||||
Des listes imbriquées plus complexes peuvent être réalisées en ajoutant des espaces devant les lignes des sections inférieures :
|
Des listes imbriquées plus complexes peuvent être réalisées en ajoutant des
|
||||||
|
espaces devant les lignes des sections inférieures :
|
||||||
```markdown
|
|
||||||
1. Une liste
|
|
||||||
1. Ordonnée et
|
|
||||||
- Plus
|
|
||||||
- Complexe
|
|
||||||
1. Voilà.
|
|
||||||
```
|
|
||||||
|
|
||||||
1. Une liste
|
1. Une liste
|
||||||
1. Ordonnée et
|
1. Ordonnée et
|
||||||
|
@ -65,51 +52,52 @@ Des listes imbriquées plus complexes peuvent être réalisées en ajoutant des
|
||||||
|
|
||||||
### La méthode simple
|
### La méthode simple
|
||||||
|
|
||||||
Il y a plusieurs méthodes pour insérer un lien. La plus simple est de mettre le texte du lien entre crochets, suivi de la cible entre parenthèses :
|
Il y a plusieurs méthodes pour insérer un lien. La plus simple est de mettre le
|
||||||
|
texte du lien entre crochets, suivi de la cible entre parenthèses :
|
||||||
|
[site de l'UNIGE](https://unige.ch).
|
||||||
|
|
||||||
```markdown
|
On peut vouloir ajouter un titre à ce lien, qui s'affiche lorsque le curseur
|
||||||
[site de l'UNIGE](https://unige.ch)
|
survol le lien : [site de l'UNIGE](https://unige.ch "site officiel d'UNIGE").
|
||||||
```
|
|
||||||
|
|
||||||
Ce qui donne le lien suivant : [site de l'UNIGE](https://unige.ch).
|
|
||||||
|
|
||||||
On peut vouloir ajouter un titre à ce lien, qui s'affiche lorsque le curseur survol le lien :
|
|
||||||
|
|
||||||
```markdown
|
|
||||||
[site de l'UNIGE](https://unige.ch "site officiel d'UNIGE")
|
|
||||||
```
|
|
||||||
|
|
||||||
Ce qui donne le lien suivant :
|
|
||||||
[site de l'UNIGE](https://unige.ch "site officiel d'UNIGE").
|
|
||||||
|
|
||||||
### Avec les références
|
### Avec les références
|
||||||
|
|
||||||
Une autre méthode existe qui a les avantages suivants :
|
Une autre méthode existe qui a les avantages suivants :
|
||||||
|
|
||||||
- Une même référence (cible du lien) peut être réutilisée plusieurs fois dans le même texte.
|
- Une même référence (cible du lien) peut être réutilisée plusieurs fois dans
|
||||||
|
le même texte.
|
||||||
- La lisibilité du texte est améliorée.
|
- La lisibilité du texte est améliorée.
|
||||||
|
|
||||||
Le texte du lien est toujours entre crochet, mais à la place de la cible entre parenthèse, on ajoute une référence entre crochet. Cette référence, qui peut être un chiffre, une lettre ou un texte, correspond à la cible, définie n'importe où dans le fichier.
|
Le texte du lien est toujours entre crochet, mais à la place de la cible entre
|
||||||
|
parenthèse, on ajoute une référence entre crochet. Cette référence, qui peut
|
||||||
```markdown
|
être un chiffre, une lettre ou un texte, correspond à la cible, définie
|
||||||
[site de l'UNIGE][1]
|
n'importe où dans le fichier.
|
||||||
|
|
||||||
[1]: https://unige.ch "site officiel de l'UNIGE"
|
|
||||||
```
|
|
||||||
|
|
||||||
Ce qui donne le lien suivant : [site de l'UNIGE][1].
|
Ce qui donne le lien suivant : [site de l'UNIGE][1].
|
||||||
|
|
||||||
## Images (fichiers)
|
## Images
|
||||||
|
|
||||||
Pour l'insertion d'une image, on reprend la même syntaxe que pour le lien, en ajoutant un point d'exclamation au début de la ligne :
|
Pour l'insertion d'une image, on reprend la même syntaxe que pour le lien, en
|
||||||
|
ajoutant un point d'exclamation au début de la ligne :
|
||||||
|
|
||||||

|

|
||||||
|
|
||||||
Le lien pour l'image peut être une URL ou un chemin vers un fichier local. Et la syntaxe avec la référence est possible aussi :
|
Le lien pour l'image peut être une URL ou un chemin vers un fichier local. Et
|
||||||
|
la syntaxe avec la référence est possible aussi :
|
||||||
|
|
||||||
![Légende de l'image][2]
|
![Légende de l'image][2]
|
||||||
|
|
||||||
|
## Les tableaux
|
||||||
|
|
||||||
|
Pour les tableaux, il est fortement conseillé d'utiliser un [générateur][3].
|
||||||
|
|
||||||
|
| No | Fruits | Quantité | Qualité |
|
||||||
|
|----|-----------:|----------|:-------:|
|
||||||
|
| 1 | Pommes | Un peu | 🙁 |
|
||||||
|
| 2 | Poires | Plus | 😊 |
|
||||||
|
| 3 | Framboises | Beaucoup | 😋 |
|
||||||
|
|
||||||
|
<!-- références -->
|
||||||
|
|
||||||
[1]: https://unige.ch "site officiel de l'UNIGE"
|
[1]: https://unige.ch "site officiel de l'UNIGE"
|
||||||
[2]: ./static/logo-md.svg
|
[2]: ./static/logo-md.svg "logo de Markdown"
|
||||||
|
[3]: https://www.tablesgenerator.com/markdown_tables
|
||||||
|
|
Loading…
Reference in New Issue