Markdown

Les wikis et les pads 1) et les plateformes Git utilisent généralement la syntaxe Markdown 2) Mais il existe aussi d'autres syntaxes de type «markdown», comme celle de Dokuwiki qu'utilise ce wiki.

«Écrire» en Markdown, c'est «mélanger» du texte en français (ou en anglais, en italien…) et des «éléments de syntaxe», pour «mettre en page», c'est-à-dire générer des éléments Html, et composer une «page web» simplement. On peut par exemple, générer des hyperliens facilement3) voir plus bas .

Syntaxe

Par exemple, pour «écrire» des titres (1 dièse #)

Titre

# À titre d'exemple

Des sous-titres (2 dièses ##)

## Sous les titres, encore des titres

Liens

Des liens ( [le nom du lien] entre crochets [] et (l'adresse du lien) entre parenthèses () )

[lien vers le canard blanc 🦆](https://ddg.gg)

pour générer le lien lien vers le canard blanc 🦆

Liste

Liste simplifiée de la syntaxe Markdown

Pour découvrir comment ont été rédigées les pages sur Sloyd, cliquer sur le bouton Brut des fichiers README.md. Par exemple, voici la source de cette page.

Moteur

On peut écrire en Markdown en connaissant quelques notions de bases pour créer des titres, insérer des images et des liens. Il suffit d'apprendre environ 5 éléments de syntaxe (voir plus haut) et cela suffit à produire des documents sous la forme de pages web.

Pour des usages un peu plus avancés, il faut consulter la documentation officielle. On apprend notamment que le moteur de rendu des pages s'appelle Goldmark et qu'il est basé sur une variante de la syntaxe Markdown nommée Commonmark. Plus précisément, il s'agit de la version 3 de la syntaxe.

Dans la documentation Commonmark, nous pouvons apprendre dans le détail comment la syntaxe est interprétée. La documentation intègre des « petits moteurs d'évaluation » de la syntaxe, comme dans cet exemple où l'on voit que l'on peut écrire le symbole 3/4 grâce à la syntaxe &frac34;. Un autre exemple nous montre comment ajouter des éléments de style, comme ici un texte de couleur bleue. Pour tester tous ces exemples, il suffit de cliquer sur le bouton Try it. Une fois que vous avez compris comment ils fonctionnent, vous pouvez intégrer ces nouveaux éléments dans vos propres pages Markdown de la plateforme. Pensez à utiliser la fonction « prévisualisation » qui vous permet de tester ces éléments de syntaxe avant d'enregistrer vos fichiers.