Outils pour utilisateurs

Outils du site


prog:asciidoc

Ceci est une ancienne révision du document !


Description

Un éditeur de texte de type markdown.

Site Web

Installation

Manuelle

  • Installer Ruby
  • Installer AsciiDoc : gem install asciidoctor

Docker

docker pull asciidoctor/docker-asciidoctor

Pour exécuter une convertion, on lance docker puis asciidoctor.

docker run -v <your directory>:/documents/ --name asciidoc-to-html asciidoctor/docker-asciidoctor
asciidoctor -D /documents/output --out-file=specifications.fr.html doc/specifications/readme.fr.asciidoc

Editeur

Utiliser une interface graphique avec Brackets :

  • Installer Brackets
  • Installer l'extension (l'icône est en haut à gauche) AsciiDoc Live Preview
  • Installer et exécuter PlantUML Server via Docker : docker run -d -p 8080:8080 plantuml/plantuml-server:tomcat
  • Dans Brackets, cliquer sur la roue dentée qui apparaît quand la souris passe sur la Preview. Et régler l'URL à http://localhost:8080

Traduction

Cela se fait avec le paquet po4a.

  • Création du fichier de traduction

Utiliser le code de langage conformément à la norme ISO 639.

po4a-gettextize -f asciidoc -m documentation.asciidoc -p documentation_fr-FR.po
  • Traduire la documentation

On peut utiliser poedit

  • Création du fichier
po4a-translate -f asciidoc -m documentation.asciidoc -p documentation_fr-FR.po -l documentation_fr-FR.asciidoc -k 0
  • Mettre à jour le fichier de traduction suite à la mise à jour de la documentation
po4a-updatepo -f asciidoc -m documentation.asciidoc -p documentation_fr-FR.asciidoc

Travis

Le projet fourni une image Travis qu'il est possible d'intégrer à GitHub.

La page ci-dessous explique parfaitement comment faire. Par contre, l'interface de Travis a changé depuis et il faudra un peu chercher.

Convert AsciiDoc to HTML/PDF & publish to GitHub Pages with Travis CI and Asciidoctor Docker containers Archive du 28/03/2016 le 04/04/2020

Attributs

:last-update-label!:

Désactive la génération de la date lors du rendu HTML. Intéressant pour faire un diff sans se préoccuper de ce paramètre.

prog/asciidoc.1599423695.txt.gz · Dernière modification : 2020/09/06 22:21 de root