Skip to content

Commit

Permalink
Update ReadME
Browse files Browse the repository at this point in the history
  • Loading branch information
rahmanusta committed Aug 11, 2015
1 parent fa6774c commit 77e6134
Show file tree
Hide file tree
Showing 5 changed files with 36 additions and 10 deletions.
46 changes: 36 additions & 10 deletions README.asc
Original file line number Diff line number Diff line change
Expand Up @@ -16,18 +16,21 @@ image::images/asciidocfx.png[]
== Features

* Real-Time Preview
* Multi-platform (Windows, Mac, Linux ..)
* Multi-platform (Windows, Mac, Linux)
* Creating Asciidoc Books
* Creating Markdown Books
* Creating PDF, HTML, Epub, Mobi, Docbook
* Creating PDF, HTML, Epub, Mobi, Odt, 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

== How to Install AsciidocFX

Expand All @@ -53,12 +56,14 @@ After the download is completed, untar the package in your preferred directory.
$ cd /bin
$ ./AsciidocFX.sh

////
*Arch Linux*
Also you can install with package manager in Arch Linux
[source,bash]
$ yaourt -S asciidocfx
////

*Windows*

Expand Down Expand Up @@ -93,7 +98,7 @@ brew install graphviz
http://www.graphviz.org/pub/graphviz/stable/windows/graphviz-2.38.msi
----


[[microsoft-core-fonts]]
Microsoft Core Fonts::
You _must_ install Microsoft Core Fonts on Linux OSes also.

Expand Down Expand Up @@ -172,13 +177,13 @@ AsciidocFX supports ditaa diagrams.

http://ditaa.sourceforge.net/[ditaa] is a component that converts diagrams drawn in ascii art to bitmap graphics.

[source,java]
[source,asciidoc]
----
.ditaa Diagram Example
[ditaa,file="ditaa-example.png"]
[ditaa,file="images/ditaa-example.png"]
--
+--------+ +-------+ +-------+
| | --+ ditaa +--> | |
| |---+ ditaa +--->| |
| Text | +-------+ |diagram|
|Document| |!magic!| | |
| {d}| | | | |
Expand All @@ -188,7 +193,7 @@ http://ditaa.sourceforge.net/[ditaa] is a component that converts diagrams drawn
+-------------------------+
--
----
.ditaa example output

image::images/ditaa-example.png[]

== MathJax Extension
Expand Down Expand Up @@ -438,6 +443,27 @@ AspectJ Ebook::
* https://github.com/ozlerhakan/aspectj-ebook[Github]
* http://kodcu.com/aspectj-ebook/[ePub + Kindle + PDF]

== 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 menu:New[Slide] menu.

.menu:New[Slide]
image::images/new-slide.png[]

After that AFX will prompt you a freespace directory name and *"OK"* you will see the slide demo.

.Slide demo
image::images/slide-demo.png[]

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`.

[source,asciidoc]
----
\include::_settings_reveal.adoc[]
// include::_settings_deck.adoc[]
----

== Used Technologies

AsciidocFX uses Java, JavaScript and XML related technologies.
Expand All @@ -453,9 +479,7 @@ AsciidocFX uses Java, JavaScript and XML related technologies.

== AsciidocFX Configuration

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.
You can configurate AsciidocFX with Settings page (Press kbd:[F4]). The all configs located in [Install_Dir]/conf folder.

== Some Shortcuts

Expand Down Expand Up @@ -498,6 +522,8 @@ AFX supports this ace shortcuts https://github.com/ajaxorg/ace/wiki/Default-Keyb

== Known Issues

PDF output shows all text as \####::
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>>
Mac QWERTY Keyboard Bug::
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.
Expand Down
Binary file modified images/asciidocfx.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/ditaa-example.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/new-slide.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added images/slide-demo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 77e6134

Please sign in to comment.