Style Guide
Tu peux écrire du contenu avec la syntaxe Markdown de GitHub.
#
Syntaxe MarkdownPour servir de page d'exemple lors de la mise en page des sites Docusaurus basés sur markdown.
#
En-têtes#
H1 - Créer la meilleure documentation#
H2 - Créer la meilleure documentation#
H3 - Créer la meilleure documentation#
H4 - Créer la meilleure documentation#
H5 - Créer la meilleure documentation#
H6 - Créer la meilleure documentation#
EmphasisEmphasis, aka italique, avec astérisques ou tirets bas.
Soulignement fort, alias gras, avec astérisques ou traits de soulignement.
Mise en valeur combinée avec astérisques et tirets bas.
Strikethrough utilise deux tildes. ~Scratch ceci.
#
Listes- Premier élément de la liste ordonnée
- Un autre élément
- Sous-liste non ordonnée.
- Les nombres réels n'ont pas d'importance, juste qu'il s'agit d'un nombre
- Sous-liste ordonnée
- Et un autre élément.
- La liste non ordonnée peut utiliser des astérisques
- Ou moins
- Ou plus
#
LiensJe suis un lien de style en ligne avec le titre
Je suis un lien de style de référence
Vous pouvez utiliser des numéros pour les définitions de liens de style de référence
Ou laissez-le vide et utilisez le texte du lien lui-même.
Les URLs et les URL entre parenthèses seront automatiquement transformées en liens. http://www.example.com/ ou http://www.example.com/ et parfois example.com (mais pas sur GitHub, par exemple).
Un texte pour montrer que les liens de référence peuvent suivre plus tard.
#
ImagesVoici notre logo (survolez pour voir le texte du titre) :
Style en ligne :
Style de référence : ![texte alt][logo]
Les images de n'importe quel dossier peuvent être utilisées en fournissant le chemin vers le fichier.
#
Code#
TablesLes deux points peuvent être utilisés pour aligner les colonnes.
Tables | Sont | Cool |
---|---|---|
le col 3 est | aligné à droite | \$1600 |
le col 2 est | centré | \$12 |
rayures zèbres | sont soignés | \$1 |
Il doit y avoir au moins 3 tirets séparant chaque cellule d'en-tête. Les tuyaux extérieurs (|) sont optionnels, et vous n'avez pas besoin de faire monter la ligne Markdown brute. Vous pouvez également utiliser le Markdown en ligne.
Markdown | Moins | Jolie |
---|---|---|
En cours | renders | joliment |
1 | 2 | 3 |
#
GuillemetsLes citations sont très pratiques dans les e-mails pour émuler le texte de réponse. Cette ligne fait partie du même guillemet.
Fin de citation.
Il s'agit d'une ligne très longue qui sera toujours citée correctement lorsqu'elle sera incluse. Oh garçon continuons à écrire pour s'assurer que c'est assez long pour vraiment envelopper pour tout le monde. Oh, vous pouvez mettre Markdown dans un blockquote.
#
HTML en ligne- Liste des définitions
- Est quelque chose que les gens utilisent parfois.
- Markdown en HTML
- Ne fonctionne *pas* **très** bien. Utilisez les balises HTML .
#
Interruptions de ligneVoici une ligne pour que nous puissions commencer.
Cette ligne est séparée de celle ci-dessus par deux nouvelles lignes, donc ce sera un paragraphe séparé.
Cette ligne est également un paragraphe séparé, mais... Cette ligne n'est séparée que par une seule nouvelle ligne, donc c'est une ligne séparée dans le même paragraphe.
#
Admonitionsnote
Ceci est une note
tip
Ceci est une astuce
important
Ceci est important
caution
Ceci est une précaution
warning
Ceci est un avertissement