Asciidoc FX is a book / document editor to build HTML, PDF, Epub or Mobi ebooks.
-
Multi-platform (Windows, Mac, Linux ..)
-
Creating Asciidoc Books
-
Creating PDF, HTML, Epub, Mobi, Docbook
-
Full-Screen & External Browser Support
-
Real-Time Preview
-
Table Generator
-
MathJax Support
-
PlantUML Support
You can fulfill your UML needs with AsciidocFX. It supports PlantUML.
PlantUML is a component that allows to quickly write :
-
Sequence diagram,
-
Usecase diagram,
-
Class diagram,
-
Activity diagram, (here is the new syntax),
-
Component diagram,
-
State diagram,
-
Object diagram.
-
wireframe graphical interface
.UML Diagram Example
[uml,file="uml-example.png"]
--
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
|
In some UML elements, PlantUML needs to work with Graphviz. Because of this, you should install Graphviz manually for your platform. After installing Graphviz, you should set GRAPHVIZ_DOT environment variable to dot executable in Graphviz.
|
MathJax is an open source JavaScript display engine for mathematics that works in all browsers.
You can use Tex or MathML languages for describing mathematical formulas in AsciidocFX. AsciidocFX converts this textual formulas as png image.
[math,file="tex-formula.png"]
--
\begin{align}
\dot{x} & = \sigma(y-x) \\
\dot{y} & = \rho x - y - xz \\
\dot{z} & = -\beta z + xyp
\end{align}
--
[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>
--
|
Important
|
Requires Internet Connection. AsciidocFX fetchs MathJax dependencies from CDN. |
-
Firstly, install JRE 8
-
Download the latest AsciidocFX.zip and Extract it
-
Run
-
bin/asciidocfx.batorbin/asciidocfx.sh
-
-
Firstly, install JDK 8
-
Download Apache Maven and set
/bindirectory to environment variables -
Enter
AsciidocFXdirectory and run$ mvn clean install -
Follow to
target/directory and you will seeAsciidocFX.zip
- Java 8 Ebook
- AspectJ Ebook
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
You can configurate AsciidocFX with config.yml file in /conf directory
You can change Ace theme, font size, font family and other sections by editing it.
AsciidocFX has some custom shortcuts. If you suggest us any shortcut request, we can implement it.
| Shortcut | Detail |
|---|---|
tblx,y+Tab |
Generates asciidoc table (x=row,y=column) |
tblx.y+Tab |
Generates asciidoc table (x=row,y=column) |
src+Tab |
Generates asciidoc source block (default lang: java) |
src.lang+Tab |
Generates asciidoc source block by lang |
src,lang+Tab |
Generates asciidoc source block by lang |
img+Tab |
Generates image section |
book+Tab |
Generates book header section |
uml+Tab |
Generates UML block |
math+Tab |
Generates Math block |
Ctrl+B |
Bolds selection |
Ctrl+I |
Italices selection |
Ctrl+U |
Underlines selection |
Ctrl+D |
Duplicates selection |
Ctrl+X |
Removes current line |
Ctrl+N |
Creates new empty doc |
Ctrl+S |
Saves current doc |
Ctrl+W |
Saves and closes current doc |
Ctrl+Shift+C |
Surrounds backtick `` selection |
Ctrl+Mouse_Scroll_Up |
Zoom in |
Ctrl+Mouse_Scroll_Down |
Zoom out |
F12 |
Opens Firebug Lite (Requires Internet Connection) |
Support AsciidocFX with pull request or open an issue for bug & feature request. You can make discussions in mail group. https://groups.google.com/d/forum/asciidocfx-discuss
Rahman USTA
[email protected]
Thanks.