Asciidoctor Syntax Quick Reference

AsciiDoc est une norme légère de formatage de texte permettant d’écrire des articles, de la documentation, des livres, des pages web, des diaporamas ou même des pages de man à partir d’un simple texte, enrichi de symboles de présentation. Ce guide est une référence rapide pour la norme de mise en forme de texte AsciiDoc.

Les exemples donnés se concentrent sur le format de sortie HTML de la commande AsciiDoctor. Il est toutefois possible de produire des PDF, des ePub ou encore du DocBook.

La plupart des fonctionnalités estampillées AsciiDoctor only peuvent être obtenues depuis le processeur Python AsciiDoc original en utilisant le fichier de configuration AsciiDoc fourni par le projet AsciiDoctor.

Paragraphes

Normal
Paragraphs don't require any special markup in AsciiDoc.
A paragraph is just one or more lines of consecutive text.

To begin a new paragraph, separate it by at least one blank line.
Newlines within a paragraph are not displayed.

Paragraphs don’t require any special markup in AsciiDoc. A paragraph is just one or more lines of consecutive text.

To begin a new paragraph, separate it by at least one blank line. Newlines within a paragraph are not displayed.

Line breaks
Rubies are red, +
Topazes are blue.

[%hardbreaks]
Ruby is red.
Java is black.

Rubies are red,
Topazes are blue.

Ruby is red.
Java is black.

Literal
Un paragraphe normal.

 Un paragraphe décalé d'au moins un espace devient un paragraphe littéral.
 Toutes les lignes d'un paragraphe littéral doivent être adjacentes.

 Un paragraphe littéral est vu comme un texte préformaté.
 Le texte apparaît avec une fonte à largeur fixe.
 Les espaces et les nouvelles lignes,
 comme ceux de cette phrase,
 sont respectés.

Autre paragraphe normal.

Un paragraphe normal.

Un paragraphe décalé d'au moins un espace devient un paragraphe littéral.
Toutes les lignes d'un paragraphe littéral doivent être adjacentes.
Un paragraphe littéral est vu comme un texte préformaté.
Le texte apparaît avec une fonte à largeur fixe.
Les espaces et les nouvelles lignes,
comme ceux de cette phrase,
sont respectés.

Autre paragraphe normal.

Admonition
NOTE: Un paragraphe d'avertissement attire l'attention du lecteur vers des informations complémentaires.
Son but est explicité par une remarque située en début de paragraphe.

Voici les autres types d'avertissements:

TIP: Des conseils pro ...

IMPORTANT: N'oubliez pas ...

WARNING: Prenez garde à ...

CAUTION: Assurez-vous que ...
Un paragraphe d’avertissement attire l’attention du lecteur vers des informations complémentaires. Son but est explicité par une remarque située en début de paragraphe.

Voici les autres types d’avertissements:

Des conseils pro …​
N’oubliez pas …​
Prenez garde à …​
Assurez-vous que …​
Vous pouvez aussi créer admonition blocks.
Entête de paragraphe
[.lead]
This text will be styled as a lead paragraph (i.e., larger font).

This text will be styled as a lead paragraph (i.e., larger font).

Le style par défaut d’AsciiDoctor donne au premier paragraphe du préambule un style de chapeau.
Plus d’exemple de paragraphes, avertissements et blocs littéraux

Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples :

Texte formaté

Gras, italique et police à chasse fixe
bold *constrained* & **un**constrained

italic _constrained_ & __un__constrained

bold italic *_constrained_* & **__un__**constrained

monospace `constrained` & ``un``constrained

monospace bold `*constrained*` & ``**un**``constrained

monospace italic `_constrained_` & ``__un__``constrained

monospace bold italic `*_constrained_*` & ``**__un__**``constrained

bold constrained & unconstrained

italic constrained & unconstrained

bold italic constrained & unconstrained

monospace constrained & unconstrained

monospace bold constrained & unconstrained

monospace italic constrained & unconstrained

monospace bold italic constrained & unconstrained

Marques et style personnalisé
Werewolves are allergic to #cassia cinnamon#.

Did the werewolves read the [.small]#small print#?

Where did all the [.underline]#cores# run off to?

We need [.line-through]#ten# make that twenty VMs.

[.big]##O##nce upon an infinite loop.

Werewolves are allergic to cassia cinnamon.

Did the werewolves read the small print?

Where did all the cores run off to?

We need ten make that twenty VMs.

Once upon an infinite loop.

Indice et exposant
^super^script phrase

~sub~script phrase

superscript phrase

subscript phrase

Guillemets et apostrophes
"`double curved quotes`"

'`single curved quotes`'

Olaf's desk was a mess.

All of the werewolves`' desks were a mess.

Olaf had been with the company since the `'60s.

“double curved quotes”

‘single curved quotes’

Olaf’s desk was a mess.

All of the werewolves’ desks were a mess.

Olaf had been with the company since the ’60s.

Autres exemples de formatage de texte

Voir ces sections du manuel utilisateur d’AsciiDoctor pour plus d’information et d’exemples.

Entêtes de document

Les champs d’entête sont optionnels.
L’entête ne doit pas contenir de ligne blanches et doit être séparée du contenu par au moins une ligne blanche.
Titre seulement
= Le titre de mon document
Mon document traite de ...
Titre et auteur
= Le Titre de mon Document
Doc Writer <doc.writer@asciidoctor.org>

Mon document contient...
AsciiDoctor permet de préciser plusieurs auteurs sur la ligne d’entête d’auteur. Il suffit de les séparer par un point-virgule.
Titre, auteur et révisions
= Le titre de mon document
Doc Writer <doc.writer@asciidoctor.org>
v1.0, 2014-01-01

Mon document contient...
Vous ne pouvez pas préciser une révision s’il n’y a pas d’auteur.
Entête de document avec attributs
= Le titre de mon Document
Doc Writer <doc.writer@asciidoctor.org>
v1.0, 2018-04-11
:toc:
:imagesdir: assets/images
:homepage: https://asciidoctor.org

Mon document contient...

Titres de section

Doctype "article"
= Titre du document (niveau 0)

== Titre de la Section de niveau 1

=== Titre de la Section de niveau 2

==== Titre de la Section de niveau 3

===== Titre de la Section de niveau 4

====== Titre de la Section de niveau 5

== Un Autre Titre de la Section de niveau 1

Titre du document (niveau 0)

Titre de la Section de niveau 1

Titre de la Section de niveau 2

Titre de la Section de niveau 3

Titre de la Section de niveau 4
Titre de la Section de niveau 5

Un Autre Titre de la Section de niveau 1

