Asciidoc FX is a book / document editor to build PDF, Epub, Mobi and HTML books, documents and slides. AsciidocFX is also a winner of Features
Real-Time Preview
Multi-platform (Windows, Mac, Linux)
Creating Asciidoc Books
Creating Markdown Books
Creating PDF, HTML, Epub, Mobi, Docbook
Epub Viewer
External Browser Support
Table Generator
MathJax Extension
PlantUML Extension
ditaa Extension
Filesystem Tree Extension
JavaFX Charts Extension
Source Code Highlighter
Reveal.js Converter
Deck.js Converter
Nashorn support
Pseudo Terminal Emulator
Themeing (Dark & White) _New _
There are a number of operating systems that AsciidocFX supports.
| OS | Filename |
|---|---|
Mac |
|
Windows |
After the download is completed, untar the package in your preferred directory.
$ sh AsciidocFX
Download the .dmg and run it.
or
There are two AsciidocFX package flavors, you can download it with JRE 8 out-of-box or if you have already installed JRE 8 (Update 40 or above), you can download *No_JRE builds
PlantUML extension needs Graphviz, if you will use it, then install it:
sudo apt-get install graphviz
ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)" brew install graphviz
http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msi
You must install Microsoft Core Fonts on Linux OSes also.
Ubuntu/Debian
sudo apt-get install ttf-mscorefonts-installer
Fedora
If you are using Fedora, you need to install the RPM provided from this URL: KindleGen, If you need to convert your documents into Mobi files. Once you specify the location of KindleGen executable, Mobi Service provided by AFX will be available.
Graphviz manually for your platform. After installing Graphviz, you should set GRAPHVIZ_DOT environment variable to dot executable in Graphviz.
[math,file="mathml-formula.png"] -- <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> --
You can represent filesystem tree in following tree block. There is two style of FS tree.
[tree,file="tree-view.png"] -- #src ##main ###java ####com #####kodcu ######App.java ###resources ####css #####style.css ####js #####script.js ####images #####image.png --
When you drag and drop a folder to editor, AFX will generate this like tree automatically.
[tree,file="tree-view-new.png"] -- 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 has 8 kind of Chart component and AsciidocFX supports all of them.
[chart,pie,file="secim-2014-pie.png",opt="title=2014 YEREL SEÇİM SONUÇLARI"] -- AKP, 45.6, orange CHP, 27.8,red MHP, 15.2 BDP, 4.2 SP, 2 --
chart::pie[data-uri="pie.csv",file="secim-2014-pie-csv.png"]
[chart,area,file="area-chart.png"] -- //April 1, 4 3, 10 6, 15 9, 8 12, 5 //May 1, 20 3, 15 6, 13 9, 12 12, 14 --
chart::area[data-uri="area.csv",file="area-chart-csv.png"]
For other charts and available options, look at How to Build AsciidocFX
Firstly, install Apache Maven and set /bin directory to environment variables
Enter AsciidocFX directory and run $ mvn clean install
Follow to target/appassembler/bin directory and you will see asciidocfx.sh and asciidocfx.bat
Slides (Reveal.js and Deck.js)
AsciidocFX has a built-in template converter for Reveal.js and Deck.js. To getting start with slide authoring, you can just follow New › Slide menu.
After that AFX will prompt you a freespace directory name and "OK" you will see the slide demo.
You can easily switch between reveal.js and deck.js by changing the comment below. Also, you can configure default settings by editing _settings_reveal.adoc and include::_settings_deck.adoc.
include::_settings_reveal.adoc[] // include::_settings_deck.adoc[]
AsciidocFX uses Java, JavaScript and XML related technologies.
Java FX 8
Asciidoctor.js
Spring Boot
Spring WebSocket
Docbook
Apache Fop
Saxon 6.5
Ace editor
Nashorn
You can configurate AsciidocFX with Settings page (Press Ctrl+F4). The all configs located in [Install_Dir]/conf folder.
On Linux platforms you can face with this issue. For the getting around for the issue you need to install Microsoft Core Fonts to your platform. How to install [microsoft-core-fonts]
There is a bug in JavaFX which makes all keyboards on a Mac behave as "QWERTY".
This means, that on a German "QWERTZ" layout the shortcuts for undo and redo are swapped.
If you are being distracted by rainbow text artifacts on text, you can work around the issue by passing some VM options in [Install_Dir]/AsciidocFX.vmoptions, as shared in Changelog
To see what has changed in recent versions of AsciidocFX, see the Support
Support AsciidocFX with pull requests or open an issue for bug & feature requests. You can make discussions in Gitter.im.
Thank you to all the people who have already contributed to AsciidocFX! Contributors
Thank you to all our backers! [Backers on Open Collective