Asciidoctor est un processeur de texte et une chaîne de publication rapide et open source permettant de convertir du contenu AsciiDoc en HTML 5, DocBook 5, PDF et d’autres formats. Asciidoctor est écrit en Ruby et fonctionne sur les principaux systèmes d’exploitation. Pour simplifier l’installation, Asciidoctor est publié au format gem sur RubyGems.org, et il est également disponible en tant que paquet système sur les principales distributions Linux ainsi que sur macOS. Asciidoctor fonctionne aussi sur la JVM avec AsciidoctorJ et dans n’importe quel environnement JavaScript avec Asciidoctor.js. Le projet Asciidoctor est hébergé sur GitHub.
Nous souhaitons exprimer toute notre reconnaissance à nos généreux sponsors, sans qui Asciidoctor ne pourrait pas exister. Merci à vous pour votre engagement dans l’amélioration de la documentation technique ! Un apport financier supplémentaire est assuré par la communauté.
Vous pouvez aider ce projet en devant un sponsor sur OpenCollective.
Asciidoctor lit du contenu écrit en texte brut, comme présenté dans la partie gauche de l’image ci-dessous, et le convertit en HTML 5, comme présenté dans la partie droite. Asciidoctor applique une feuille de style par défaut au document HTML 5 afin de fournir une expérience de lecture agréable, clé en main.
Asciidoctor lit et analyse la syntaxe du texte écrit en AsciiDoc afin de créer une représentation, sous forme d’arbre, à partir de laquelle des templates sont appliqués pour produire de l’HTML 5, du DocBook 5 et des pages de man(uel).
Vous avez la possibilité d’écrire votre propre convertisseur ou de fournir des templates supportant Tilt pour personnaliser le résultat généré ou pour produire des formats alternatifs.
Asciidoctor remplace le processeur AsciiDoc original écrit en Python (asciidoc.py).
La suite de tests Asciidoctor possède plus de 2,000 tests afin de garantir la compatibilité avec la syntaxe AsciiDoc.
En plus de la syntaxe AsciiDoc standard, Asciidoctor reconnaît des balises additionnelles ainsi que des options de formatage, comme les polices d’icônes (par exemple icon:fire[]) et des éléments d’interface (par exemple button:[Enregistrer]).
Asciidoctor offre aussi un thème moderne et « responsive » basé sur Foundation pour styliser le document HTML 5 généré.
Vous pouvez exécuter Asciidoctor dans la JVM en utilisant JRuby. Pour invoquer l’API Asciidoctor directement depuis Java ou d’autres langages de la JVM, utilisez AsciidoctorJ. Des plugins basés sur AsciidoctorJ permettent d’intégrer le processeur Asciidoctor avec Apache Maven, Gradle ou Javadoc.
Asciidoctor s’exécute également au sein de JavaScript. Nous utilisons Opal pour transcrire le code source Ruby en JavaScript afin de produire Asciidoctor.js, une version pleinement fonctionnelle d’Asciidoctor qui s’intègre dans tout environnement JavaScript, comme un navigateur web ou Node.js. Asciidoctor.js est utilisé pour faire fonctionner les extensions AsciiDoc Preview pour Chrome, Atom, Brackets et autres outils web.
Asciidoctor fonctionne sur Linux, macOS et Windows et requiert une des implémentations suivantes de Ruby :
-
CRuby (aka MRI) 2.3 - 2.6
-
JRuby 9.1 - 9.2
-
TruffleRuby (GraalVM)
-
Opal (JavaScript)
|
🔥
|
Si vous utilisez un environnement Windows dans une autre langue que l’anglais, vous pourriez tomber sur l’erreur chcp 65001 Après ce changement, tous les maux de tête liés à l’Unicode seront derrière vous. Si vous utilisez un environnement de développement comme Eclipse, assurez-vous de définir l’encodage en UTF-8. Asciidoctor fonctionne mieux lorsque vous utilisez UTF-8 partout. |
Asciidoctor peut être installé en utilisant (a) un gestionnaire de paquets Linux, (b) Homebrew pour macOS, (c) la commande gem install (recommandé pour les utilisateurs Windows), (d) l’image officielle Docker, ou (e) Bundler.
L’avantage d’utiliser le gestionnaire de paquets pour installer la gemme est que l’installation englobe celle des librairies Ruby et RubyGems si elles ne sont pas déjà installées.
La version installée par votre gestionnaire de paquets peut ne pas correspondre à la dernière version d’Asciidoctor. Consulter le dépôt de votre distribution Linux pour connaitre la dernière version disponible d’Asciidoctor en fonction de la version de votre distribution.
Si vous souhaitez installer une version plus récente d’Asciidoctor que celle proposée par votre gestionnaire de paquets, suivre la procédure d’installation gem.
Pour installer le paquet sur Alpine Linux, ouvrez un terminal et tapez :
$ sudo apk add asciidoctor
Sur Debian et les distributions dérivées de Debian, comme Ubuntu, utilisez APT pour installer Asciidoctor. Pour installer le paquet, ouvrez un terminal et tapez :
$ sudo apt-get install -y asciidoctor
Vous pouvez utiliser Homebrew, le gestionnaire de paquets sur macOS, pour installer Asciidoctor. Si vous n’avez pas encore installé Homebrew, suivez les instructions sur brew.sh.
Une fois Homebrew installé, vous pouvez installer Asciidoctor. Ouvrez un terminal et tapez :
$ brew install asciidoctor
Homebrew installe la gemme asciidoctor dans un répertoire spécifique qui est indépendant des gemmes système.
Avant d’installer Asciidoctor en utilisant gem install, il est recommandé d’utiliser RVM pour installer Ruby dans votre « home » (c’est-à-dire, votre espace utilisateur).
Ensuite, vous pouvez utiliser la commande gem pour installer ou mettre à jour la gemme Asciidoctor.
Quand vous utilisez RVM, les gemmes sont installées dans un répertoire isolé du système.
Ouvrez un terminal et tapez :
$ gem install asciidoctor
Si vous souhaitez installer une version pre-release (c’est-à-dire, une « release candidate »), utilisez :
$ gem install asciidoctor --pre
-
Créez un fichier Gemfile à la racine de votre projet (ou du répertoire courant)
-
Ajoutez la gemme
asciidoctordans votre fichier Gemfile comme ci-dessous :source 'https://rubygems.org' gem 'asciidoctor' # ou spécifier la version explicitement # gem 'asciidoctor', '2.0.15'
-
Sauvegardez le fichier Gemfile
-
Ouvrez un terminal et installez la gemme en utilisant :
$ bundle
Pour mettre à jour la gemme, spécifiez la nouvelle version dans le fichier Gemfile et exécutez bundle à nouveau.
Utiliser bundle update n'est pas recommandé car les autres gemmes seront également mises à jour, ce qui n’est pas forcément le résultat voulu.
Si vous avez installé Asciidoctor en utilisant votre gestionnaire de paquets, votre système d’exploitation est surement configuré pour mettre à jour automatiquement les paquets, si tel est le cas vous n’avez pas besoin de mettre à jour manuellement Asciidoctor.
Si vous avez précédemment installé Asciidoctor en utilisant la commande gem, vous devez manuellement mettre à jour Asciidoctor quand une nouvelle version est publiée.
Vous pouvez mettre à jour Asciidoctor en tappant :
$ gem install asciidoctor
Quand vous installez une nouvelle version en utilisant gem install, vous vous retrouvez avec plusieurs versions installées.
Utilisez la commande ci-dessous pour supprimer les anciennes versions :
$ gem cleanup asciidoctor
Si la gemme Asciidoctor s’est installée correctement, la ligne de commande (CLI) asciidoctor sera disponible dans votre PATH.
Pour vérifier sa disponibilité, exécutez la commande suivante dans votre terminal :
$ asciidoctor --version
Vous devriez voir les informations concernant la version d’Asciidoctor et celle de votre environnement Ruby s’afficher dans le terminal.
Asciidoctor 2.0.15 [https://asciidoctor.org] Runtime Environment (ruby 2.4.1p111 [x86_64-linux]) (lc:UTF-8 fs:UTF-8 in:- ex:UTF-8)
Asciidoctor fournit aussi une API. Cette API permet une intégration avec d’autres logiciels Ruby, comme Rails, Sinatra et GitHub, ainsi que d’autres langages comme Java (via AsciidoctorJ) ou JavaScript (via Asciidoctor.js).
La commande asciidoctor vous permet d’invoquer Asciidoctor à partir de la ligne de commande (c’est-à-dire, un terminal).
La commande suivante convertit le fichier README.adoc en HTML et sauvegarde le résultat dans le fichier README.html dans le même répertoire.
Le nom du fichier HTML généré est tiré de celui du fichier source, l’extension a été changée pour .html.
$ asciidoctor README.adoc
Vous pouvez contrôler le processeur Asciidoctor en ajoutant plusieurs paramètres, vous pouvez en apprendre plus sur ces derniers en utilisant la commande :
$ asciidoctor --help
Par exemple, pour écrire le fichier dans un répertoire différent, utilisez :
$ asciidoctor -D output README.adoc
La page man asciidoctor fournit une référence complète sur l’interface de ligne de commande.
Référez-vous aux ressources suivantes pour en apprendre davantage sur la façon d’utiliser la commande asciidoctor.
Pour utiliser Asciidoctor dans votre application, vous avez tout d’abord besoin de faire un « require » sur la gemme :
require 'asciidoctor'Vous pouvez ensuite convertir un fichier AsciiDoc en fichier HTML en utilisant :
Asciidoctor.convert_file 'README.adoc', to_file: true, safe: :safe|
|
Quand vous utilisez Asciidoctor via l’API, le mode de sûreté par défaut est :secure.
Dans le mode « secure », plusieurs fonctionnalités centrales sont désactivées, comme la directive include.
Si vous souhaitez activer ces fonctionnalités, vous aurez besoin de définir explicitement le mode de sûreté avec une la valeur :server (recommandée) ou :safe.
|
Vous pouvez aussi convertir une chaîne de texte en fragment HTML (pour une insertion dans une page HTML) en utilisant :
content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
Asciidoctor.convert content, safe: :safeSi vous voulez le document HTML complet, activez l’option header_footer comme ci-dessous :
content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
html = Asciidoctor.convert content, header_footer: true, safe: :safeSi vous avez besoin d’accéder au document analysé, vous pouvez séparer la conversion en deux étapes distinctes :
content = '_Zen_ in the art of writing https://asciidoctor.org[AsciiDoc].'
document = Asciidoctor.load content, header_footer: true, safe: :safe
puts document.doctitle
html = document.convertGardez en tête que si vous n’aimez pas le contenu généré par Asciidoctor, vous pouvez le changer ! Asciidoctor supporte des convertisseurs personnalisés qui peuvent prendre en charge la conversion depuis le document analysé jusqu’au contenu généré.
Une façon simple de personnaliser les morceaux de contenu générés est d’utiliser le convertisseur de template. Le convertisseur de template vous permet, en utilisant un template supporté par Tilt, de prendre en charge la conversion de n’importe quel élément dans le document.
Vous l’aurez compris, vous pouvez complètement prendre le contrôle sur le contenu généré. Pour plus d’informations sur comment utiliser l’API ou personnaliser le contenu généré, référez-vous au manuel utilisateur.
Les contributeurs et contributrices sont toujours les bienvenus ! Si vous découvrez des erreurs ou des oublis dans le code source, la documentation, ou le contenu du site web, s’il vous plaît n’hésitez pas à ouvrir un ticket ou une « pull request » avec un correctif.
Voici quelques façons de contribuer :
-
en utilisant les versions prerelease (alpha, beta ou preview),
-
en rapportant des anomalies,
-
en suggérant de nouvelles fonctionnalités,
-
en écrivant ou éditant la documentation,
-
en écrivant du code avec des tests — Aucun patch n’est trop petit
-
corriger une coquille,
-
ajouter des commentaires,
-
nettoyer des espaces inutiles,
-
écrire des tests !
-
-
en refactorant le code,
-
en corrigeant des anomalies,
-
en effectuant des relectures des patches.
Le guide du parfait Contributeur fournit des informations sur comment créer, styliser et soumettre des tickets, des demandes de fonctionnalités, du code et de la documentation pour le projet Asciidoctor.
Asciidoctor est développé dans le but de vous aider à écrire et publier du contenu. Mais nous ne pouvons pas le faire sans vos avis ! Nous vous encourageons à poser vos questions et à discuter de n’importe quels aspects du projet sur la liste de discussion, Twitter ou dans le salon de discussion.
- Chat (Zulip)
- Forum (Nabble)
-
hashtag #asciidoctor ou la mention @asciidoctor
De plus amples informations et documentations sur Asciidoctor peuvent être trouvées sur le site web du projet.
L’organisation Asciidoctor sur GitHub héberge le code source du projet, le gestionnaire de tickets ainsi que des sous-projets.
- Dépôt des sources (git)
- Gestionnaire de tickets
- L’organisation Asciidoctor sur GitHub
Copyright © 2012-2021 Dan Allen, Sarah White, Ryan Waldron, et les contributeurs individuels d’Asciidoctor. Une utilisation libre de ce logiciel est autorisée sous les termes de la licence MIT.
Consultez le fichier LICENSE pour plus de détails.
Asciidoctor est mené par Dan Allen et Sarah White et reçoit de nombreuses contributions de la part de la géniale communauté Asciidoctor. Le projet a été initié en 2012 par Ryan Waldron et est basé sur un prototype écrit par Nick Hengeveld.
AsciiDoc a été démarré par Stuart Rackham et a reçu de nombreuses contributions de la part de la communauté AsciiDoc.
Référez-vous au fichier CHANGELOG pour une liste complète des changements des versions précédentes.