Lorsque vous utiliser le doctype par défaut (article), vous ne pouvez avoir qu’un seul titre de niveau 1 dans le document, et il doit être positionné dans l’entête du document.
Le nombre de signe "égal" devant les titres de section précise leur niveau comme en HTML. Par exemple, Section de niveau 1 devient un titre <h2> en HTML.
doctype "book"
= Titre du document (niveau 0)

== Section de niveau 1

=== Section de niveau 2

==== Section de niveau 3

===== Section de niveau 4

====== Section de niveau 5

= Section de niveau 0

Titre du document (niveau 0)

Section de niveau 1

Section de niveau 2

Section de niveau 3

Section de niveau 4
Section de niveau 5

Section de niveau 0

Identifiant explicite
[#primitives-nulls]
== Types primitifs et valeurs nulles
Ancres de section et liens (AsciiDoctor seulement)
sectanchors

Quand cet attribut de document est déclaré, une icône apparait devant chaque titre de section portant une ancre vers cette section.

sectlinks

Quand cet attribut est déclaré, les titres de section deviennent des liens. Cela permet au lecteur d’enregistrer un marque-page sur cette section.

Les ancres de titre de section dépendent du style par défaut d’AsciiDoctor pour leur affichage.

Fichiers inclus

Portions de document
= Référence documentaire
Developpeur principal

Voici la documentatation pour le projet X.

include::basics.adoc[]

include::installation.adoc[]

include::example.adoc[]
AsciiDoctor n’insert pas de ligne blanches entre deux directives d’inclusion. Il vous revient d’ajouter des lignes blanches après les directives si vous le souhaitez (or lorsqu’une inclusion précède un titre, vous le souhaitez sûrement).
Inclusion depuis une adresse
include::https://raw.githubusercontent.com/asciidoctor/asciidoctor/master/README.adoc[]
Inclure du contenu depuis une adresse est potentiellement dangereux, et cette fonctionnalité est donc désactivée par défaut en mode sûr (SECURE et au delà). Le mode safe nécessite également l’ajout de l’attribut d’entête :allow-url-read: pour que la directive soit interprêtée.

Lignes horizontales et saut de page

Ligne horizontale
'''

Saut de page
<<<

Listes

Liste à puces basique
* Edgar Allen Poe
* Sheri S. Tepper
* Bill Bryson
  • Edgar Allen Poe

  • Sheri S. Tepper

  • Bill Bryson

Liste à puces basique (version alternative)
- Edgar Allen Poe
- Sheri S. Tepper
- Bill Bryson
  • Edgar Allen Poe

  • Sheri S. Tepper

  • Bill Bryson

Il doit y avoir une ligne blanche avant et après une liste pour la séparer des autres blocs.
Il est possible de séparer deux listes consécutives en insérant une ligne blanche suivie d’une ligne de commentaire après la première liste. La convention est d’utiliser //- comme ligne de commentaire afin d’indiquer aux autres auteurs qu’il s’agit d’une séparation de listes.
Listes à puce imbriquées
* niveau 1
** niveau 2
*** niveau 3
**** niveau 4
***** niveau 5
* niveau 1
  • niveau 1

    • niveau 2

      • niveau 3

        • niveau 4

          • niveau 5

  • niveau 1

Il est possible de changer le type de puce d’une liste à puces via block styles.
Listes ordonnées basiques
. Étape 1
. Étape 2
. Étape 3
  1. Étape 1

  2. Étape 2

  3. Étape 3

Vous pouvez choisir de numéroter les éléments d’une liste, mais les index doivent alors se suivre.
Listes ordonnées imbriquées
. Step 1
. Step 2
.. Step 2a
.. Step 2b
. Step 3
  1. Step 1

  2. Step 2

    1. Step 2a

    2. Step 2b

  3. Step 3

Listes ordonnées, imbrication maximale
. Niveau 1
.. Niveau 2
... Niveau 3
.... Niveau 4
..... Niveau 5
. Niveau 1
  1. Niveau 1

    1. Niveau 2

      1. Niveau 3

        1. Niveau 4

          1. Niveau 5

  2. Niveau 1

Pour les listes ordonnées, AsciiDoctor supporte des numeration styles tels que lowergrek (grecque minuscule) et decimal-leading-zero (décimal à zéro apparent).
Listes à cocher
* [*] coché
* [x] également coché
* [ ] non coché
*     élément d'une liste normale
  • coché

  • également coché

  • non coché

  • élément d’une liste normale

Étiquetées, en ligne
premier terme:: définition du premier terme
second terme:: définition du second terme
premier terme

définition du premier terme

second terme

définition du second terme

Étiquetées, multi-lignes
premier terme::
définition du premier terme
second term::
définition du second terme
premier terme

définition du premier terme

second term

définition du second terme

Questions et réponses
[qanda]
Qu'est-ce qu'Asciidoctor?::
  Une implémentation du processeur AsciiDoc en Ruby.
Quelle est la réponse à la Question Suprême?:: 42
  1. Qu’est-ce qu’Asciidoctor?

    Une implémentation du processeur AsciiDoc en Ruby.

  2. Quelle est la réponse à la Question Suprême?

    42

Mélangées
Systèmes d'exploitation::
  Linux:::
    . Fedora
      * Desktop
    . Ubuntu
      * Desktop
      * Server
  BSD:::
    . FreeBSD
    . NetBSD

Cloud Providers::
  PaaS:::
    . OpenShift
    . CloudBees
  IaaS:::
    . Amazon EC2
    . Rackspace
Systèmes d’exploitation
Linux
  1. Fedora

    • Desktop

  2. Ubuntu

    • Desktop

    • Server

BSD
  1. FreeBSD

  2. NetBSD

Cloud Providers
PaaS
  1. OpenShift

  2. CloudBees

IaaS
  1. Amazon EC2

  2. Rackspace

Les listes peuvent être indentées. Les espaces en début de ligne ne sont pas pris en compte.
Contenu complexe au sein d’une liste
* Chaque élément d'une liste doit contenir au moins un paragraphe,
  qui peut être lui-même interne, et même raccroché à une indentation.
+
Des paragraphes ou des blocs peuvent être joints en plaçant
une continuation de liste sur une ligne adjacente aux deux blocs.
+
continuation de liste:: un signe plus (`{plus}`) seul sur une ligne

* Un paragraphe au sens propre n'a pas besoin de continuation de liste.

 $ gem install asciidoctor

* Les listes AsciiDoc peuvent supporter n'importe quel contenu complexe.
+
[cols="2", options="header"]
|===
|Application
|Langage

|AsciiDoc
|Python

|AsciiDoctor
|Ruby
|===
  • Chaque élément d’une liste doit contenir au moins un paragraphe, qui peut être lui-même interne, et même raccroché à une indentation.

    Des paragraphes ou des blocs peuvent être joints en plaçant une continuation de liste sur une ligne adjacente aux deux blocs.

    continuation de liste

    un signe plus (+) seul sur une ligne

  • Un paragraphe au sens propre n’a pas besoin de continuation de liste.

    $ gem install asciidoctor
  • Les listes AsciiDoc peuvent supporter n’importe quel contenu complexe.

    ApplicationLangage

    AsciiDoc

    Python

    AsciiDoctor

    Ruby

Liens

Externes
https://asciidoctor.org - automatique !

https://asciidoctor.org[AsciiDoctor]

https://github.com/asciidoctor[AsciiDoctor @ *GitHub*]
Avec des espaces et des caractères spéciaux
link:++https://example.org/?q=[a b]++[Lien comprenant des caractères spéciaux]

link:https://example.org/?q=%5Ba%20b%5D[Lien comprenant des caractères spéciaux]
Chemin Windows
link:\\server\share\whitepaper.pdf[Livre blanc]
Chemin relatifs
link:index.html[Docs]
Courriel et IRC
devel@discuss.arquillian.org

mailto:devel@discuss.arquillian.org[Discuter Arquillien]

mailto:devel-join@discuss.arquillian.org[Inscription (lien), (sujet), (corps)]

irc://irc.freenode.org/#laquadrature
Attributs de lien (AsciiDoctor seulement)
http://discuss.asciidoctor.org[Discuter d'AsciiDoctor, role="external", window="_blank"]

http://discuss.asciidoctor.org[Discuter d'AsciiDoctor^]

https://example.org["Google, Yahoo, Bing^", role="teal"]
Les attributs de lien (y compris l’objet et le contenu d’un lien courriel mailto:) sont une fonctionnalité d’AsciiDoctor seulement. Pour les activer, il faut déclarer l’attribut d’entête de document :linkattrs:. Lorsqu’ils sont activés, vous devez mettre les textes de lien entre guillemets s’ils contiennent une virgule.
Ancres en plein texte
[[bookmark-a]]Les ancres en ligne permettent de référencer n'importe quel contenu.

[#bookmark-b]#Les ancres en ligne peuvent s'appliquer à une phrase telle que celle-ci.#

anchor:bookmark-c[]Utiliser une référence croisée pour lier cet emplacement.

[[bookmark-d,last paragraph]]L'attribut _xreflabel_ sera utilisé en tant que texte du lien de référence croisée.

Les ancres en ligne permettent de référencer n’importe quel contenu.

Les ancres en ligne peuvent s’appliquer à une phrase telle que celle-ci.

Utiliser une référence croisée pour lier cet emplacement.

L’attribut xreflabel sera utilisé en tant que texte du lien de référence croisée.

Références internes
Voir <<paragraphes>> pour apprendre à rédiger des paragraphes.

Apprenez à organiser le document en <<section-titles,sections>>.

Voir Paragraphes pour apprendre à rédiger des paragraphes.

Apprenez à organiser le document en sections.

Références externes vers fichier AsciiDoc (AsciiDoctor seulement)
Se référer aux <<document-b.adoc#section-b,Section B>> pour plus d'informations.

Rendez-vous après votre lecture des <<document-b#section-b,Section B>> !

Se référer aux Section B pour plus d’informations.

Rendez-vous après votre lecture des Section B !

Images

Les images sont cherchées dans le dossiers déclaré via l’attribut de document imagesdir, qui est nul par défaut. Vous êtes encouragé à déclarer un attribut de document :imagesdir: afin de vous éviter de répéter la partie commune des chemins de vos images.

L’attribut de document imagesdir peut être un chemin absolu, relatif, ou une URL. Lorsque le chemin d’une image est une URL ou un chemin absolu, le préfix :imagesdir: n’est pas inclu.

Blocs
image::sunset.jpg[]

image::sunset.jpg[Sunset]

.Un levé de soleil à la montagne
[#img-sunset]
[caption="Figure 1: ",link=https://www.flickr.com/photos/javh/5448336655]
image::sunset.jpg[Sunset,300,200]

image::https://asciidoctor.org/images/octocat.jpg[GitHub mascot]
sunset
Sunset
Sunset
Figure 1: Un levé de soleil à la montagne
GitHub mascot
En plein texte
Cliquez sur image:icons/play.png[Play, titre="Lecture"] pour lancer la soirée.

Cliquez sur image:icons/pause.png[titre="Pause"] pour faire une pause.

Cliquez sur Play pour lancer la soirée.

Cliquez sur pause pour faire une pause.

Deux fois deux-points collés au mot-clé image (i.e., image::) indiquent d’inclure l’image dans son popre bloc (c’est à dire d’en faire une figure), alors qu’un seul deux-points (donc image:) indique une image en plein texte, traitée comme un caractère. (Toute les macros suivent ce principe, ex : toc::)
Image en plein texte avec rôle de positionnement
image:sunset.jpg[Sunset,150,150,role="right"] Quel magnifique levé de soleil !

Sunset Quel magnifique levé de soleil !

Il y a toute une variété d’attributs disponibles pour le positionnement des images.
Embarquées
=Titre du document
:data-uri:
Lorsque l’attribut :data-uri: est déclaré, toutes les images du document — y compris les icônes d’avertissement — sont embarquées sous forme de data URIs.
Au lieu de déclarer l’attribut :data-uri: dans le document, vous pouvez le passer en argument de la ligne de commande via -a data-uri.

Vidéos

Blocs
video::video_file.mp4[]

video::video_file.mp4[width=640, start=60, end=140, options=autoplay]
Intégrer une vidéo YouTube
video::rPQoq7ThGAU[youtube]
Intégrer une vidéo Viméo
video::67480300[vimeo]
Vous pouvez contrôler les réglages de la vidéo en utilisant des attributs et leurs options à l’appel de la macro.

Code source

Inline (monospace only)
Reference code like `types` or `methods` inline.

Do not pass arbitrary ``Object``s to methods that accept ``String``s!

Reference code like types or methods inline.

Do not pass arbitrary Objects to methods that accept Strings!

En plein texte (littéral)
Pour afficher du texte via une police de caractères à chasse fixe comme ceci : `+{apostrophe inversée}+` ; il faut entourer le texte avec des signes "plus" et des apostrophes inversées.

Pour afficher du texte via une police de caractères à chasse fixe comme ceci : {apostrophe inversée} ; il faut entourer le texte avec des signes "plus" et des apostrophes inversées.

Ligne littérale complète
 Pour insérer un fragment de code il faut indenter la ligne d'un espace.
Pour insérer un fragment de code il faut indenter la ligne d'un espace.
Bloc littéral
....
erreur: L'opération demandée a retourné une erreur: 1954 Recherche interdite dans le manuel des opérations de défense.
absolument fatal: l'opération lancée a occasionné la perte du dodécaèdre de la destinée.
Voulez-vous mourir à nouveau? o/n
....
erreur: L'opération demandée a retourné une erreur: 1954 Recherche interdite dans le manuel des opérations de défense.
absolument fatal: l'opération lancée a occasionné la perte du dodécaèdre de la destinée.
Voulez-vous mourir à nouveau? o/n
Code source avec titre, sans coloration syntaxique
.Gemfile.lock
----
GEM
  remote: https://rubygems.org/
  specs:
    asciidoctor (1.5.6.1)

PLATFORMS
  ruby

DEPENDENCIES
  asciidoctor (~> 1.5.6.1)
----
Gemfile.lock
GEM
  remote: https://rubygems.org/
  specs:
    asciidoctor (1.5.6.1)

PLATFORMS
  ruby

DEPENDENCIES
  asciidoctor (~> 1.5.6.1)
Code source avec titre et coloration syntaxique
.app.rb
[source,ruby]
----
require 'sinatra'

get '/hi' do
  "Hello World!"
end
----
app.rb
require 'sinatra'

get '/hi' do
  "Hello World!"
end
Code source avec renvois
[source,ruby]
----
require 'sinatra' // <1>
get '/hi' do // <2>
  "Salut tout le monde !" // <3>
end
----
<1> Import d'une bibliothèque
<2> Indication d'URL
<3> Corps d'une réponse HTTP
require 'sinatra' (1)
get '/hi' do (2)
  "Salut tout le monde !" (3)
end
1Import d’une bibliothèque
2Indication d’URL
3Corps d’une réponse HTTP
Bloc de code avec renvois non sélectionnables
----
ligne de code // <1>
ligne de code # <2>
ligne de code ;; <3>
----
<1> Un renvoi derrière une ligne de commentaire style langage C.
<2> Un renvoi derrière une ligne de commentaire Ruby, Python, Perl, etc.
<3> Un renvoi derrière une ligne pour commentaire Clojure.
ligne de code (1)
ligne de code (2)
ligne de code (3)
1Un renvoi derrière une ligne de commentaire style langage C.
2Un renvoi derrière une ligne de commentaire Ruby, Python, Perl, etc.
3Un renvoi derrière une ligne pour commentaire Clojure.
Bloc de code XML avec renvois non sélectionnables
[source,xml]
----
<section>
  <title>Titre de section</title> <!--1-->
</section>
----
<1> Le titre de section est nécessaire.
<section>
  <title>Titre de section</title> (1)
</section>
1Le titre de section est nécessaire.
Bloc de code source intégré depuis un fichier
[source,ruby]
----
include::app.rb[]
----
Bloc de code intégré depuis un fichier présent dans le {sourcedir}
:sourcedir: src/main/java

[source,java]
----
include::{sourcedir}/org/asciidoctor/Asciidoctor.java[]
----
Retrait de l’indentation originale du code
[source,ruby,indent=0]
----
include::lib/document.rb[lines=5..10]
----
  • Lorsqu'indent vaut 0, l’indentation du code est retirée (les tabulations sont remplacées par des séries de 4 espaces).

  • Lorsqu'indent est supérieur à 0, l’indentation est retirée (comme indiqué ci-dessus) puis remontée au niveau indiqué (en espaces simples).

Bloc de code sans délimiteurs (sans ligne blanche)
[source,xml]
<meta name="viewport"
  content="width=device-width, initial-scale=1.0">

This is normal content.
<meta name="viewport"
  content="width=device-width, initial-scale=1.0">

This is normal content.

Activer la coloration syntaxique

La coloration syntaxique s’active par la déclaration de l’attribut :source-highlighter: en entête du document (ou passé en argument) :

:source-highlighter: pygments

Les options valides sont : coderay, highlightjs, prettify, et pygments.

Plus de délimiteurs de bloc

Barre latérale
.Historique d'AsciiDoc
****
La première version d'AsciiDoc a été publiée en novembre 2002 par Stuart Rackham.
Ce langage a été conçu dès le départ pour fournir une syntaxe légère
destinée à générer des documents professionnels en DocBook ou LaTeX.
****
Historique d’AsciiDoc

La première version d’AsciiDoc a été publiée en novembre 2002 par Stuart Rackham. Ce langage a été conçu dès le départ pour fournir une syntaxe légère destinée à générer des documents professionnels en DocBook ou LaTeX.

Tout bloc peut avoir un titre, positionné au dessus du bloc. Un titre est une ligne de texte commençant par un point. Le point ne peut pas être suivi d’un espace.
Exemple
.Exemple de document
====
Voici un exemple d'un document AsciiDoc:

[listing]
....
= Titre du Document
Auteur du document
:toc:

Ce guide explique…
....

L'entête d'un ducument est utile, mais pas obligatoire.
====
Exemple de document

Voici un exemple d’un document AsciiDoc:

= Titre du Document
Auteur du document
:toc:

Ce guide explique…

L’entête d’un ducument est utile, mais pas obligatoire.

Avertissements
[NOTE]
====
Un bloc d'avertissement peut comporter un contenu complexe.

.Une liste
- un
- deux
- trois

Un autre paragraphe.
====

Un bloc d’avertissement peut comporter un contenu complexe.

Une liste
  • un

  • deux

  • trois

Un autre paragraphe.

Icônes d’avertissement et de renvoi

AsciiDoctor peut "dessiner" des icônes en utilisant la police de caractères Font Awesome et du CSS.

Pour utiliser cette fonctionnalité, déclarer la valeur icons pour l’attribut de document :font: (à déclarer par la même occasion). AsciiDoctor produira alors les balises HTML permettant de sélectionner les bonnes icônes dans la police Font Awesome pour chaque type d’avertissement.

Les icônes peuvent également être produites à partir de fichier images, voire embarquées dans le code HTML (via le schéma d’URI data).

Les icônes peuvent également être utilisées en plein texte et être stylisées.

Bloc de citation
[quote, Abraham Lincoln, Adresse transférée à l'inscription du cimetère de Gettysburg]
____
Il y a quatre vingt sept ans nos pères ont apporté
une nouvelle nation sur ce continent
____

[quote, Albert Einstein]
Quelqu'un qui ne s'est jamais trompé, n'a jamais innové.

____
Quelqu'un qui ne s'est jamais trompé, n'a jamais innové.
____

[quote, Charles Lutwidge Dodgson, 'Mathématicien et auteur, également connu comme http://en.wikipedia.org/wiki/Lewis_Carroll[Lewis Carroll]']
____
Si vous ne savez pas où vous allez, n'importe quelle route vous y mènera.
____

Il y a quatre vingt sept ans nos pères ont apporté une nouvelle nation sur ce continent

— Abraham Lincoln
Adresse transférée à l'inscription du cimetère de Gettysburg
Quelqu’un qui ne s’est jamais trompé, n’a jamais innové.
— Albert Einstein

Quelqu’un qui ne s’est jamais trompé, n’a jamais innové.

Si vous ne savez pas où vous allez, n’importe quelle route vous y mènera.

— Charles Lutwidge Dodgson
Mathématicien et auteur, également connu comme Lewis Carroll
Bloc de citation abrégé (AsciiDoctor seulement)
"Je suis persuadé qu'une petite rébellion de temps en temps est une bonne chose,
aussi nécessaire dans le monde politique qu'un orage un soir d'été."
-- Thomas Jefferson, Mémoires de Thomas Jefferson: Volume 11
Je suis persuadé qu’une petite rébellion de temps en temps est une bonne chose, aussi nécessaire dans le monde politique qu’un orage un soir d’été.
— Thomas Jefferson
Mémoires de Thomas Jefferson: Volume 11
Citations aériennes : la plus belle invention depuis les barrières à bloc de code (AsciiDoctor seulement)
[, James Baldwin]
""
Ceux qui pensent qu'il est impossible d'agir sont généralement interrompus par ceux qui agissent.
""

"" Ceux qui pensent qu’il est impossible d’agir sont généralement interrompus par ceux qui agissent. ""

Bloc de contenu intacte
++++
<p>
Le contenu dans un bloc traversant est dirigé vers la sortie sans être affecté.
Cela signifie que vous pouvez inclure de l'HTML brut, comme ce Gist intégré:
</p>

<script src="https://gist.github.com/mojavelinux/5333524.js">
</script>
++++

Le contenu dans un bloc traversant est dirigé vers la sortie sans être affecté. Cela signifie que vous pouvez inclure de l'HTML brut, comme ce Gist intégré:

Ouvert
--
Un bloc ouvert peut être un conteneur anonyme,
ou permettre de faire passer pour n'imorte quel autre bloc.
--

[source]
--
puts "Je suis un bloc source !"
--

Un bloc ouvert peut être un conteneur anonyme, ou permettre de faire passer pour n’imorte quel autre bloc.

puts "Je suis un bloc source !"
Substitutions sur mesures
:version: 1.5.6.1

[source,xml,subs="verbatim,attributes"]
----
<dependency>
  <groupId>org.asciidoctor</groupId>
  <artifactId>asciidoctor-java-integration</artifactId>
  <version>{version}</version>
</dependency>
----
<dependency>
  <groupId>org.asciidoctor</groupId>
  <artifactId>asciidoctor-java-integration</artifactId>
  <version>1.5.6.1</version>
</dependency>

Identifiant, rôle et options de bloc

Un rôle se traduit en balisage HTML par un attribut de classe (CSS).
Méthode traditionnelle (verbeuse) d’assignation d’identifiant et de rôle
[[goals]]
[role="incremental"]
* Goal 1
* Goal 2
Méthode raccourcie d’assignation d’identifiant et de rôle (AsciiDoctor seulement)
[#goals.incremental]
* Goal 1
* Goal 2
  • Pour déclarer plusieurs rôles via la méthode raccourcie, il suffit de les séparer par des points.

  • L’ordre des id et role n’a pas d’importance avec la méthode raccourcie.

Méthode traditionelle (verbeuse) d’assignation d’ancre (id) et de rôle
[.e_the_world]][big goal].e the world_
Méthode raccourcie d’assignation d’ancre (id) et de rôle (AsciiDoctor seulement)
[.e_the_world.big.goal].e the world_
Rôle assigné à une portion de texte encadrée par des apostrophes inversées
[.rolename]`monospace text`
Méthode traditionnelle (verbeuse) d’assignation d’option de bloc
[options="header,footer,autowidth"]
|===
|Cell A |Cell B
|===
Méthode raccourcie pour l’assignation d’options de bloc (AsciiDoctor seulement)
[%header%footer%autowidth]
|===
|Cell A |Cell B
|===

Commentaires

Ligne de commentaire
// Un commentaire d'une seule ligne
Les lignes de commentaire peuvent être utilisées pour diviser des éléments, comme deux listes collées sinon.
Bloc de commentaire
////
Un commentaire de plusieurs lignes.

Notez que c'est un bloc délimité.
////

Tableau

Tableau avec titre, trois colonnes, une entête et deux lignes de contenu
.Titre du tableau
|===
|Nom de la Colonne 1 |Nom de la Colonne 2 |Nom de la Colonne 3 (1)
(2)
|Cellule de la colonne 1, rangée 1
|Cellule de la colonne 2, rangée 1
|Cellule de la colonne 3, rangée 1

|Cellule de la colonne 1, rangée 2
|Cellule de la colonne 2, rangée 2
|Cellule de la colonne 3, rangée 2
|===
Titre du tableau
Nom de la Colonne 1Nom de la Colonne 2Nom de la Colonne 3

Cellule de la colonne 1, rangée 1

Cellule de la colonne 2, rangée 1

Cellule de la colonne 3, rangée 1

Cellule de la colonne 1, rangée 2

Cellule de la colonne 2, rangée 2

Cellule de la colonne 3, rangée 2

1À moins que l’attribut cols ne soit spécifié, le nombre de colonnes est égal au nombre de séparateur de cellules de la première ligne (non blanche) entre les délimiteurs de bloc.
2Quand une ligne blanche suit la première ligne non blanche, les cellules de la première ligne deviennent des cellules d’entêtes.
Tableau avec deux colonnes, une entête et deux lignes de contenu
[%header,cols=2*] (1)
|===
|Nom de la Colonne 1
|Nom de la Colonne 2

|Cellule de la colonne 1, rangée 1
|Cellule de la colonne 2, rangée 1

|Cellule de la colonne 1, rangée 2
|Cellule de la colonne 2, rangée 2
|===
Nom de la Colonne 1Nom de la Colonne 2

Cellule de la colonne 1, rangée 1

Cellule de la colonne 2, rangée 1

Cellule de la colonne 1, rangée 2

Cellule de la colonne 2, rangée 2

1La valeur * de l’attribut cols est l’opérateur de répétition. Cela signifie qu’il faut propager les attributs de colonne aux colonnes suivantes. Dans cet exemple, nous propageons le formattage par défaut aux deux colonnes. Quand les cellules d’une entête ne sont pas définies sur une seule ligne, il faut utiliser l’attribut cols pour préciser le nombre de colonnes du tableau, et l’option %header (ou options=header) pour promouvoir la 1ère ligne du tableau aux rang d’entête.
Tableau avec trois colonnes, une entête et deux lignes de contenu
[cols="1,1,2", options="header"] (1)
.Applications
|===
|Nom
|Catégorie
|Description

|Firefox
|Brangéeser
|Mozilla Firefox est un navigateur _web_ en logiciel libre..
Il est conçu pour être en conformité avec les standards
performant, portable.

|Arquillian
|Testing
|Une plateforme innovante et performante pour les tests.
Permet aux développeurs de créer des tests réellement automatisés.
|===
Applications
NomCatégorieDescription

Firefox

Brangéeser

Mozilla Firefox est un navigateur web en logiciel libre. Il est conçu pour être en conformité avec les standards performant, portable.

Arquillian

Testing

Une plateforme innovante et performante pour les tests. Permet aux développeurs de créer des tests réellement automatisés.

1Dans cet exemple, l’attribut cols a deux fonctions : il annonce que le tableau a trois colonnes, et il précise leur largeur relative.
Tableau avec des colonnes contenant de l’AsciiDoc
[cols="2,2,5a"]
|===
|Firefox
|Brangéeser
|Mozilla Firefox est navigateur _web_ en logiciel libre.

Il est conçu pour:

* la conformité aux standards ;
* les performances ;
* la portabilité ;

http://getfirefox.com[Get Firefox]!
|===

Firefox

Brangéeser

Mozilla Firefox est navigateur web en logiciel libre.

Il est conçu pour:

  • la conformité aux standards ;

  • les performances ;

  • la portabilité ;

Tableau généré à partir de données formattées en CSV (méthode verbeuse)
[%header,format=csv]
|===
Artiste,Chanson,Genre
Baauer,Harlem Shake,Hip Hop
The Lumineers,Ho Hey,Folk Rock
|===
ArtisteChansonGenre

Baauer

Harlem Shake

Hip Hop

The Lumineers

Ho Hey

Folk Rock

Tableau généré à partir de données formattées en CSV (AsciiDoctor seulement)
,===
Artiste,Chanson,Genre
Baauer,Harlem Shake,Hip Hop
,===

Artiste

Chanson

Genre

Baauer

Harlem Shake

Hip Hop

Tableau généré à partir d’un fichier CSV (méthode verbeuse)
|===
include::customers.csv[]
|===
Tableau généré à partir de données DSV (AsciiDoctor seulement)
:===
Artiste:Chanson:Genre
Robyn:Indestructable:Dance
:===

Artiste

Chanson

Genre

Robyn

Indestructable

Dance

Tableau avec cellules formattées, alignées et fusionnées
[cols="e,m,^,>s", width="25%"]
|===
|1 >s|2 |3 |4
^|5 2.2+^.^|6 .3+<.>m|7
^|8
|9 2+>|10
|===

1

2

3

4

5

6

7

8

9

10

Macro d’interface graphique

Vous devez déclarer l’attribut :experimental: dans l’entête du document pour activer ces fonctionnalités.
Raccourcis clavier (macro de touche clavier)
|===
|Raccourci |But

|kbd:[F11]
|Bascule en plein écran

|kbd:[Ctrl+T]
|Ouvre un nouvel onglet

|kbd:[Ctrl+Shift+N]
|Nouvelle fenêtre incognito

|kbd:[\ ]
|Utlisé pour échapper des caractères

|kbd:[Ctrl+\]]
|Sauter au mot clé

|kbd:[Ctrl + +]
|Augmente le zoom
|===
RaccourciBut

F11

Bascule en plein écran

Ctrl+T

Ouvre un nouvel onglet

Ctrl+Shift+N

Nouvelle fenêtre incognito

\

Utlisé pour échapper des caractères

Ctrl+]

Sauter au mot clé

Ctrl++

Augmente le zoom

Sélection de menu (macro pour représenter un menu)
Pour sauver le fichier, sélectionnez menu:File[Save].

Sélectionnez menu:View[Zoom > Reset] pour ramener le zoom à sa valeur par défaut.

Pour sauver le fichier, sélectionnez File  Save.

Sélectionnez View  Zoom  Reset pour ramener le zoom à sa valeur par défaut.

Boutons (macro pour représenter des boutons)
Appuyez sur btn:[OK] bouton lorsque vous avez terminé.

Sélectionnez un fichier dans le l'explorateur de fichiers et cliquez sur btn:[Open].

Appuyez sur OK bouton lorsque vous avez terminé.

Sélectionnez un fichier dans le l’explorateur de fichiers et cliquez sur Open.

Attributs et substitutions

Déclaration et utilisation d’attributs
:url-home: https://asciidoctor.org
:link-docs: https://asciidoctor.org/docs[documentation]
:summary: Asciidoctor est un format abouti de documents simples textes, pour \
       écrire des notes, des articles, de la documentation, des livres, et plus encore. \
       C'est également un processeur de texte & un outil de traitement de chaînes pour \
	   transformer des documents en divers formats de sortie (c'est à dire, des formats \
	   finaux) incluant HTML, DocBook, PDF ePub.

:checkedbox: pass:normal[{startsb}&#10004;{endsb}]

Jetez un œil à {url-home}[Asciidoctor] !

{summary}

N'omettez pas de lire équalement la {link-docs} !

{checkedbox} C'est fait !

Jetez un œil à Asciidoctor !

Asciidoctor est un format abouti de documents simples textes, pour écrire des notes, des articles, de la documentation, des livres, et plus encore. C’est également un processeur de texte & un outil de traitement de chaînes pour transformer des documents en divers formats de sortie (c’est à dire, des formats finaux) incluant HTML, DocBook, PDF ePub.

N’omettez pas de lire équalement la documentation !

[✔] C’est fait !

Ordre de priorité de déclaration d’attributs (du plus élevé au plus faible)
  • Attributs passés via l’API ou la ligne de commande, et ne se terminant pas par @

  • Attributs définis dans le document

  • Attributs passés via l’API ou la ligne de commande et se terminant par @

  • Valeur par défaut de l’attribut

Pour faire en sorte qu’un attribut passé par l’API ou la ligne de commande ait une priorité moindre que ceux définis dans le document, il faut ajouter un symbole @ à la fin de la valeur de l’attribut en question.
Attributs prédéfinis pour remplacement de caractères [1][2][3]
Nom de l’attributTexte de remplacementApparence

blank (blanc)

rien

{vide}

empty (vide)

rien

{vide}

sp

espace unique

nbsp

&#160;

 

zwsp[4]

&#8203;

wj[5]

&#8288;

apos

&#39;

'

quot

&#34;

"

lsquo

&#8216;

rsquo

&#8217;

ldquo

&#8220;

rdquo

&#8221;

deg

&#176;

°

plus

&#43;

+

brvbar

&#166;

¦

vbar

|

|

amp

&

&

lt

<

<

gt

>

>

startsb

[

[

endsb

]

]

caret

^

^

astérisque

*

*

tilde

~

~

barre oblique inversée

\

\

backtick

`

`

double deux-points

::

::

double point-virgules

;;

;;

cpp

C++

C++

[1] Certains remplacements sont des caractères Unicode, tandis que d’autres sont des références de caractère (par exemple, &#34;). Ces références sont utilisées chaque fois que l’usage d’un caractère Unicode pourrait interférer avec la syntaxe AsciiDoc ou apporter une confusion lors du rendu (par exemple dans le navigateur). Il appartient au convertisseur de transformer la référence dans quelque chose que les interprêteurs de rendu comprendront (que ce soit des pages de man ou du PDF).

[2] AsciiDoctor ne vous empêche pas de réassigner les attributs prédéfinis. Cependant, il vaut mieux les traiter comme étant en lecture seule à moins que le format de sortie ne requière un schéma d’encodage différent. Ces attributs sont un outil efficace pour décorréler le contenu de la présentation.

[3] AsciiDoctor vous autorise à utiliser n’importe quelles références de caractère nommées (aussi nommées « entités nommées ») définie en HTML (par exemple, &euro; devient €). Cependant, l’utilisation de références de caractère nommées peut occasionner des problèmes lors de la génération de sorties non HTML (telles que PDF) car la table de correspondance peut ne pas être définie. Notre recommandation est d’éviter l’utilisation des références de caractère nommées — à l’exception de celles définies par la norme XML (c’est-à-dire : gt, amp, quot and apos). À la place, utilisez les références de caractère numériques (comme : &#8364;).

[4] L’espace de largeur nulle (ZWSP pour Zero With SPace) est une référence Unicode qui montre où un mot long peut être coupé si nécessaire.

[5] Le jointeur de mot (WJ pour Word Joiner) est une référence Unicode qui interdit un retour à la ligne à cette position.

Attributs d’environnement
AttributDescriptionExemple de valeur

asciidoctor

Défini que le transcripteur à l’œuvre est AsciiDoctor.

asciidoctor-version

Version d’AsciiDoctor.

2.0.12

backend

Module de sortie utilisé.

html5

basebackend

La valeur du nom du module de sortie, débarrassé des numéros de version finaux. Par exemple : si le backend utilisé est dockbook5, le basebackend sera docbook.

html

docdate

Date de dernière modification du document source.[1,2]

2018-09-18

docdatetime

Date et heure de modification du document source.[1,2]

2018-09-18 15:26:06 GMT+0200

docdir

Chemin complet du dossier contenant le document source.

/home/user/docs

docfile

Chemin complet du document source.

/home/user/docs/userguide.adoc

docfilesuffix

Extension du fichier source, avec son point initial. Introduit à la version 1.5.6.

.adoc

docname

Nom de base du document source (sans le chemin, ni l’extension).

userguide

doctime

Heure de dernière modification du document source.[1,2]

15:26:06 GMT+0200

doctype

Type de document (article, book ou manpage).

article

docyear

Année de dernière modification du document.[1,2]

2018

embedded

Défini seulement si le contenu est converti en document embarquable (contenu uniquement).

filetype

Extension du nom du fichier de sortie (sans le point initial).

html

htmlsyntax

Précise la syntaxe HTML employée pour générer le document de sortie (html, ou xhtml).

html

localdate

Date de conversion du document.[2]

2019-10-21

localdatetime

Date et heure de conversion du document.[2]

2016-02-17 19:31:05 GMT+0000

localtime

Heure de conversion du document.[2]

19:31:05 GMT+0200

localyear

Année de conversion du document.[2]

2019

outdir

Chemin complet du dossier de sortie.

/home/user/docs/dist

outfile

Chemin complet du document de sortie.

/home/user/docs/dist/userguide.html

outfilesuffix

Extension du fichier du sortie (avec son point initial), tel que déterminé par le module de sortie (.html pour le backend html, .xml pour dockbook, etc). (La valeur n’est pas mise à jour pour correspondre à l’extension du fichier de sortie quand son nom est explicitement spécifié). Peut être modifié sans problèmes.

.html

safe-mode-level

Valeur numérique du réglage de sécurité (safe mode) :

UNSAFE

0 (sans protection)

SAFE

10 (protection basique)

SERVER

10 (serveur)

SECURE

20 (protection maximale)

20

safe-mode-name

Valeur textuelle du réglage de sécurité (safe mode).

SERVER

safe-mode-unsafe

Défini si le le réglage de sécurité est positionné sur UNSAFE.

safe-mode-safe

Défini si le le réglage de sécurité est positionné sur SAFE.

safe-mode-server

Défini si le le réglage de sécurité est positionné sur SERVER.

safe-mode-secure

Défini si le le réglage de sécurité est positionné sur SECURE.

user-home

Dossier initial de l’utilisateur courant. Défini à . si le réglage de sécurité est positionné à SERVER ou plus.

/home/user

[1] Ne reflète que l’heure de dernière modification du fichier du document source, sans considération pour les fichiers éventuellement inclus.

[2] Si la variable d’environnement SOURCE_DATE_EPOCH est définie, la valeur de cet arttribut est tirée de l’horodatage considéré comme UTC sous forme de nombre entier, stocké dans cette variable d’environnement. Cette surchage permet de rendre les conversions de document reproductibles. Voir https://reproducible-builds.org/specs/source-date-epoch/ [en] pour plus d’informations concernant la variable d’environnement SOURCE_DATE_EPOCH.

Substitution de nom
none

Désactive les substitutions.

normal

Exécute toutes les substitutions sauf les renvois.

verbatim

Remplace tous les caractères spéciaux et traite les renvois.

specialchars, specialcharacters

Remplace <, > et & par leur entités correspondantes.

quotes

Mets le texte en forme.

attributes

Remplace les références d’attributs.

replacements

Substitue les remplacements de référence à du texte ou des caractères.

macros

Exécute les macro.

post_replacements

Remplace le caractère de fin de ligne (+).

Compteur d’attributs
[caption=""]
.Parties{counter2:index:0}
|===
|Partie Id |Description

|PX-{counter:index}
|Description de PX-{index}

|PX-{counter:index}
|Description de PX-{index}
|===
Parties
Partie IdDescription

PX-1

Description de PX-1

PX-2

Description de PX-2

Remplacement de texte

Remplacements de texte par des symboles
NomSyntaxeRemplacement unicodeRenduNotes

Droits d’auteur

(C)
&#169;

©

Enregistré

(R)
&#174;

®

Marque déposée

(TM)
&#8482;

Tiret long

--
&#8212;

 — 

Seulement remplacé si entre deux mots, entre un mot et une fin de ligne, ou flanqué d’espaces.

Lorsqu’entouré d’espaces (par exemple, a -- b), les espaces normaux sont remplacés par des espaces fin (&#8201;).

ellipses

...
&#8230;

…​

flèche simple à droite

->
&#8594;

flèche double à droite

=>
&#8658;

flèche simple à gauche

<-
&#8592;

flèche double à gauche

<=
&#8656;

apostrophe

Sam's
Sam&#8217;s

Sam’s

La forme verticale de l’apostrophe est remplacée par la forme courbée.

Toute entité XML (nommée, numérique ou hexadécimale) est supportée.

Texte échappé

Backslash
\*Astérisque* n'est pas transformé en texte gras.
Les astérisques encadrant le mot sont conservés.

\{author} n'est pas interprété comme un nom d'auteur.
Les accolades encadrant le mot sont conservées.

`A\--Z` relie A à Z en monospace en utilisant deux tirets.
Les tirets ne sont pas remplacés par un tiret long.

Dans ces cas, le caractère antislash (barre oblique inversée) est automatiquement retiré.

*Astérisque* n’est pas transformé en texte gras. Les astérisques encadrant le mot sont conservés.

{author} n’est pas interprété comme un nom d’auteur. Les accolades encadrant le mot sont conservées.

A--Z relie A à Z en monospace en utilisant deux tirets. Les tirets ne sont pas remplacés par un tiret long.

Dans ces cas, le caractère antislash (barre oblique inversée) est automatiquement retiré.

Contenu intact (“délimiteur plus”)
`+Le Texte entouré des caractères {plus}+` est non-formaté.
Cependant, les caractères spéciaux tels que +<+ et +>+ sont quand même échappés.

Le Texte entouré des caractères {plus} est non-formaté. Cependant, les caractères spéciaux tels que < et > sont quand même échappés.

Texte brute (triple plus et macro pass)
+++<u>souligne-moi</u>+++ est souligné.

pass:[<u>souligne-moi</u>] est également souligné

souligne-moi est souligné.

souligne-moi est également souligné

Table des matières (:toc:)

Déclaration
= Guide du rédacteur AsciiDoc
Rédacteur <doc.writer@asciidoctor.org>
v1.0, 2018-07-12
:toc:
Table des matières positionnée à droite
= Guide du rédacteur AsciiDoc
Rédacteur <doc.writer@asciidoctor.org>
v1.0, 2018-07-12
:toc: right
Les titre, niveau et positionnement d’une table des matière peuvent être personnalisés.

Bibliographie

Bibliographie avec références internes
_The Pragmatic Programmer_ <<pp>> devrait être lu par tous les developpeurs.
Pour pour tout savoir sur les modèles de conception, reportez-vous au livre issu de la "`Bande des Quatre`" <<gof>>.

[bibliography]
== Références

- [[[pp]]] Andy Hunt & Dave Thomas. The Pragmatic Programmer:
  From Journeyman to Master. Addison-Wesley. 1999.
- [[[gof,2]]] Erich Gamma, Richard Helm, Ralph Johnson & John Vlissides. Design Patterns:
  Elements of Reusable Object-Oriented Software. Addison-Wesley. 1994.

The Pragmatic Programmer [pp] devrait être lu par tous les developpeurs. Pour pour tout savoir sur les modèles de conception, reportez-vous au livre issu de la “Bande des Quatre” [2].

Références

  • [pp] Andy Hunt & Dave Thomas. The Pragmatic Programmer: From Journeyman to Master. Addison-Wesley. 1999.

  • [2] Erich Gamma, Richard Helm, Ralph Johnson & John Vlissides. Design Patterns: Elements of Reusable Object-Oriented Software. Addison-Wesley. 1994.

Notes de bas de page

Notes de bas de page normale ou réutilisables
Une déclaration.footnote:[Clarification concernant cette déclaration.]

Une déclaration audacieuse ! footnote:[disclaimer, Mes opinions sont les miennes.]

Une autre déclaration audacieuse ! footnote:[disclaimer]

Une déclaration.[1]

Une déclaration audacieuse ! [2]

Une autre déclaration audacieuse ! [3]


1. Clarification concernant cette déclaration.
2. disclaimer, Mes opinions sont les miennes.
3. disclaimer

Compatibilité avec Markdown

Les syntaxes compatibles avec Markdown ne sont disponibles qu’avec AsciiDoctor.

Entêtes à la Markdown
# Titre du document (niveau 0)

## Section de niveau 1

### Section de niveau 2

#### Section de niveau 3

##### Section de niveau 4

###### Section de niveau 5

Titre du document (niveau 0)

Section de niveau 1

Section de niveau 2

Section de niveau 3

Section de niveau 4
Section de niveau 5
Bloc de code avec coloration syntaxique
```ruby
require 'sinatra'

get '/hi' do
  "Hello World!"
end
```
require 'sinatra'

get '/hi' do
  "Hello World!"
end
Citations à la Markdown
> Je suis persuadé qu'une petite rébellion de temps en temps est une bonne chose,
> aussi nécessaire dans le monde politique qu'un orage un soir d'été.
> -- Thomas Jefferson, Mémoires de Thomas Jefferson: Volume 11

Je suis persuadé qu’une petite rébellion de temps en temps est une bonne chose, aussi nécessaire dans le monde politique qu’un orage un soir d’été.

— Thomas Jefferson
Mémoires de Thomas Jefferson: Volume 11
Citation avec bloc de contenu à la Markdown
> > Quoi de neuf?
>
> J'ai introduit du Markdown dans mon AsciiDoc !
>
> > Comment t'as fait ?
>
> * Blocs de citation
> * Entêtes
> * Blocs de code isolés
>
> > Y a-t-il d'autres moyens encore ?
>
> Oui. AsciiDoc et Markdown ont désormais en commun une bonne part de leur syntaxe.

Quoi de neuf?

J’ai introduit du Markdown dans mon AsciiDoc !

Comment t’as fait ?

  • Blocs de citation

  • Entêtes

  • Blocs de code isolés

Y a-t-il d’autres moyens encore ?

Oui. AsciiDoc et Markdown ont désormais en commun une bonne part de leur syntaxe.

Filet horizontal à la Markdown
---

- - -

***

* * *




Manuel utilisateur et aide

Pour en apprendre plus sur AsciiDoctor vous pouvez consulter les autres guides et le manuel utilisateur Vous pouvez également rejoindre la liste de diffusion d’AsciiDoctor, où vous pouvez vos questions et laisser des commentaires.