Fichier exemple (ceci est un titre)

Généralités

Les commentaires sont constitués d’une ligne entière (retour à la ligne compris) débutant avec le caractère %. Toutefois, il est vivement recommandé de débuter tous ses commentaires avec la syntaxe %-, afin de laisser le préfixe % suivi d’un autre caractère pour l’usage d’un traitement de macros externe. 

%- Ceci est un commentaire.

ne produira rien en sortie.

Les blocs sont indentés de 2 par rapport au niveau précédent. Des lignes de même nature à la suite forment un même bloc. Les lignes vides séparent les paragraphes mais ne brisent pas la portée des blocs. 

Ceci est un paragraphe.

donne :

Ceci est un paragraphe.

Les titres

Les titres sont précédés d’autant de signe égal que leur niveau de profondeur. Actuellement, les titres doivent tenir sur une ligne. 

= Titre 1

== Titre 2

...

===== Titre 5

donne :

Titre 1

Titre 2

…

Titre 5

Listes

Plusieurs variations sur les listes sont disponibles. Une liste peut être une liste non ordonnée, une liste hiérarchique (une liste non ordonnée destinée à représenter des arbres, juste une variation stylistique des listes habituelles, typiquement avec un emboîtement plus uniforme, sans marges, etc.), ou une liste ordonnée. De plus, une liste peut être simple ou complexe. Une liste simple est une liste qui ne contient que des éléments textuels. Uhe liste complexe peut contenir des paragraphes, d’autres, listes, etc.

La reconnaissance des listes dépend du préfixe qui introduit les éléments de chaque type. - est utilisé pour les listes non ordonnées, + pour les arbres, <nombre>. pour les listes ordonnées, et :<label>: pour les listes descriptives.

Une liste simple place tous ses éléments à la suite, sans laisser de ligne blanche. 

- banane
- poire
- mangue
  (mon fruit favori !)

donne :

  • banane
  • poire
  • mangue (mon fruit favori !)

Tandis que : 

- lorem

- ipsum

- lorem

  ipsum

donne :

  • lorem

  • ipsum

  • lorem

    ipsum

Un petit exemple d’arbre : 

+ \/
  + usr
    + bin
  + dev
  + etc

donne :

  • /
    • usr
      • bin
    • dev

    • etc

Et une petite liste ordonnée : 

1. premier
2. second
3. troisième

donne :

  1. premier
  2. second
  3. troisième

Ou encore : 

1. paragraphe
  suite du paragraphe (indentation de *deux*)

2. paragraphe

  un autre paragraphe

3. paragraphe

donne :

  1. paragraphe suite du paragraphe (indentation de deux)

  2. paragraphe

    un autre paragraphe

  3. paragraphe

Et une petite liste descriptive pour finir : 

: foo : bar
: bar : baz
: baz : foo

donne :

foo
bar
bar
baz
baz
foo

Tableaux

Les tableaux en mdown sont limités à du contenu textuel ; aucune structure (pas même un paragraphe) n’y est acceptée.

Un tableau est constitué de lignes. Chaque ligne est introduite par le caractère | ; à l’intérieur de la ligne, les cellules sont séparées par des barres verticales de même |. Si une ligne de tableau continue sur plusieurs lignes du fichier, celles-ci doivent être correctement indentées et le séparateur | ne doit pas être le premier caractère d’une ligne de continuation.

a b c d
foo bar baz beu
lala lola lila lili

Citations

Les citations sont introduites, comme dans les e-mails, par des symboles >. Chaque ligne peut être préfixée, ou laissée avec l’indentation seule. 

> Ceci est une citation
  sur plusieurs
> lignes.

> Elle peut contenir des éléments mdown divers.
  Comme une liste :

> - ici
> - et là

donne :

Ceci est une citation sur plusieurs lignes.

Elle peut contenir des éléments mdown divers. Comme une liste :

  • ici
  • et là

Blocs verbatim

Un bloc verbatim est simplement indenté par rapport au reste. À l’heure actuelle les tabulations ne sont pas bien supportées, à ne pas utiliser. 

  #include <stdio.h>

  int main(void)
  {
          printf("Hello world!\n");
          return 0;
  }

donne : 

#include <stdio.h>

int main(void)
{
        printf("Hello world!\n");
        return 0;
}

Séparateurs

Un séparateur horizontal peut être obtenu à l’aide d’un caractère ^L (line feed, qui correspond à C-l, C-q C-l pour entrer sous Emacs), qui marque une nouvelle page, seul, sur une ligne. Il introduit une nouvelle page dans les sorties paginées (actuellement, PDFLaTeX), et un séparateur horizontal dans les formats continus.

Par exemple :

Environnements

Un environnement est un bloc nommé par l’utilisateur. La syntaxe est la suivante : 

# classe
  contenu

Marquage en ligne

Plusieurs types de décoration peuvent être employés sur le texte. Actuellement, le marquage est exclusif. Je n’ai pas pour projet de l’étendre en inclusif dans un futur proche, sauf si le besoin se fait sentir.

Il faut précéder un caractère d’un antislash pour l’échapper, comme ceci : \c.

Décorations de texte

Le caractère précédant la séquence ne doit pas être alphanumérique.

Indices et exposants

Des mots peuvent être mis en indice ou en exposant, l’usage n’est pas très avancé et sert simplement aux abbréviations courantes telles que Mr. L’exposant s’obtient en préfixant le mot avec un accent circonflexe seul ^, et l’indice en préfixant le mot avec un trait bas _.

Code et texte verbatim

Il faut entourer le texte avec autant d’apostrophes inversées ` ouvrantes que fermantes. Si le premier ou le dernier caractère à l’intérieur du code est un blanc, il est ignoré.

Par exemple, `` `foo` `` donne `foo` .

Liens, ancres et incrustations