Pour afficher des titres, utilisez des #
selon le niveau de hiérarchie :
# Titre de premier niveau
## Titre de second niveau
### Titre de troisième niveau
etc.
Vous pouvez afficher des listes ordonnées avec un chiffre suivi d'un point au début de chaque ligne :
1. D'abord
2. Ensuite
3. Enfin
ou des listes non-ordonnées en utilisant *
ou -
au début de chaque ligne :
* Chou
* Carotte
* Betterave
Vous pouvez afficher une ligne horizontale permettant de séparer différentes sections ainsi :
---
Pour afficher un lien, entourez le texte à afficher de crochets []
puis ajoutez le lien entre parenthèses ()
:
[Le site Hello Harel](https://www.helloharel.com)
Les images fonctionnent sur le même principe, mais précédées d'un point d'exclamation !
. Le texte saisi est alors le texte alternatif de l'image (si l'image ne charge pas correctement) :
![Logo Hello Harel](https://www.helloharel.com/images/logo.svg)
Si vous souhaitez afficher une adresse e-mail sur une page publique, utilisez un lien auto-généré :
<spam@helloharel.com>
Cette syntaxe affichera l'adresse e-mail sous la forme d'un lien cliquable, mais le contenu sera généré de manière à être plus difficilement lisible par les robots spammeurs !
Vous pouvez mettre en forme certaines parties du texte grâce aux marquages suivants :
Cette phrase contient du texte en *italique* et en **gras**.
Vous pouvez afficher des icônes grâce au marquage suivant :
Une icône de produit : { icon products-product}
Une croix rouge : { icon no, color=red}
Un bouton situé dans la barre d'édition vous permet de voir les icônes existantes et de rechercher parmi leurs noms.
Les icônes peuvent avoir les couleurs suivantes :
blue
green
yellow
red
black
white
gray
grey
lightblue
purple
Pour décrire un bouton, vous pouvez utiliser le marquage suivant :
Un bouton contenant une icône "Ajouter" : { button add}
Un bouton vert avec une icône et du texte : { button add, name=Ajouter un produit, type=success}
Les boutons peuvent avoir les styles suivants :
primary
success
warning
danger
info
Vous pouvez indiquer des raccourcis claviers ainsi :
{ key ctrl + up}
{ key ctrl + S}
Pour les touches spéciales, utilisez les noms anglais : ↑ arrow-up
, → arrow-right
, ↵ enter
ou return
, ⌫ delete
, ⇧ shift
.
Pour indiquer un chemin à suivre, vous pouvez utiliser le marquage suivant :
{ nav Produits, icon=products-product > Catégories de produit, icon=products-category > Sélectionner une catégorie, style=action > Produits, style=tab}