This project is the source code and also a repository for the UI bundle that is used by Antora for both Payara Documentation editions to generate the Payara Platform and Cloud Documentation site.
The UI is based on the default Antora UI and Payara Blinky Pattern Library.
The UI has been customized to render and configure some elements based on the edition of the site being generated (whether for Payara Enterprise/Community or Payara Cloud). To this effect the following page attributes are used:
page-site-edition-
The edition that corresponds to the documentation site. One of:
-
enterprise -
community -
cloud
-
This theme now uses Blinky for all HTML and CSS, the JS is a mix of Blinky for component interaction and the original Antora theme JS for generating menu states, jumping to positions on the page, and generating the TOCs. The original JS as some changes to work with the altered HTML structure. Please note that the icons will not be visible if you view the pages by simply dragging them into a browser window, they must be loaded from a server.
A couple of extra Gulp scripts have been added to copy the Blinky UI files needed that run along with the default theme scripts so you do not need to do anything extra. The new script files are:
-
gulp.d/blinky.js- copies UI files into the public folder -
gulp.d/blinkyJS.js- copies and minifies UI JS files into the public folder
This code is based on the default Antora UI.
Use of this software is granted under the terms of the Mozilla Public License Version 2.0 (MPL-2.0). See LICENSE to find the full license text.