Syntaxe Markdown¶
Sur Hoplageiss!, les champs de contenu détaillé (descriptions de
roadbook, étapes, lieux, segments) acceptent du Markdown. Le
Markdown est du texte ordinaire dans lequel quelques caractères (**,
#, -, etc.) servent à indiquer une mise en forme : un mot en gras,
un titre, une liste, un lien... Lors de l'affichage, ces caractères sont
remplacés par la mise en forme correspondante.
L'éditeur propose deux onglets :
- Écrire : vous saisissez votre texte avec sa syntaxe Markdown.
- Aperçu : vous voyez le rendu final tel qu'il apparaîtra aux lecteurs.
La barre d'outils couvre les cas les plus courants (gras, italique, titre, liste, citation, lien). Cette page documente l'ensemble des éléments utiles, y compris ceux qui ne sont pas accessibles via la barre d'outils.
Paragraphes et sauts de ligne¶
Un paragraphe est un bloc de texte séparé du suivant par une ligne vide. Un simple retour à la ligne ne suffit pas : à l'affichage, il sera ignoré et la phrase suivante collée à la précédente.
Voici un premier paragraphe.
Voici un second paragraphe, séparé par une ligne vide.
Ce retour à la ligne, lui, sera ignoré.
Pour forcer un saut de ligne à l'intérieur d'un même paragraphe (cas
rare), terminez la ligne par un antislash \ :
Première ligne.
Deuxième ligne, sans nouveau paragraphe.
Titres¶
Les titres se créent avec plusieurs #. Le nombre de # indique le
niveau du titre : ## crée un sous-titre, ### un sous-sous-titre,
et ainsi de suite jusqu'à ######.
Exception
Le titre principal (# ...) de la page est déjà défini par le nom
du roadbook, du segment ou du lieu. Dans votre contenu, commencez
donc vos titres au niveau 2 (## ...).
Si vous utilisez #, il ne sera pas interprété comme un titre ; le
texte sera affiché tel quel.
Laissez toujours un espace entre les # et le texte du titre.
Note
Vos titres sont automatiquement réajustés pour s'imbriquer
correctement sous le titre de la page sur laquelle ils
s'affichent (une étape de roadbook a déjà son propre titre, par
exemple). Vous n'avez pas à anticiper ce décalage : partez de
## pour vos sous-titres et la hiérarchie relative de vos
titres est conservée.
Mise en forme du texte¶
| Source | Résultat |
|---|---|
**gras** |
gras |
_italique_ |
italique |
~~barré~~ |
Les boutons correspondants sont disponibles dans la barre d'outils. Les
styles peuvent se combiner : **_gras et italique_** donne gras et
italique.
Listes¶
Une liste à puces commence chaque ligne par - suivi d'un espace.
Une liste numérotée commence chaque ligne par un chiffre suivi d'un
point. Vous pouvez d'ailleurs écrire 1. sur chaque ligne : la
numérotation finale suivra l'ordre des lignes. Pratique pour réorganiser
une liste sans avoir à renuméroter à la main.
Pour imbriquer une sous-liste, indentez les lignes filles de quatre
espaces. La même règle fonctionne pour les listes à puces (-) et les
listes numérotées (1.).
S'affiche ainsi :
-
Étape principale
- Sous-étape
- Autre sous-étape
- Étape suivante
Citations¶
Préfixez chaque ligne par > pour citer un texte. Utile pour mettre en
avant un avis, une recommandation locale, ou un avertissement.
S'affiche ainsi :
La D908 entre Saint-Jean-Pied-de-Port et Larrau est superbe, mais évitez-la par temps de pluie.
Pour imbriquer une citation dans une autre, doublez le préfixe : > >.
Séparateurs¶
Trois tirets ou plus, seuls sur une ligne et entourés de lignes vides, créent une ligne horizontale qui sépare visuellement deux blocs de contenu.
Liens¶
Un lien s'écrit [texte affiché](adresse). Le bouton "Lien" de la barre
d'outils insère ce gabarit avec url comme marque-place, qu'il vous
suffit ensuite de remplacer.
Donne :
Le tracé sur OpenStreetMap vaut le détour.
Les liens vers des sites externes (adresses commençant par http:// ou
https://) s'ouvrent automatiquement dans un nouvel onglet, pour ne pas
faire perdre la page Hoplageiss! au lecteur. Les liens internes au site,
eux, restent dans l'onglet courant.
Adresses détectées automatiquement¶
Une URL ou une adresse e-mail écrite telle quelle dans le texte est
automatiquement transformée en lien cliquable. Vous pouvez aussi
l'entourer de chevrons <...> pour la même chose, en plus explicite.
Liens longs (références)¶
Quand une adresse est longue ou réutilisée plusieurs fois, vous pouvez la sortir du texte courant sous la forme d'une référence. Le repère entre crochets dans le texte renvoie alors à une définition placée plus bas dans le contenu, à la manière d'une note de bas de page.
Le [tracé du GR10][gr10] traverse les Pyrénées d'ouest en est.
On peut aussi consulter la [carte interactive][gr10].
[gr10]: https://www.ffrandonnee.fr/itineraires/gr10
Le repère (gr10 ici) n'apparaît pas à l'écran ; seul le texte entre
les premiers crochets est affiché.
Tableaux¶
Les tableaux se construisent avec des barres verticales |. La première
ligne contient les en-têtes, la deuxième sépare les en-têtes du corps
avec des tirets, et chaque ligne suivante est une ligne du tableau.
L'alignement des colonnes se contrôle avec le caractère : :
:--aligne à gauche (le défaut),:--:centre,--:aligne à droite.
| Col. gauche | Col. centrée | Col. droite |
| :---------- | :----------: | ----------: |
| ligne 1 | valeur | 100 |
| ligne 2 | autre valeur | 42 |
Ce qui donne :
| Col. gauche | Col. centrée | Col. droite |
|---|---|---|
| ligne 1 | valeur | 100 |
| ligne 2 | autre valeur | 42 |
Les tableaux s'adaptent aux petits écrans : si le contenu est trop large, ils défilent horizontalement.
Notes de bas de page¶
Une note de bas de page s'ajoute en deux temps : un repère [^1] dans
le texte, puis la note elle-même, écrite sur sa propre ligne sous la
forme [^1]: contenu de la note. Le repère peut être un chiffre ou un
mot ; l'important est qu'il soit unique dans le champ de contenu.
La meilleure saison reste l'automne[^saison].
[^saison]: D'avril à octobre, les routes sont praticables mais
surchargées les week-ends.
Les notes apparaissent regroupées en bas du contenu, avec un lien de retour vers leur position dans le texte1.
Échapper la syntaxe¶
Pour afficher un caractère réservé du Markdown (par exemple * ou #)
sans déclencher la mise en forme, précédez-le d'un antislash \ :
Ce qui n'est pas pris en charge¶
- Images : la syntaxe
est ignorée. Pour illustrer votre contenu, utilisez l'outil d'envoi de photos prévu à cet effet. - HTML brut : si vous saisissez
<div>,<script>ou tout autre balisage HTML, il sera affiché tel quel et non interprété. C'est un choix volontaire, pour des raisons de sécurité. - Titre de niveau 1 : le
#seul est réservé au titre de la page ; saisi dans le contenu, il est affiché tel quel et non interprété comme un titre.
-
Ceci est un exemple note de bas de page ! ↩