The JavaFX Documentation Project

The JavaFX Documentation Project is designed to collect important JavaFX information from around the web and, with the permission of the authors, to collate it into a single source to form a cohesive book.

This project was initiated by Jonathan Giles, but anyone can contribute. Any questions, concerns, or feedback should be in the first instance be directed to Jonathan via email.

Reading The Documentation

Documentation is available for reading online, and will always reflect the very latest edits. It is currently available in two forms:

• As a single-page website.
• As a single PDF.

Build Process

The documentation is written in AsciiDoc. On every commit to this GitHub repo a build process is run, resulting in newly-built content available in HTML and as a single PDF file. The JavaFX Documentation Project uses GitHub Actions to perform continuous builds of the AsciiDoc source. The current status of the build is:

To build manually:

./gradlew run

This will produce html5 and pdf directories with the appropriate files inside build/docs/.