Étiquette : Doc

Éditeurs Asciidoc

Asciidoc est un langage de formatage de texte (comme markdown), permettant de générer des formats de fichier html, pdf, MS word,epub, docbook, tex.Un de ces objectifs est d’être lisible, même sans visionneuse. Un simple éditeur texte suffit pour l’utiliser. Mais un éditeur ayant des fonctions avancé (syntaxe colorée en autre) est un plus.

Pour ma part je l’utilise, pour écrire des notes, et de la documentation applicatives. À ce titre j’utilise plusieurs éditeurs.

Les éditeurs :

AsciidoFX (Linux, Windows, OsX, Java)

Il peut être considéré comme l’éditeur AsciiDoc.
asciidocFX
Il est écrit en Java et peut donc fonctionner sur tout système d’exploitation (Windows, Mac, Linux, …) supportant Java 8 .

Ses particularités sont

  • affiche une prévisualisation HTML en temps réel.
  • Coloration syntaxique.
  • Icônes de raccourcie tel que gras, tableau…
  • Affiche la « table des matières » (« outline ») de votre document sur la gauche. Très utile pour se repérer.
  • ergonome
  • agréable
  • possibilité de modifier les thèmes de génération des documents
  • Supporte d’office les formats de sortie HTML,PDF,DocBook, odt (Libre office), Ebook, Un clique sur un bouton et hop, vous pouvez donner vos notes, doc à vos clients ou collaborateurs.
  • supporte d’autres formats dont markdown
  • Libre d’usage. Un don est apprécié.

Deux petites remarques :

  • il est en Anglais
  • Et a mon gout il est un peut lent a ce lancer (même sur un config puissant, peut être à cause de l’antivirus), il met 6 secondes.
    Mais c’est l’éditeur que j’utilise le plus.

Site web (Anglais) : http://asciidocfx.com/

Sources : https://github.com/asciidocfx

NotePad++ (Windows)

C’est un éditeur de texte pur.
Notepad++
Il n’est pas dédié à Asciidoc et ne possède pas de mode de prévisualisation .
Localisé en Français et autre langue.
Fonctionne que sous Windows. Sources accessible, libre d’usage, Licence GNU.
Son avantage est sa légèreté et sa rapidité (c’est le meilleur de tous les éditeurs à ce niveau).
Il est possible de lui adjoindre la syntaxe colorée en important (menu « Langage/Définissez votre langage », puis bouton « importer » ) le fichier de définition suivant :

Si vous ne le trouvez pas, allez voir sur :

Sites web (français,anglais,chinois): https://notepad-plus-plus.org/

Emacs (Linux, Windows, OsX)

Éditeur Unix apprécier de ces détracteurs. En général ceux qui aime Emacs, n’aiment pas VI/VIM.
C’est l’éditeur ultime. Il possède le mode d’enregistrement de macro ultime (c’est mon avis).
En Anglais et fonctionne sous Windows, Mac, Linux. Sources accessible, libre d’usage, Licence GNU.
Il possède un mode AsciiDoc que vous trouverez sur le site :

https://www.emacswiki.org/emacs/AsciiDoc

VIM (Linux, Windows, OsX)

Éditeur Unix lège apprécier de ces détracteurs. Un peu dure à utiliser les premières fois.
En Anglais et fonctionne sous Windows, Mac, Linux. Sources accessible, libre d’usage, Licence GNU.
Il possède un mode AsciiDoc que vous trouverez sur le site :

gedit (Linux)

Éditeur texte sous Linux.
En anglais et fonctionne sous Linux. Sources accessible, libre d’usage, Licence GNU.
Il est possible de lui adjoindre la syntaxe colorée et un mode de prévisualisation :

AsciidocLive

C’est un site web (Anglais) qui propose un éditeur en ligne temps réel, avec prévisualisation.

asciidocLive

Site web : https://asciidoclive.com/edit/scratch/1

Ressources

Vous trouverez le convertisseur AsciiDoc ainsi que sa documentation anglaise sur le site :

Site web : http://www.methods.co.nz/asciidoc/

 

Écrire votre doc sous Eclipse avec le plugin Markdown Editor

Markdown est un langage permettant d'écrire de la documentation au travers d'un formalisme proche du texte pur et permettant la génération automatique de fichier PDF, HTML et autre.

Cella permet en autre d'écrire en une seule fois une documentation, pour l'intégrer en HTML dans votre application, tout en fournissant le même contenu en PDF.
Plus besoin de maintenir deux fichiers ! Et la conversion vers le PDF est aussi bonne que celle du HTML, au contraire de certains outils de conversion HTML vers PDF.

Lire la suite