Asciidoc FX est un éditeur WYSIWYG pour le langage de balisage Asciidoc. Vous pouvez créer des livres, des documents et des diapositives au format PDF, Epub et HTML. AsciidocFX est également lauréat du Duke's Choice Award 2015.
Aperçu en temps réel
Multiplateforme (Windows, Mac, Linux)
Création de livres Asciidoc
Création de PDF, HTML, Epub, Mobi, Docbook
Visionneuse Epub
Prise en charge du navigateur externe
Générateur de tableaux
Extension MathJax
Extension PlantUML
Extension de sirène (expérimentale)
Extension ditaa
Extension de l'arborescence du système de fichiers
Extension de graphiques JavaFX
Surligneur de code source
Convertisseur Reveal.js
Convertisseur Deck.js
Prise en charge de Nashorn
Émulateur de pseudo-terminal
Thème (Dark & White) _Nouveau _
Il existe un certain nombre de systèmes d'exploitation pris en charge par AsciidocFX.
Note | Les dernières versions sont disponibles sur la page des versions de Github. |
Systèmes d'exploitation et versions pris en charge affiche la liste des versions disponibles avec des liens pour référence. Si vous recherchez la toute dernière version, visitez le lien dans la note ci-dessus pour être assuré de télécharger la dernière et la meilleure version d'AsciidocFX.
Note | Merci pour nous avoir fourni une licence open source pour les installateurs utilisés dans la distribution AsciidocFX. |
Note | Dans toutes les versions, nous utilisons les JRE AdoptOpenJDK, vous n'aurez donc aucun problème de licence concernant le JRE fourni. |
Système d'exploitation | Nom de fichier |
---|---|
Mac | AsciidocFX_Mac.dmg |
Mac M1 | AsciidocFX_Mac_M1.dmg |
Fenêtres | AsciidocFX_Windows.exe |
Fenêtres | AsciidocFX_Windows.zip |
Linux | AsciidocFX_Linux.tar.gz |
DEB Linux | AsciidocFX_Linux.deb |
Régime Linux | AsciidocFX_Linux.rpm |
Vous pouvez installer AsciidocFX via les installateurs Deb ou Rpm ou via le fichier Archive.
$ tar –xvzf AsciidocFX_Linux.tar.gz
$ cd AsciidocFX/bin
$ chmod +X ./AsciidocFX
$ ./AsciidocFX
Téléchargez l'exécutable/installateur et exécutez-le.
Téléchargez le .dmg
et exécutez-le.
ou
Utilisez Homebrew pour l'installer avec une seule commande : brew install --cask asciidocfx
Vidéo - Écrire des livres avec Asciidoc FX
AsciidocFX peut convertir les documents Asciidoc en HTML, PDF, EPUB3 et DOCBOOK5.
AsciidocFX convertit les documents via la bibliothèque AsciidoctorJ. Pour les backends PDF, vous pouvez également utiliser la conversion Docbook → Fop → PDF.
AsciidocFX prend en charge de nombreuses extensions telles que PlantUML, Ditaa, Charts, File Trees et bien d'autres diagrammes Asciidoctor qui peuvent être trouvés sur https://docs.asciidoctor.org/diagram-extension/latest/
Vous pouvez répondre à vos besoins UML avec AsciidocFX. Il prend en charge PlantUML. AsciidocFX convertit ces éléments UML textuels en image png ou svg.
PlantUML est un composant qui permet d'écrire rapidement :
Diagramme de séquence,
Diagramme de cas d'utilisation,
Diagramme de classes,
Diagramme d'activité, (voici la nouvelle syntaxe),
Schéma des composants,
Diagramme d'état,
Diagramme d'objet.
interface graphique filaire
. UML Diagram Example
[ uml , target = "uml-example" ]
--
abstract class AbstractList
abstract AbstractCollection
interface List
interface Collection
List <|-- AbstractList
Collection <|-- AbstractCollection
Collection <|- List
AbstractCollection <|- AbstractList
AbstractList <|-- ArrayList
class ArrayList {
Object [] elementData
size ()
}
enum TimeUnit {
DAYS
HOURS
MINUTES
}
annotation SuppressWarnings
--
Note | Dans certains éléments UML, PlantUML doit fonctionner avec Graphviz. Pour cette raison, vous devez installer Graphviz manuellement pour votre plateforme. Après avoir installé Graphviz, vous devez définir la variable d'environnement GRAPHVIZ_DOT sur dot exécutable dans Graphviz. |
Mermaid vous permet de créer des diagrammes en utilisant du texte et du code. Cela simplifie la maintenance de diagrammes complexes. Voir plus d'exemples : https://mermaid-js.github.io/
Note | mermaid-cli doit être installé pour la génération de diagrammes de sirène. npm install @mermaid-js/mermaid-cli Détails d'installation : https://github.com/mermaid-js/mermaid-cli#install-locally |
[mermaid,target="mermaid-graph"]
--
graph TD
A[Start] -- > B{Is it?};
B -- Yes -- > C[OK];
C -- > D[Rethink];
D -- > B;
B -- No -- -- > E[End];
--
[mermaid,target="mermaid-flowchart"]
--
flowchart TB
c1 -- >a2
subgraph one
a1 -- >a2
end
subgraph two
b1 -- >b2
end
subgraph three
c1 -- >c2
end
one -- > two
three -- > two
two -- > c2
--
AsciidocFX prend en charge les diagrammes ditaa.
ditaa est un composant qui convertit les diagrammes dessinés en art ascii en graphiques bitmap.
.ditaa Diagram Example
[ditaa,target="ditaa-example"]
--
+--------+ +-------+ +-------+
| |- -- + ditaa + - -- >| |
| Text | +-------+ |diagram|
|Document| |!magic!| | |
| {d} | | | | |
+---+----+ +-------+ +-------+
: ^
| Lots of work |
+-------------------------+
--
MathJax est un moteur d'affichage JavaScript open source pour les mathématiques qui fonctionne dans tous les navigateurs.
Vous pouvez utiliser les langages Tex
ou MathML
pour décrire des formules mathématiques dans AsciidocFX. AsciidocFX convertit ces formules textuelles en image png ou svg.
[latexmath,target="tex-formula"]
--
begin { align }
dot {x} & = sigma (y-x) \
dot {y} & = rho x - y - xz \
dot {z} & = - beta z + xyp
end { align }
--
[mathml,target="mathml-formula"]
--
< math xmlns = " http://www.w3.org/1998/Math/MathML " display = " block " >
< mi >x</ mi >
< mo >=</ mo >
< mrow >
< mfrac >
< mrow >
< mo > − </ mo >
< mi >b</ mi >
< mo > ± </ mo >
< msqrt >
< msup >
< mi >b</ mi >
< mn >2</ mn >
</ msup >
< mo > − </ mo >
< mn >4</ mn >
< mi >a</ mi >
< mi >c</ mi >
</ msqrt >
</ mrow >
< mrow >
< mn >2</ mn >
< mi >a</ mi >
</ mrow >
</ mfrac >
</ mrow >
< mtext >.</ mtext >
</ math >
--
Vous pouvez représenter l'arborescence du système de fichiers dans le bloc tree
suivant. Il existe deux styles d’arborescence FS.
[ tree , target = "tree-view" ]
--
# src
## main
### java
#### com
##### kodcu
###### App . java
### resources
#### css
##### style . css
#### js
##### script . js
#### images
##### image . png
--
Lorsque vous faites glisser et déposez un dossier dans l'éditeur, AFX générera automatiquement cet arbre semblable à celui-ci.
[ tree , target = "tree-view-new" ]
--
root
|-- photos
| |-- camp . gif
| |-- festival . png
| `-- balloon . jpg
|-- videos
| |-- car - video . avi
| |-- dance . mp4
| |-- dance01 . mpg
| |-- another video . divx
| `-- school videos
| `-- firstday . flv
|-- documents
| |-- jsfile . js
| |-- powerpoint . ppt
| |-- chapter - 01. asc
| |-- archive - db . zip
| |-- . gitignore
| |-- README
| `-- configuration . conf
`-- etc .
--
JavaFX dispose de 8 types de composants graphiques et AsciidocFX les prend tous en charge.
[chart,pie,target="secim-2014-pie",opt="title=2014 YEREL SEÇİM SONUÇLARI"] -- AKP, 45,6, orange CHP, 27,8, rouge MHP, 15.2 PDB, 4.2 SP, 2 --
[graphique,zone,target="area-chart"] -- //Avril 1, 4 3, 10 6, 15 9, 8 12, 5 //Peut 1, 20 3, 15 6, 13 9, 12 12, 14 --
Pour d'autres graphiques et options disponibles, consultez la page wiki de l'extension de graphique !
Tout d'abord, installez le JDK 17
Téléchargez Apache Maven et définissez le répertoire /bin
sur les variables d'environnement
Entrez dans le répertoire AsciidocFX
et exécutez $ mvn clean install
Suivez le répertoire target/appassembler/bin
et vous verrez asciidocfx.sh
et asciidocfx.bat
Note | Nous générons automatiquement des builds avec Github Actions . |
GitHub
ePub + Kindle + PDF
GitHub
ePub + Kindle + PDF
Ancienne version sur GitHub et GitBook
ePub + Kindle + PDF
AsciidocFX prend en charge les diapositives en utilisant le backend Asciidoctor Reveal.js. Pour commencer à créer des diapositives, vous pouvez simplement suivre le menu Nouveau > Diapositive .
Après cela, AFX vous demandera un nom de répertoire d'espace libre et "OK", vous verrez la démo de diapositive.
Vous pouvez facilement basculer entre révélation.js et deck.js en modifiant le commentaire ci-dessous. Vous pouvez également configurer les paramètres par défaut en modifiant _settings_reveal.adoc
et include::_settings_deck.adoc
.
include::_settings_reveal.adoc[]
AsciidocFX utilise les technologies liées à Java, JavaScript et XML.
JavaFX18
AsciidoctorJ
Asciidoctor.js (obsolète)
Botte de printemps
WebSocket de printemps
Docbook
Apache Fop
Saxon 6.5
Éditeur d'as
Vous pouvez configurer AsciidocFX avec la page Paramètres (Appuyez sur Ctrl + F4 ). Toutes les configurations situées dans le dossier [Install_Dir]/conf.
L'éditeur dans AsciidocFX est basé sur Ace.js ( https://github.com/ajaxorg/ace/wiki/Default-Keyboard-Shortcuts ). AsciidocFX prend en charge les raccourcis clavier répertoriés ci-dessous. Tous sont configurables sous Settings > Shortcut
. Les événements de clavier sont gérés par AsciidocFX, si vous souhaitez qu'ils soient gérés par Ace.js lui-même, vous pouvez désactiver "Gestionnaire de raccourcis personnalisés" dans les paramètres.
Description | Raccourci (Win/Linux) | Raccourci (Mac) | Nom de la commande |
---|---|---|---|
Ajouter un curseur au-dessus | Ctrl + Alt + Haut | Ctrl + Alt + Haut | addCursorAbove |
Ajouter le curseur ci-dessus (ignorer le courant) | Ctrl + Alt + Maj + Haut | Ctrl + Alt + Maj + Haut | addCursorAboveSkipCurrent |
Ajouter un curseur ci-dessous | Ctrl + Alt + Bas | Ctrl + Alt + Bas | addCursorBelow |
Ajouter un curseur ci-dessous (ignorer le courant) | Ctrl + Alt + Maj + Bas | Ctrl + Alt + Maj + Bas | addCursorBelowSkipCurrent |
Ajouter une nouvelle ligne après la ligne actuelle | Commande + Retour | Commande + Retour | ajouterLigneAprès |
Ajouter une nouvelle ligne avant la ligne actuelle | Commande + Maj + Retour | Commande + Maj + Retour | addLineAvant |
Aligner les curseurs | Ctrl + Alt + A | Ctrl + Alt + A | alignCurseurs |
Ajouter un titre | Ctrl + H | Ctrl + H | ajouter un titre |
Retour arrière | Maj + Retour arrière OU Retour arrière | Ctrl + Retour arrière OU Maj + Retour arrière OU Retour arrière OU Ctrl + H | retour arrière |
Bloquer le retrait | Ctrl+ | Ctrl+ | bloquer l'indentation |
Bloquer le retrait | Ctrl + [ | Ctrl + [ | bloquer |
Sélection audacieuse | Ctrl + B | Commande + B | sélection en gras |
Sélection du centre | Ctrl + L | sélection des centres | |
Changer le mode de langue… | Commande + K OU Entrée + M | Commande + K OU Entrée + M | modeSélectionner |
Codifier la sélection | Ctrl + Maj + C | Commande + Maj + C | codifier-sélectionné |
Copie la sélection dans l'éditeur | Ctrl + C | Commande + C | copieX |
Copier les lignes vers le bas | Ctrl + D | Commande + D | lignes de copie vers le bas |
Copier les lignes | Alt + Maj + Haut | Commande + Option + Haut | copylinesup |
Coupe la sélection dans l'éditeur | Ctrl + X | Commande + X | couperX |
Supprimer | Supprimer OU Ctrl + D OU Maj + Suppr | Supprimer OU Ctrl + D OU Maj + Suppr | del |
Sélection en double | Ctrl + Maj + D | Commande + Maj + D | dupliquer la sélection |
Développer jusqu'à la ligne | Ctrl + Maj + L | Commande + Maj + L | développer la ligne |
Développer jusqu'à la correspondance | Ctrl + Maj + M | Ctrl + Maj + M | développerToMatching |
Trouver | Ctrl + F | Commande + F | trouver |
Trouver tout | Ctrl + Alt + K | Ctrl + Alt + G | trouverTout |
Rechercher ensuite | Ctrl + K | Commande + G | trouversuivant |
Rechercher précédent | Ctrl + Maj + K | Commande + Maj + G | trouverprécédent |
Pli | Alt-L OU Ctrl-F1 | Commande-Alt-L OU Commande-F1 | pli |
Pliez tout | Commande + K OU Commande + 0 | Ctrl + Commande + Option + 0 | pliable |
Pliez tous les commentaires | Ctrl + Commande + Option + 0 | plierTouslesCommentaires | |
Pliez les autres | Alt + 0 | Commande + Option + 0 | plierAutre |
Allez faire la queue | Bas OU Ctrl + N | Bas OU Ctrl + N | golinedown |
Allez faire la queue | Haut OU Ctrl + P | Haut OU Ctrl + P | golineup |
Aller à la fin | Ctrl + Fin | Commande + Fin OU Commande + Bas | aller à la fin |
Allez à gauche | Gauche OU Ctrl + B | Gauche OU Ctrl + B | aller à gauche |
Aller à la fin de la ligne | Alt + Droite OU Fin | Commande + Droite OU Fin OU Ctrl + E | aller à la fin de la ligne |
Aller au début de la ligne | Alt + Gauche OU Accueil | Commande + Gauche OU Accueil OU Ctrl + A | gotolinestart |
Aller à la ligne… | Ctrl + L | Commande + L | aller en ligne |
Passer à l'erreur suivante | Alt + E | F4 | goToNextErreur |
Aller à la page suivante | Page suivante OU Ctrl + V | Page suivante OU Ctrl + V | aller vers le bas |
Aller à l'erreur précédente | Alt + Maj + E | Maj + F4 | goToPreviousErreur |
Allez à droite | Droite OU Ctrl + F | Droite OU Ctrl + F | aller à droite |
Allez pour commencer | Ctrl + Accueil | Commande + Accueil OU Commande + Haut | commencer |
Aller au mot gauche | Ctrl + Gauche | Option + Gauche | aller au mot gauche |
Allez au mot à droite | Ctrl + Droite | Option + Droite | aller au mot droit |
Sélection italique | Ctrl + I OU Ctrl + © OU Ctrl + I OU Ctrl + I | Commande + I OU Commande + © OU Commande + I OU Commande + I | sélectionné en italique |
Aller à la correspondance | Ctrl + ] OU kbd:[Ctrl + P | kbd : [Commande+] | sauter à la correspondance |
Modifier le numéro vers le bas | Ctrl + Maj + Bas | Alt + Maj + Bas | modifierNumberDown |
Modifier le numéro vers le haut | Ctrl + Maj + Haut | Alt + Maj + Haut | modifierNumberUp |
Déplacer les lignes vers le bas | Alt + Bas | Option + Bas | déplacer les lignes vers le bas |
Déplacer les lignes vers le haut | Alt + Haut | Option + Plus | movelinesup |
Ouvrir le lien | Ctrl + F3 | F3 | lien ouvert |
Ouvrir la palette de commandes | F1 | F1 | openCommandPalette |
Dépassé | Maj + Tab | Maj + Tab | dépassement |
Page suivante | Ctrl + Page suivante | Option + Page suivante | page suivante |
Page précédente | Ctrl + Page précédente | Option + Page précédente | mise en page |
Colle du presse-papiers vers l'éditeur AsciidocFX | Ctrl + Maj + V | Commande + Maj + V | collerX |
Refaire | Ctrl + Maj + Z OU Ctrl + Y | Commande + Maj + Z OU Commande + Y | refaire |
Supprimer la ligne | Ctrl + D | Commande + D | supprimer la ligne |
Supprimer jusqu'à la fin de la ligne | Alt + Suppr | Ctrl + K OU Commande + Supprimer | supprimer à la fin de la ligne |
Supprimer au début de la ligne | Alt + Retour arrière | Commande + Retour arrière | supprimer au début de la ligne |
Supprimer le mot restant | Ctrl + Retour arrière | Alt + Retour arrière OU Ctrl + Alt + Retour arrière | supprimer le mot gauche |
Supprimer le mot à droite | Ctrl + Suppr | Alt + Suppr | supprimer le motdroit |
Remplacer | Ctrl + H | Commande + Option + F | remplacer |
Rejouer la macro | Ctrl + Maj + E | Commande + Maj + E | replaymacro |
Tout sélectionner | Ctrl + A | Commande + A | tout sélectionner |
Sélectionnez vers le bas | Maj + Bas OU Ctrl + Maj + N | Maj + Bas OU Ctrl + Maj + N | sélection |
Sélectionnez à gauche | Maj + Gauche OU Ctrl + Maj + B | Maj + Gauche OU Ctrl + Maj + B | sélectionner à gauche |
Sélectionnez plus après | Ctrl + Alt + Droite | Ctrl + Alt + Droite | sélectionnerPlusAprès |
Sélectionnez plus avant | Ctrl + Alt + Gauche | Ctrl + Alt + Gauche | sélectionnerPlusAvant |
Sélectionnez suivant après | Ctrl + Alt + Maj + Droite | Ctrl + Alt + Maj + Droite | sélectionnerSuivantAprès |
Sélectionnez suivant avant | Ctrl + Alt + Maj + Gauche | Ctrl + Alt + Maj + Gauche | sélectionnerSuivantAvant |
Sélectionner ou rechercher suivant | Alt + K | Ctrl + G | sélectionnerOuRechercherSuivant |
Sélectionnez ou recherchez le précédent | Alt + Maj + K | Ctrl + Maj + G | sélectionnerOuRechercherPrécédent |
Sélectionnez à droite | Maj + Droite | Maj + Droite | sélectionner à droite |
Sélectionnez pour terminer | Ctrl + Maj + Fin | Commande + Maj + Fin OU Commande + Maj + Bas | sélectionnerpourfin |
Sélectionner pour terminer la ligne | Alt + Maj + Droite | Commande + Maj + Droite OU Maj + Fin OU Ctrl + Maj + E | sélectionner la fin de la ligne |
Sélectionnez pour commencer la ligne | Alt + Maj + Gauche | Commande + Maj + Gauche OU Ctrl + Maj + A | sélectionner pour démarrer la ligne |
Sélectionnez pour correspondre | Ctrl + Maj + ] OU kbd:[Ctrl + Maj + P | kbd : [Commande+Maj+] | sélectionner pour correspondre |
Sélectionnez pour commencer | Ctrl + Maj + Accueil | Commande + Maj + Accueil OU Commande + Maj + Haut | sélectionner pour démarrer |
Sélectionnez | Maj + Haut OU Ctrl + Maj + P | Maj + Haut OU Ctrl + Maj + P | sélection |
Sélectionner le mot restant | Ctrl + Maj + Gauche | Option + Maj + Gauche | sélectionner le motgauche |
Sélectionnez le mot à droite | Ctrl + Maj + Droite | Option + Maj + Droite | sélectionner le mot à droite |
Afficher la console Firebug | F12 | F12 | firebug-lite |
Afficher les numéros de ligne | Ctrl + L | Commande + L | numéros de ligne |
Afficher le menu des paramètres | Ctrl + , | Commande + , | showParamètresMenu |
Trier les lignes | Ctrl + Alt + S | Commande + Alt + S | lignes de tri |
Divisé en lignes | Alt + Maj + I | Alt + Maj + I | splitSelectionIntoLines |
Ligne divisée | Ctrl + O | ligne divisée | |
Diviser la sélection en lignes | Ctrl + Alt + L | Ctrl + Alt + L | toggleSplitSelectionIntoLines |
Extraits d'onglets et de texte | Languette | Languette | retrait |
En minuscule | Ctrl + Maj + U | Ctrl + Maj + U | en minuscule |
En majuscule | Ctrl + U | Ctrl + U | en majuscule |
Activer/désactiver le blocage des commentaires | Ctrl + Maj + / | Commande + Maj + / | toggleBlockComment |
Basculer le commentaire | Ctrl + / | Commande + / | basculer le commentaire |
Basculer le widget de pliage | F2 | F2 | toggleFoldWidget |
Basculer le widget de repli parent | Alt + F2 | Alt + F2 | toggleParentFoldWidget |
Activer/désactiver l'enregistrement | Ctrl + Alt + E | Commande + Option + E | basculer l'enregistrement |
Transposer les lettres | Alt + Maj + X | Ctrl + T | transposelettres |
Souligner la sélection | Ctrl + U | Commande + U | souligné-sélectionné |
Défaire | Ctrl + Z | Commande + Z | défaire |
Se dérouler | Alt-Maj-L OU Ctrl-Maj-F1 | Commande-Alt-Maj-L OU Commande-Maj-F1 | se dérouler |
Dépliez tout | Alt + Maj + 0 | Commande + Option + Maj + 0 | se dérouler |
Sur les plateformes Linux, vous pouvez être confronté à ce problème. Pour résoudre le problème, vous devez installer les polices Microsoft Core sur votre plate-forme. Comment installer [microsoft-core-fonts]
Il y a un bug dans JavaFX qui fait que tous les claviers d'un Mac se comportent comme "QWERTY". Cela signifie que sur une disposition "QWERTZ" allemande, les raccourcis pour undo
et redo
sont inversés.
Si vous êtes distrait par des artefacts de texte arc-en-ciel sur le texte, vous pouvez contourner le problème en transmettant certaines options de VM dans [Install_Dir]/AsciidocFX.vmoptions
, comme partagé dans ce bogue RichTextFX.
Ouvrez AsciidocFX.vmoptions
.
Ajoutez -Dprism.text=t2k
et -Dprism.lcdtext=false
au fichier.
Enregistrez et fermez.
Lancer AsciidocFX
Pour voir ce qui a changé dans les versions récentes d'AsciidocFX, consultez le CHANGELOG
Soutenez AsciidocFX avec des demandes d'extraction ou ouvrez un problème pour les demandes de bogues et de fonctionnalités. Vous pouvez discuter dans un groupe de messagerie ou dans la salle de discussion sur Gitter.im.
Merci à toutes les personnes qui ont déjà contribué à AsciidocFX !
Merci à tous nos contributeurs ! [Devenez contributeur]
Merci à tous nos sponsors ! (veuillez demander à votre entreprise de soutenir également ce projet open source en devenant sponsor)