Several corrections + copy english markdown page format.

This commit is contained in:
boissonnfive 2018-06-26 23:17:27 +02:00
parent a5f04d7e53
commit ee013dd2da

View File

@ -10,48 +10,64 @@ Markdown a été créé par John Gruber en 2004. Il se veut être d'une syntaxe
facile à lire et à écrire, aisément convertible en HTML facile à lire et à écrire, aisément convertible en HTML
(et beaucoup d'autres formats aussi à présent). (et beaucoup d'autres formats aussi à présent).
Faites moi autant de retours que vous voulez! Sentez vous libre de "forker" Le Markdown est implémenté de différentes manières, selon le parser.
et envoyer des pull request! Ce guide va alors tenter de trier les fonctionnalités universelles de celles
spécifiques à un parser.
- [HTML](#html)
- [Titres](#titres)
- [Formatage simple du texte](#formatage-simple-du-texte)
- [Les paragraphes](#les-paragraphes)
- [Les listes](#les-listes)
- [Insertion de code](#insertion-de-code)
- [Ligne Horizontale](#ligne-horizontale)
- [Liens](#liens)
- [Images](#images)
- [Divers](#divers)
```md ## HTML
<!-- Markdown est une sorte de cousin du HTML, si bien que tout document HTML
Markdown est une sorte de cousin du HTML, si bien que tout document HTML
est un document Markdown valide. Autrement dit, vous pouvez utiliser des est un document Markdown valide. Autrement dit, vous pouvez utiliser des
balises HTML dans un fichier Markdown, comme la balise commentaire dans balises HTML dans un fichier Markdown, comme la balise commentaire dans
laquelle nous sommes à présent, car celle-ci ne sera pas affectée par laquelle nous sommes à présent, car celle-ci ne sera pas affectée par
le parser( analyseur syntaxique ) Markdown. --> le parser( analyseur syntaxique ) Markdown.
<!-- Toutefois, si vous voulez créer un élément HTML dans un fichier Markdown, ```md
<!-- Autrement dit, vous pouvez utiliser des balises HTML dans un fichier Markdown, comme la balise commentaire dans laquelle nous sommes à présent, car celle-ci ne sera pas affectée par le parser( analyseur syntaxique ) Markdown. Toutefois, si vous voulez créer un élément HTML dans un fichier Markdown,
vous ne pourrez pas utiliser du Markdown à l'intérieur de ce dernier. --> vous ne pourrez pas utiliser du Markdown à l'intérieur de ce dernier. -->
```
<!-- Le Markdown est implémenté de différentes manières, selon le parser.
Ce guide va alors tenter de trier les fonctionnalités universelles de celles
spécifiques à un parser. -->
<!-- Headers ( En-têtes ) --> ## Titres
<!-- Vous pouvez facilement créer des éléments HTML <h1> à <h6> en précédant
le texte de votre futur titre par un ou plusieurs dièses ( # ), de un à six, Vous pouvez facilement créer des éléments HTML `<h1>` à `<h6> en précédant le texte de votre futur titre par un ou plusieurs dièses ( # ), de un à six, selon le niveau de titre souhaité.
selon le niveau de titre souhaité. -->
```md
# Ceci est un <h1> # Ceci est un <h1>
## Ceci est un <h2> ## Ceci est un <h2>
### Ceci est un <h3> ### Ceci est un <h3>
#### Ceci est un <h4> #### Ceci est un <h4>
##### Ceci est un <h5> ##### Ceci est un <h5>
###### Ceci est un <h6> ###### Ceci est un <h6>
```
<!--
Markdown fournit également une façon alternative de marquer les h1 et h2 Markdown fournit également une façon alternative de marquer les h1 et h2
-->
```md
Ceci est un h1 Ceci est un h1
============= =============
Ceci est un h2 Ceci est un h2
------------- -------------
```
<!-- Styles basiques pour du texte --> ## Formatage simple du texte
<!-- On peut facilement rendre un texte "gras" ou "italique" en Markdown -->
On peut facilement rendre un texte "gras" ou "italique" en Markdown
```md
*Ce texte est en italique.* *Ce texte est en italique.*
_Celui-ci aussi._ _Celui-ci aussi._
@ -61,15 +77,23 @@ __Celui-là aussi.__
***Ce texte a les deux styles.*** ***Ce texte a les deux styles.***
**_Pareil ici_** **_Pareil ici_**
*__Et là!__* *__Et là!__*
```
<!-- Dans le "GitHub Flavored Markdown", utilisé pour interpréter le Markdown
sur GitHub, on a également le strikethrough ( texte barré ) : -->
Dans le Markdown de GitHub, utilisé pour interpréter le Markdown
sur GitHub, on a également le strikethrough ( texte barré ) :
```md
~~Ce texte est barré avec strikethrough.~~ ~~Ce texte est barré avec strikethrough.~~
```
<!-- Les Paragraphes sont représentés par une ou plusieurs lignes de texte
séparées par une ou plusieurs lignes vides. -->
## Les paragraphes
Les Paragraphes sont représentés par une ou plusieurs lignes de texte
séparées par une ou plusieurs lignes vides.
```md
Ceci est un paragraphe. Là, je suis dans un paragraphe, facile non? Ceci est un paragraphe. Là, je suis dans un paragraphe, facile non?
Maintenant je suis dans le paragraphe 2. Maintenant je suis dans le paragraphe 2.
@ -77,19 +101,21 @@ Je suis toujours dans le paragraphe 2!
Puis là, eh oui, le paragraphe 3! Puis là, eh oui, le paragraphe 3!
```
<!--
Si jamais vous souhaitez insérer une balise HTML <br />, vous pouvez ajouter Si jamais vous souhaitez insérer une balise HTML <br />, vous pouvez ajouter
un ou plusieurs espaces à la fin de votre paragraphe, et en commencer un ou plusieurs espaces à la fin de votre paragraphe, et en commencer
un nouveau. un nouveau.
-->
```md
J'ai deux espaces vides à la fin (sélectionnez moi pour les voir). J'ai deux espaces vides à la fin (sélectionnez moi pour les voir).
Bigre, il y a un <br /> au dessus de moi! Bigre, il y a un <br /> au dessus de moi!
```
<!-- Les 'Blocs de Citations' sont générés aisément, grâce au caractère > --> Les 'Blocs de Citations' sont générés aisément, grâce au caractère `>`
```md
> Ceci est une superbe citation. Vous pouvez même > Ceci est une superbe citation. Vous pouvez même
> revenir à la ligne quand ça vous chante, et placer un `>` > revenir à la ligne quand ça vous chante, et placer un `>`
> devant chaque bout de ligne faisant partie > devant chaque bout de ligne faisant partie
@ -99,11 +125,14 @@ Bigre, il y a un <br /> au dessus de moi!
> Vous pouvez aussi utiliser plus d'un niveau > Vous pouvez aussi utiliser plus d'un niveau
>> d'imbrication! >> d'imbrication!
> Classe et facile, pas vrai? > Classe et facile, pas vrai?
```
<!-- les Listes -->
<!-- les Listes non ordonnées sont marquées par des asterisques,
signes plus ou signes moins. -->
## Les listes
les Listes non ordonnées sont marquées par des asterisques, signes plus ou signes moins.
```md
* Item * Item
* Item * Item
* Un autre item * Un autre item
@ -119,171 +148,201 @@ ou
- Item - Item
- Item - Item
- Un dernier item - Un dernier item
```
<!-- les Listes Ordonnées sont générées via un nombre suivi d'un point --> les Listes Ordonnées sont générées via un nombre suivi d'un point
```md
1. Item un 1. Item un
2. Item deux 2. Item deux
3. Item trois 3. Item trois
```
<!-- Vous pouvez même vous passer de tout numéroter, et Markdown générera Vous pouvez même vous passer de tout numéroter, et Markdown générera les bons chiffres. Ceci dit, cette variante perd en clarté.
les bons chiffres. Ceci dit, cette variante perd en clarté.-->
```md
1. Item un 1. Item un
1. Item deux 1. Item deux
1. Item trois 1. Item trois
<!-- ( cette liste sera interprétée de la même façon que celle au dessus ) --> ```
<!-- Vous pouvez également utiliser des sous-listes --> (cette liste sera interprétée de la même façon que celle au-dessus)
Vous pouvez également utiliser des sous-listes
```md
1. Item un 1. Item un
2. Item deux 2. Item deux
3. Item trois 3. Item trois
* Sub-item * Sub-item
* Sub-item * Sub-item
4. Item quatre 4. Item quatre
```
<!-- Il y a même des "listes de Taches". Elles génèrent des champs HTML Il y a même des "listes de Taches". Elles génèrent des champs HTML de type checkbox. Les [ ] ci-dessous, n'ayant pas de [ x ], deviendront des cases à cocher HTML non-cochées.
de type checkbox. -->
Les [ ] ci dessous, n'ayant pas de [ x ],
deviendront des cases à cocher HTML non-cochées.
```md
- [ ] Première tache à réaliser. - [ ] Première tache à réaliser.
- [ ] Une autre chose à faire. - [ ] Une autre chose à faire.
La case suivante sera une case à cocher HTML cochée. La case suivante sera une case à cocher HTML cochée.
- [x] Ça ... c'est fait! - [x] Ça ... c'est fait!
```
<!-- les Blocs de Code -->
<!-- Pour marquer du texte comme étant du code, il suffit de commencer
chaque ligne en tapant 4 espaces (ou un Tab) -->
## Insertion de code
Pour marquer du texte comme étant du code, il suffit de commencer
chaque ligne en tapant 4 espaces (ou un Tab).
```md
echo "Ça, c'est du Code!"; echo "Ça, c'est du Code!";
var Ça = "aussi !"; var Ça = "aussi !";
```
<!-- L'indentation par tab ou série de quatre espaces L'indentation par tab ou série de quatre espaces fonctionne aussi à l'intérieur du bloc de code.
fonctionne aussi à l'intérieur du bloc de code -->
```md
my_array.each do |item| my_array.each do |item|
puts item puts item
end end
```
<!-- Des bouts de code en mode 'inline' s'ajoutent en les entourant de ` --> On peut insérer du code dans le texte des paragraphes en entourant le code par des `.
```md
La fonction `run()` ne vous oblige pas à aller courir! La fonction `run()` ne vous oblige pas à aller courir!
```
<!-- Via GitHub Flavored Markdown, vous pouvez utiliser En Markdown GitHub, vous pouvez utiliser des syntaxes spécifiques.
des syntaxes spécifiques -->
\`\`\`ruby
<!-- mais enlevez les backslashes quand vous faites ça,
gardez juste ```ruby ( ou nom de la syntaxe correspondant à votre code )-->
def foobar
puts "Hello world!"
end
\`\`\` <!-- pareil, pas de backslashes, juste ``` en guise de fin -->
<-- Pas besoin d'indentation pour le code juste au dessus, de plus, GitHub ```ruby
va utiliser une coloration syntaxique pour le langage indiqué après les ``` --> def foobar
puts "Hello world!"
end
```
<!-- Ligne Horizontale (<hr />) --> Pas besoin d'indentation pour le code juste au dessus, de plus, GitHub
<!-- Pour en insérer une, utilisez trois ou plusieurs astérisques ou tirets, va utiliser une coloration syntaxique pour le langage indiqué après les ```.
avec ou sans espaces entre chaque un. -->
## Ligne Horizontale
Pour en insérer une, utilisez trois ou plusieurs astérisques ou tirets,
avec ou sans espaces entre chaque un.
```md
*** ***
--- ---
- - - - - -
**************** ****************
```
<!-- Liens --> ## Liens
<!-- Une des fonctionnalités sympathiques du Markdown est la facilité
d'ajouter des liens. Le texte du lien entre [ ], l'url entre ( ),
et voilà l'travail.
-->
Une des fonctionnalités sympathiques du Markdown est la facilité d'ajouter des liens. Le texte du lien entre [ ], l'url entre ( ), et voilà l'travail.
```md
[Clic moi!](http://test.com/) [Clic moi!](http://test.com/)
```
<!-- Pour ajouter un attribut Title, collez-le entre guillemets, avec le lien.
Pour ajouter un attribut Title, collez le entre guillemets, avec le lien.
-->
```md
[Clic moi!](http://test.com/ "Lien vers Test.com") [Clic moi!](http://test.com/ "Lien vers Test.com")
```
<!-- les Liens Relatifs marchent aussi --> Les Liens Relatifs marchent aussi.
```md
[En avant la musique](/music/). [En avant la musique](/music/).
```
<!-- Les liens façon "références" sont eux aussi disponibles en Markdown --> Les liens façon "références" sont eux aussi disponibles en Markdown.
```md
[Cliquez ici][link1] pour plus d'information! [Cliquez ici][link1] pour plus d'information!
[Regardez aussi par ici][foobar] si vous voulez. [Regardez aussi par ici][foobar] si vous voulez.
[link1]: http://test.com/ "Cool!" [link1]: http://test.com/ "Cool!"
[foobar]: http://foobar.biz/ "Alright!" [foobar]: http://foobar.biz/ "Alright!"
```
<!-- Le titre peut aussi être entouré de guillemets simples, Le titre peut aussi être entouré de guillemets simples, entre parenthèses ou absent. Les références peuvent être placées un peu où vous voulez dans le document, et les identifiants (link1, foobar, ...) pevent être n'importe quoi tant qu'ils sont uniques.
entre parenthèses ou absent. Les références peuvent être placées
un peu où vous voulez dans le document, et les identifiants
(link1, foobar, ...) quoi que ce soit tant qu'ils sont uniques -->
<!-- Il y a également le "nommage implicite" qui transforme le texte du lien Il y a également le "nommage implicite" qui transforme le texte du lien en identifiant.
en identifiant -->
```md
[Ceci][] est un lien. [Ceci][] est un lien.
[ceci]: http://ceciestunlien.com/ [ceci]: http://ceciestunlien.com/
```
<!-- mais ce n'est pas beaucoup utilisé. --> mais ce n'est pas beaucoup utilisé.
<!-- Images --> ## Images
<!-- Pour les images, la syntaxe est identique aux liens, sauf que précédée
d'un point d'exclamation! -->
Pour les images, la syntaxe est identique aux liens, sauf que précédée d'un point d'exclamation!
```md
![Attribut ALT de l'image](http://imgur.com/monimage.jpg "Titre optionnel") ![Attribut ALT de l'image](http://imgur.com/monimage.jpg "Titre optionnel")
```
<!-- Là aussi, on peut utiliser le mode "références" --> Là aussi, on peut utiliser le mode "références".
```md
![Ceci est l'attribut ALT de l'image][monimage] ![Ceci est l'attribut ALT de l'image][monimage]
[monimage]: relative/urls/cool/image.jpg "si vous voulez un titre, c'est ici." [monimage]: relative/urls/cool/image.jpg "si vous voulez un titre, c'est ici."
```
<!-- Divers -->
<!-- Liens Automatiques -->
## Divers
### Liens Automatiques
```md
<http://testwebsite.com/> est équivalent à : <http://testwebsite.com/> est équivalent à :
[http://testwebsite.com/](http://testwebsite.com/) [http://testwebsite.com/](http://testwebsite.com/)
```
<!-- Liens Automatiques pour emails --> ### Liens Automatiques pour emails
```md
<foo@bar.com> <foo@bar.com>
```
<!-- Escaping --> ### Caractères d'échappement
Il suffit de précéder les caractères spécifiques à ignorer par des backslash \
Pour taper *ce texte* entouré d'astérisques mais pas en italique : Il suffit de précéder les caractères spécifiques à ignorer par des anti slash `\`.`
Tapez \*ce texte\*.
<!-- Tableaux --> ```md
<!-- les Tableaux ne sont disponibles que dans le GitHub Flavored Markdown Pour taper *ce texte* entouré d'astérisques mais pas en italique : Tapez \*ce texte\*.
et c'est ce n'est pas super agréable d'utilisation. ```
Mais si vous en avez besoin :
-->
### Tableaux
Les Tableaux ne sont disponibles que dans le GitHub Flavored Markdown et c'est ce n'est pas super agréable d'utilisation. Mais si vous en avez besoin :
```md
| Col1 | Col2 | Col3 | | Col1 | Col2 | Col3 |
| :----------- | :------: | ------------: | | :----------- | :------: | ------------: |
| Alignement Gauche | Centé | Alignement Droite | | Alignement Gauche | Centé | Alignement Droite |
| bla | bla | bla | | bla | bla | bla |
```
<!-- ou bien, pour un résultat équivalent : --> ou bien, pour un résultat équivalent :
```md
Col 1 | Col2 | Col3 Col 1 | Col2 | Col3
:-- | :-: | --: :-- | :-: | --:
Ough que c'est moche | svp | arrêtez Ough que c'est moche | svp | arrêtez
<!-- Fin! -->
``` ```
Pour plus d'information : ***
consultez [ici](http://daringfireball.net/projects/markdown/syntax) le post officiel de Jhon Gruber à propos de la syntaxe,
et [](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) la superbe cheatsheet de Adam Pritchard. Pour plus d'information, consultez [ici](http://daringfireball.net/projects/markdown/syntax) le post officiel de John Gruber à propos de la syntaxe, et [](https://github.com/adam-p/markdown-here/wiki/Markdown-Cheatsheet) la superbe cheatsheet de Adam Pritchard.
***
Faites moi autant de retours que vous voulez! Sentez vous libre de "forker"
et envoyer des pull request!